iotthingsgraph

package module
v1.25.8 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 43 Imported by: 7

Documentation

Overview

Package iotthingsgraph provides the API client, operations, and parameter types for AWS IoT Things Graph.

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.

The AWS IoT Things Graph service is discontinued.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-09-06"
View Source 
const ServiceID = "IoTThingsGraph"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.15.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.18.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.18.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

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
	//
	// This member is required.
	EntityId *string

	// The name of the thing to which the entity is to be associated.
	//
	// This member is required.
	ThingName *string

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64
	// contains filtered or unexported fields
}

type AssociateEntityToThingOutput 

type AssociateEntityToThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.18.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.18.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for AWS IoT Things Graph.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateEntityToThing deprecated 

func (c *Client) AssociateEntityToThing(ctx context.Context, params *AssociateEntityToThingInput, optFns ...func(*Options)) (*AssociateEntityToThingOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) CreateFlowTemplate deprecated 

func (c *Client) CreateFlowTemplate(ctx context.Context, params *CreateFlowTemplateInput, optFns ...func(*Options)) (*CreateFlowTemplateOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) CreateSystemInstance deprecated 

func (c *Client) CreateSystemInstance(ctx context.Context, params *CreateSystemInstanceInput, optFns ...func(*Options)) (*CreateSystemInstanceOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) CreateSystemTemplate deprecated 

func (c *Client) CreateSystemTemplate(ctx context.Context, params *CreateSystemTemplateInput, optFns ...func(*Options)) (*CreateSystemTemplateOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) DeleteFlowTemplate deprecated 

func (c *Client) DeleteFlowTemplate(ctx context.Context, params *DeleteFlowTemplateInput, optFns ...func(*Options)) (*DeleteFlowTemplateOutput, error)

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

Deprecated: since: 2022-08-30

func (*Client) DeleteNamespace deprecated 

func (c *Client) DeleteNamespace(ctx context.Context, params *DeleteNamespaceInput, optFns ...func(*Options)) (*DeleteNamespaceOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) DeleteSystemInstance deprecated 

func (c *Client) DeleteSystemInstance(ctx context.Context, params *DeleteSystemInstanceInput, optFns ...func(*Options)) (*DeleteSystemInstanceOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) DeleteSystemTemplate deprecated 

func (c *Client) DeleteSystemTemplate(ctx context.Context, params *DeleteSystemTemplateInput, optFns ...func(*Options)) (*DeleteSystemTemplateOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) DeploySystemInstance deprecated 

func (c *Client) DeploySystemInstance(ctx context.Context, params *DeploySystemInstanceInput, optFns ...func(*Options)) (*DeploySystemInstanceOutput, error)
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.

Deprecated: since: 2022-08-30

func (*Client) DeprecateFlowTemplate deprecated 

func (c *Client) DeprecateFlowTemplate(ctx context.Context, params *DeprecateFlowTemplateInput, optFns ...func(*Options)) (*DeprecateFlowTemplateOutput, error)

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

Deprecated: since: 2022-08-30

func (*Client) DeprecateSystemTemplate deprecated 

func (c *Client) DeprecateSystemTemplate(ctx context.Context, params *DeprecateSystemTemplateInput, optFns ...func(*Options)) (*DeprecateSystemTemplateOutput, error)

Deprecates the specified system.

Deprecated: since: 2022-08-30

func (*Client) DescribeNamespace deprecated 

func (c *Client) DescribeNamespace(ctx context.Context, params *DescribeNamespaceInput, optFns ...func(*Options)) (*DescribeNamespaceOutput, error)

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

Deprecated: since: 2022-08-30

func (*Client) DissociateEntityFromThing deprecated 

func (c *Client) DissociateEntityFromThing(ctx context.Context, params *DissociateEntityFromThingInput, optFns ...func(*Options)) (*DissociateEntityFromThingOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) GetEntities deprecated 

func (c *Client) GetEntities(ctx context.Context, params *GetEntitiesInput, optFns ...func(*Options)) (*GetEntitiesOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) GetFlowTemplate deprecated 

func (c *Client) GetFlowTemplate(ctx context.Context, params *GetFlowTemplateInput, optFns ...func(*Options)) (*GetFlowTemplateOutput, error)

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

Deprecated: since: 2022-08-30

func (*Client) GetFlowTemplateRevisions deprecated 

func (c *Client) GetFlowTemplateRevisions(ctx context.Context, params *GetFlowTemplateRevisionsInput, optFns ...func(*Options)) (*GetFlowTemplateRevisionsOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) GetNamespaceDeletionStatus deprecated 

func (c *Client) GetNamespaceDeletionStatus(ctx context.Context, params *GetNamespaceDeletionStatusInput, optFns ...func(*Options)) (*GetNamespaceDeletionStatusOutput, error)

Gets the status of a namespace deletion task.

Deprecated: since: 2022-08-30

func (*Client) GetSystemInstance deprecated 

func (c *Client) GetSystemInstance(ctx context.Context, params *GetSystemInstanceInput, optFns ...func(*Options)) (*GetSystemInstanceOutput, error)

Gets a system instance.

Deprecated: since: 2022-08-30

func (*Client) GetSystemTemplate deprecated 

func (c *Client) GetSystemTemplate(ctx context.Context, params *GetSystemTemplateInput, optFns ...func(*Options)) (*GetSystemTemplateOutput, error)

Gets a system.

Deprecated: since: 2022-08-30

func (*Client) GetSystemTemplateRevisions deprecated 

func (c *Client) GetSystemTemplateRevisions(ctx context.Context, params *GetSystemTemplateRevisionsInput, optFns ...func(*Options)) (*GetSystemTemplateRevisionsOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) GetUploadStatus deprecated 

func (c *Client) GetUploadStatus(ctx context.Context, params *GetUploadStatusInput, optFns ...func(*Options)) (*GetUploadStatusOutput, error)

Gets the status of the specified upload.

Deprecated: since: 2022-08-30

func (*Client) ListFlowExecutionMessages deprecated 

func (c *Client) ListFlowExecutionMessages(ctx context.Context, params *ListFlowExecutionMessagesInput, optFns ...func(*Options)) (*ListFlowExecutionMessagesOutput, error)

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

Deprecated: since: 2022-08-30

func (*Client) ListTagsForResource deprecated 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists all tags on an AWS IoT Things Graph resource.

Deprecated: since: 2022-08-30

func (*Client) Options added in v1.19.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) SearchEntities deprecated 

func (c *Client) SearchEntities(ctx context.Context, params *SearchEntitiesInput, optFns ...func(*Options)) (*SearchEntitiesOutput, error)

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

Deprecated: since: 2022-08-30

func (*Client) SearchFlowExecutions deprecated 

func (c *Client) SearchFlowExecutions(ctx context.Context, params *SearchFlowExecutionsInput, optFns ...func(*Options)) (*SearchFlowExecutionsOutput, error)

Searches for AWS IoT Things Graph workflow execution instances.

Deprecated: since: 2022-08-30

func (*Client) SearchFlowTemplates deprecated 

func (c *Client) SearchFlowTemplates(ctx context.Context, params *SearchFlowTemplatesInput, optFns ...func(*Options)) (*SearchFlowTemplatesOutput, error)

Searches for summary information about workflows.

Deprecated: since: 2022-08-30

func (*Client) SearchSystemInstances deprecated 

func (c *Client) SearchSystemInstances(ctx context.Context, params *SearchSystemInstancesInput, optFns ...func(*Options)) (*SearchSystemInstancesOutput, error)

Searches for system instances in the user's account.

Deprecated: since: 2022-08-30

func (*Client) SearchSystemTemplates deprecated 

func (c *Client) SearchSystemTemplates(ctx context.Context, params *SearchSystemTemplatesInput, optFns ...func(*Options)) (*SearchSystemTemplatesOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) SearchThings deprecated 

func (c *Client) SearchThings(ctx context.Context, params *SearchThingsInput, optFns ...func(*Options)) (*SearchThingsOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) TagResource deprecated 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Creates a tag for the specified resource.

Deprecated: since: 2022-08-30

func (*Client) UndeploySystemInstance deprecated 

func (c *Client) UndeploySystemInstance(ctx context.Context, params *UndeploySystemInstanceInput, optFns ...func(*Options)) (*UndeploySystemInstanceOutput, error)

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

Deprecated: since: 2022-08-30

func (*Client) UntagResource deprecated 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes a tag from the specified resource.

Deprecated: since: 2022-08-30

func (*Client) UpdateFlowTemplate deprecated 

func (c *Client) UpdateFlowTemplate(ctx context.Context, params *UpdateFlowTemplateInput, optFns ...func(*Options)) (*UpdateFlowTemplateOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) UpdateSystemTemplate deprecated 

func (c *Client) UpdateSystemTemplate(ctx context.Context, params *UpdateSystemTemplateInput, optFns ...func(*Options)) (*UpdateSystemTemplateOutput, error)

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.

Deprecated: since: 2022-08-30

func (*Client) UploadEntityDefinitions deprecated 

func (c *Client) UploadEntityDefinitions(ctx context.Context, params *UploadEntityDefinitionsInput, optFns ...func(*Options)) (*UploadEntityDefinitionsOutput, error)

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 .

Deprecated: since: 2022-08-30

type CreateFlowTemplateInput 

type CreateFlowTemplateInput struct {

	// The workflow DefinitionDocument .
	//
	// This member is required.
	Definition *types.DefinitionDocument

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

type CreateFlowTemplateOutput 

type CreateFlowTemplateOutput struct {

	// The summary object that describes the created workflow.
	Summary *types.FlowTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSystemInstanceInput 

type CreateSystemInstanceInput struct {

	// A document that defines an entity.
	//
	// This member is required.
	Definition *types.DefinitionDocument

	// The target type of the deployment. Valid values are GREENGRASS and CLOUD .
	//
	// This member is required.
	Target types.DeploymentTarget

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

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

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

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

	// Metadata, consisting of key-value pairs, that can be used to categorize your
	// system instances.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateSystemInstanceOutput 

type CreateSystemInstanceOutput struct {

	// The summary object that describes the new system instance.
	Summary *types.SystemInstanceSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateSystemTemplateInput 

type CreateSystemTemplateInput struct {

	// The DefinitionDocument used to create the system.
	//
	// This member is required.
	Definition *types.DefinitionDocument

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

type CreateSystemTemplateOutput 

type CreateSystemTemplateOutput struct {

	// The summary object that describes the created system.
	Summary *types.SystemTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteFlowTemplateOutput 

type DeleteFlowTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteNamespaceInput 

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

type DeleteNamespaceOutput 

type DeleteNamespaceOutput struct {

	// The ARN of the namespace to be deleted.
	NamespaceArn *string

	// The name of the namespace to be deleted.
	NamespaceName *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteSystemInstanceInput 

type DeleteSystemInstanceInput struct {

	// The ID of the system instance to be deleted.
	Id *string
	// contains filtered or unexported fields
}

type DeleteSystemInstanceOutput 

type DeleteSystemInstanceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeleteSystemTemplateOutput 

type DeleteSystemTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeploySystemInstanceOutput 

type DeploySystemInstanceOutput struct {

	// An object that contains summary information about a system instance that was
	// deployed.
	//
	// This member is required.
	Summary *types.SystemInstanceSummary

	// The ID of the Greengrass deployment used to deploy the system instance.
	GreengrassDeploymentId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeprecateFlowTemplateOutput 

type DeprecateFlowTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type DeprecateSystemTemplateOutput 

type DeprecateSystemTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeNamespaceInput 

type DescribeNamespaceInput struct {

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

type DescribeNamespaceOutput 

type DescribeNamespaceOutput struct {

	// The ARN of the namespace.
	NamespaceArn *string

	// The name of the namespace.
	NamespaceName *string

	// The version of the user's namespace to describe.
	NamespaceVersion *int64

	// The name of the public namespace that the latest namespace version is tracking.
	TrackingNamespaceName *string

	// The version of the public namespace that the latest version is tracking.
	TrackingNamespaceVersion *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DissociateEntityFromThingInput 

type DissociateEntityFromThingInput struct {

	// The entity type from which to disassociate the thing.
	//
	// This member is required.
	EntityType types.EntityType

	// The name of the thing to disassociate.
	//
	// This member is required.
	ThingName *string
	// contains filtered or unexported fields
}

type DissociateEntityFromThingOutput 

type DissociateEntityFromThingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.15.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.15.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.15.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.15.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.15.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

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
	//
	// This member is required.
	Ids []string

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64
	// contains filtered or unexported fields
}

type GetEntitiesOutput 

type GetEntitiesOutput struct {

	// An array of descriptions for the specified entities.
	Descriptions []types.EntityDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	//
	// This member is required.
	Id *string

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

type GetFlowTemplateOutput 

type GetFlowTemplateOutput struct {

	// The object that describes the specified workflow.
	Description *types.FlowTemplateDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFlowTemplateRevisionsAPIClient added in v0.30.0 

type GetFlowTemplateRevisionsAPIClient interface {
	GetFlowTemplateRevisions(context.Context, *GetFlowTemplateRevisionsInput, ...func(*Options)) (*GetFlowTemplateRevisionsOutput, error)
}

GetFlowTemplateRevisionsAPIClient is a client that implements the GetFlowTemplateRevisions operation.

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
	//
	// This member is required.
	Id *string

	// The maximum number of results to return in the response.
	MaxResults *int32

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

type GetFlowTemplateRevisionsOutput 

type GetFlowTemplateRevisionsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// An array of objects that provide summary data about each revision.
	Summaries []types.FlowTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetFlowTemplateRevisionsPaginator added in v0.30.0 

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

GetFlowTemplateRevisionsPaginator is a paginator for GetFlowTemplateRevisions

func NewGetFlowTemplateRevisionsPaginator added in v0.30.0 

func NewGetFlowTemplateRevisionsPaginator(client GetFlowTemplateRevisionsAPIClient, params *GetFlowTemplateRevisionsInput, optFns ...func(*GetFlowTemplateRevisionsPaginatorOptions)) *GetFlowTemplateRevisionsPaginator

NewGetFlowTemplateRevisionsPaginator returns a new GetFlowTemplateRevisionsPaginator

func (*GetFlowTemplateRevisionsPaginator) HasMorePages added in v0.30.0 

func (p *GetFlowTemplateRevisionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetFlowTemplateRevisionsPaginator) NextPage added in v0.30.0 

func (p *GetFlowTemplateRevisionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetFlowTemplateRevisionsOutput, error)

NextPage retrieves the next GetFlowTemplateRevisions page.

type GetFlowTemplateRevisionsPaginatorOptions added in v0.30.0 

type GetFlowTemplateRevisionsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetFlowTemplateRevisionsPaginatorOptions is the paginator options for GetFlowTemplateRevisions

type GetNamespaceDeletionStatusInput 

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

type GetNamespaceDeletionStatusOutput 

type GetNamespaceDeletionStatusOutput struct {

	// An error code returned by the namespace deletion task.
	ErrorCode types.NamespaceDeletionStatusErrorCodes

	// An error code returned by the namespace deletion task.
	ErrorMessage *string

	// The ARN of the namespace that is being deleted.
	NamespaceArn *string

	// The name of the namespace that is being deleted.
	NamespaceName *string

	// The status of the deletion request.
	Status types.NamespaceDeletionStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	//
	// This member is required.
	Id *string
	// contains filtered or unexported fields
}

type GetSystemInstanceOutput 

type GetSystemInstanceOutput struct {

	// An object that describes the system instance.
	Description *types.SystemInstanceDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
	//
	// This member is required.
	Id *string

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

type GetSystemTemplateOutput 

type GetSystemTemplateOutput struct {

	// An object that contains summary data about the system.
	Description *types.SystemTemplateDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSystemTemplateRevisionsAPIClient added in v0.30.0 

type GetSystemTemplateRevisionsAPIClient interface {
	GetSystemTemplateRevisions(context.Context, *GetSystemTemplateRevisionsInput, ...func(*Options)) (*GetSystemTemplateRevisionsOutput, error)
}

GetSystemTemplateRevisionsAPIClient is a client that implements the GetSystemTemplateRevisions operation.

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
	//
	// This member is required.
	Id *string

	// The maximum number of results to return in the response.
	MaxResults *int32

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

type GetSystemTemplateRevisionsOutput 

type GetSystemTemplateRevisionsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// An array of objects that contain summary data about the system template
	// revisions.
	Summaries []types.SystemTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSystemTemplateRevisionsPaginator added in v0.30.0 

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

GetSystemTemplateRevisionsPaginator is a paginator for GetSystemTemplateRevisions

func NewGetSystemTemplateRevisionsPaginator added in v0.30.0 

func NewGetSystemTemplateRevisionsPaginator(client GetSystemTemplateRevisionsAPIClient, params *GetSystemTemplateRevisionsInput, optFns ...func(*GetSystemTemplateRevisionsPaginatorOptions)) *GetSystemTemplateRevisionsPaginator

NewGetSystemTemplateRevisionsPaginator returns a new GetSystemTemplateRevisionsPaginator

func (*GetSystemTemplateRevisionsPaginator) HasMorePages added in v0.30.0 

func (p *GetSystemTemplateRevisionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetSystemTemplateRevisionsPaginator) NextPage added in v0.30.0 

func (p *GetSystemTemplateRevisionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetSystemTemplateRevisionsOutput, error)

NextPage retrieves the next GetSystemTemplateRevisions page.

type GetSystemTemplateRevisionsPaginatorOptions added in v0.30.0 

type GetSystemTemplateRevisionsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetSystemTemplateRevisionsPaginatorOptions is the paginator options for GetSystemTemplateRevisions

type GetUploadStatusInput 

type GetUploadStatusInput struct {

	// The ID of the upload. This value is returned by the UploadEntityDefinitions
	// action.
	//
	// This member is required.
	UploadId *string
	// contains filtered or unexported fields
}

type GetUploadStatusOutput 

type GetUploadStatusOutput struct {

	// The date at which the upload was created.
	//
	// This member is required.
	CreatedDate *time.Time

	// The ID of the upload.
	//
	// This member is required.
	UploadId *string

	// The status of the upload. The initial status is IN_PROGRESS . The response show
	// all validation failures if the upload fails.
	//
	// This member is required.
	UploadStatus types.UploadStatus

	// The reason for an upload failure.
	FailureReason []string

	// The ARN of the upload.
	NamespaceArn *string

	// The name of the upload's namespace.
	NamespaceName *string

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListFlowExecutionMessagesAPIClient added in v0.30.0 

type ListFlowExecutionMessagesAPIClient interface {
	ListFlowExecutionMessages(context.Context, *ListFlowExecutionMessagesInput, ...func(*Options)) (*ListFlowExecutionMessagesOutput, error)
}

ListFlowExecutionMessagesAPIClient is a client that implements the ListFlowExecutionMessages operation.

type ListFlowExecutionMessagesInput 

type ListFlowExecutionMessagesInput struct {

	// The ID of the flow execution.
	//
	// This member is required.
	FlowExecutionId *string

	// The maximum number of results to return in the response.
	MaxResults *int32

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

type ListFlowExecutionMessagesOutput 

type ListFlowExecutionMessagesOutput struct {

	// A list of objects that contain information about events in the specified flow
	// execution.
	Messages []types.FlowExecutionMessage

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListFlowExecutionMessagesPaginator added in v0.30.0 

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

ListFlowExecutionMessagesPaginator is a paginator for ListFlowExecutionMessages

func NewListFlowExecutionMessagesPaginator added in v0.30.0 

func NewListFlowExecutionMessagesPaginator(client ListFlowExecutionMessagesAPIClient, params *ListFlowExecutionMessagesInput, optFns ...func(*ListFlowExecutionMessagesPaginatorOptions)) *ListFlowExecutionMessagesPaginator

NewListFlowExecutionMessagesPaginator returns a new ListFlowExecutionMessagesPaginator

func (*ListFlowExecutionMessagesPaginator) HasMorePages added in v0.30.0 

func (p *ListFlowExecutionMessagesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFlowExecutionMessagesPaginator) NextPage added in v0.30.0 

func (p *ListFlowExecutionMessagesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFlowExecutionMessagesOutput, error)

NextPage retrieves the next ListFlowExecutionMessages page.

type ListFlowExecutionMessagesPaginatorOptions added in v0.30.0 

type ListFlowExecutionMessagesPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFlowExecutionMessagesPaginatorOptions is the paginator options for ListFlowExecutionMessages

type ListTagsForResourceAPIClient added in v0.30.0 

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags are to be returned.
	//
	// This member is required.
	ResourceArn *string

	// The maximum number of tags to return.
	MaxResults *int32

	// The token that specifies the next page of results to return.
	NextToken *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The token that specifies the next page of results to return.
	NextToken *string

	// List of tags returned by the ListTagsForResource operation.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTagsForResourcePaginator added in v0.30.0 

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v0.30.0 

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v0.30.0 

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v0.30.0 

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v0.30.0 

type ListTagsForResourcePaginatorOptions struct {
	// The maximum number of tags to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.18.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type SearchEntitiesAPIClient added in v0.30.0 

type SearchEntitiesAPIClient interface {
	SearchEntities(context.Context, *SearchEntitiesInput, ...func(*Options)) (*SearchEntitiesOutput, error)
}

SearchEntitiesAPIClient is a client that implements the SearchEntities operation.

type SearchEntitiesInput 

type SearchEntitiesInput struct {

	// The entity types for which to search.
	//
	// This member is required.
	EntityTypes []types.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 []types.EntityFilter

	// The maximum number of results to return in the response.
	MaxResults *int32

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64

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

type SearchEntitiesOutput 

type SearchEntitiesOutput struct {

	// An array of descriptions for each entity returned in the search result.
	Descriptions []types.EntityDescription

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchEntitiesPaginator added in v0.30.0 

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

SearchEntitiesPaginator is a paginator for SearchEntities

func NewSearchEntitiesPaginator added in v0.30.0 

func NewSearchEntitiesPaginator(client SearchEntitiesAPIClient, params *SearchEntitiesInput, optFns ...func(*SearchEntitiesPaginatorOptions)) *SearchEntitiesPaginator

NewSearchEntitiesPaginator returns a new SearchEntitiesPaginator

func (*SearchEntitiesPaginator) HasMorePages added in v0.30.0 

func (p *SearchEntitiesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchEntitiesPaginator) NextPage added in v0.30.0 

func (p *SearchEntitiesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchEntitiesOutput, error)

NextPage retrieves the next SearchEntities page.

type SearchEntitiesPaginatorOptions added in v0.30.0 

type SearchEntitiesPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchEntitiesPaginatorOptions is the paginator options for SearchEntities

type SearchFlowExecutionsAPIClient added in v0.30.0 

type SearchFlowExecutionsAPIClient interface {
	SearchFlowExecutions(context.Context, *SearchFlowExecutionsInput, ...func(*Options)) (*SearchFlowExecutionsOutput, error)
}

SearchFlowExecutionsAPIClient is a client that implements the SearchFlowExecutions operation.

type SearchFlowExecutionsInput 

type SearchFlowExecutionsInput struct {

	// The ID of the system instance that contains the flow.
	//
	// This member is required.
	SystemInstanceId *string

	// The date and time of the latest flow execution to return.
	EndTime *time.Time

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

	// The maximum number of results to return in the response.
	MaxResults *int32

	// The string that specifies the next page of results. Use this when you're
	// paginating results.
	NextToken *string

	// The date and time of the earliest flow execution to return.
	StartTime *time.Time
	// contains filtered or unexported fields
}

type SearchFlowExecutionsOutput 

type SearchFlowExecutionsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// An array of objects that contain summary information about each workflow
	// execution in the result set.
	Summaries []types.FlowExecutionSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchFlowExecutionsPaginator added in v0.30.0 

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

SearchFlowExecutionsPaginator is a paginator for SearchFlowExecutions

func NewSearchFlowExecutionsPaginator added in v0.30.0 

func NewSearchFlowExecutionsPaginator(client SearchFlowExecutionsAPIClient, params *SearchFlowExecutionsInput, optFns ...func(*SearchFlowExecutionsPaginatorOptions)) *SearchFlowExecutionsPaginator

NewSearchFlowExecutionsPaginator returns a new SearchFlowExecutionsPaginator

func (*SearchFlowExecutionsPaginator) HasMorePages added in v0.30.0 

func (p *SearchFlowExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchFlowExecutionsPaginator) NextPage added in v0.30.0 

func (p *SearchFlowExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchFlowExecutionsOutput, error)

NextPage retrieves the next SearchFlowExecutions page.

type SearchFlowExecutionsPaginatorOptions added in v0.30.0 

type SearchFlowExecutionsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchFlowExecutionsPaginatorOptions is the paginator options for SearchFlowExecutions

type SearchFlowTemplatesAPIClient added in v0.30.0 

type SearchFlowTemplatesAPIClient interface {
	SearchFlowTemplates(context.Context, *SearchFlowTemplatesInput, ...func(*Options)) (*SearchFlowTemplatesOutput, error)
}

SearchFlowTemplatesAPIClient is a client that implements the SearchFlowTemplates operation.

type SearchFlowTemplatesInput 

type SearchFlowTemplatesInput struct {

	// An array of objects that limit the result set. The only valid filter is
	// DEVICE_MODEL_ID .
	Filters []types.FlowTemplateFilter

	// The maximum number of results to return in the response.
	MaxResults *int32

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

type SearchFlowTemplatesOutput 

type SearchFlowTemplatesOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// An array of objects that contain summary information about each workflow in the
	// result set.
	Summaries []types.FlowTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchFlowTemplatesPaginator added in v0.30.0 

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

SearchFlowTemplatesPaginator is a paginator for SearchFlowTemplates

func NewSearchFlowTemplatesPaginator added in v0.30.0 

func NewSearchFlowTemplatesPaginator(client SearchFlowTemplatesAPIClient, params *SearchFlowTemplatesInput, optFns ...func(*SearchFlowTemplatesPaginatorOptions)) *SearchFlowTemplatesPaginator

NewSearchFlowTemplatesPaginator returns a new SearchFlowTemplatesPaginator

func (*SearchFlowTemplatesPaginator) HasMorePages added in v0.30.0 

func (p *SearchFlowTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchFlowTemplatesPaginator) NextPage added in v0.30.0 

func (p *SearchFlowTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchFlowTemplatesOutput, error)

NextPage retrieves the next SearchFlowTemplates page.

type SearchFlowTemplatesPaginatorOptions added in v0.30.0 

type SearchFlowTemplatesPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchFlowTemplatesPaginatorOptions is the paginator options for SearchFlowTemplates

type SearchSystemInstancesAPIClient added in v0.30.0 

type SearchSystemInstancesAPIClient interface {
	SearchSystemInstances(context.Context, *SearchSystemInstancesInput, ...func(*Options)) (*SearchSystemInstancesOutput, error)
}

SearchSystemInstancesAPIClient is a client that implements the SearchSystemInstances operation.

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 []types.SystemInstanceFilter

	// The maximum number of results to return in the response.
	MaxResults *int32

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

type SearchSystemInstancesOutput 

type SearchSystemInstancesOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// An array of objects that contain summary data abour the system instances in the
	// result set.
	Summaries []types.SystemInstanceSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchSystemInstancesPaginator added in v0.30.0 

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

SearchSystemInstancesPaginator is a paginator for SearchSystemInstances

func NewSearchSystemInstancesPaginator added in v0.30.0 

func NewSearchSystemInstancesPaginator(client SearchSystemInstancesAPIClient, params *SearchSystemInstancesInput, optFns ...func(*SearchSystemInstancesPaginatorOptions)) *SearchSystemInstancesPaginator

NewSearchSystemInstancesPaginator returns a new SearchSystemInstancesPaginator

func (*SearchSystemInstancesPaginator) HasMorePages added in v0.30.0 

func (p *SearchSystemInstancesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchSystemInstancesPaginator) NextPage added in v0.30.0 

func (p *SearchSystemInstancesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchSystemInstancesOutput, error)

NextPage retrieves the next SearchSystemInstances page.

type SearchSystemInstancesPaginatorOptions added in v0.30.0 

type SearchSystemInstancesPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchSystemInstancesPaginatorOptions is the paginator options for SearchSystemInstances

type SearchSystemTemplatesAPIClient added in v0.30.0 

type SearchSystemTemplatesAPIClient interface {
	SearchSystemTemplates(context.Context, *SearchSystemTemplatesInput, ...func(*Options)) (*SearchSystemTemplatesOutput, error)
}

SearchSystemTemplatesAPIClient is a client that implements the SearchSystemTemplates operation.

type SearchSystemTemplatesInput 

type SearchSystemTemplatesInput struct {

	// An array of filters that limit the result set. The only valid filter is
	// FLOW_TEMPLATE_ID .
	Filters []types.SystemTemplateFilter

	// The maximum number of results to return in the response.
	MaxResults *int32

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

type SearchSystemTemplatesOutput 

type SearchSystemTemplatesOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// An array of objects that contain summary information about each system
	// deployment in the result set.
	Summaries []types.SystemTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchSystemTemplatesPaginator added in v0.30.0 

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

SearchSystemTemplatesPaginator is a paginator for SearchSystemTemplates

func NewSearchSystemTemplatesPaginator added in v0.30.0 

func NewSearchSystemTemplatesPaginator(client SearchSystemTemplatesAPIClient, params *SearchSystemTemplatesInput, optFns ...func(*SearchSystemTemplatesPaginatorOptions)) *SearchSystemTemplatesPaginator

NewSearchSystemTemplatesPaginator returns a new SearchSystemTemplatesPaginator

func (*SearchSystemTemplatesPaginator) HasMorePages added in v0.30.0 

func (p *SearchSystemTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchSystemTemplatesPaginator) NextPage added in v0.30.0 

func (p *SearchSystemTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchSystemTemplatesOutput, error)

NextPage retrieves the next SearchSystemTemplates page.

type SearchSystemTemplatesPaginatorOptions added in v0.30.0 

type SearchSystemTemplatesPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchSystemTemplatesPaginatorOptions is the paginator options for SearchSystemTemplates

type SearchThingsAPIClient added in v0.30.0 

type SearchThingsAPIClient interface {
	SearchThings(context.Context, *SearchThingsInput, ...func(*Options)) (*SearchThingsOutput, error)
}

SearchThingsAPIClient is a client that implements the SearchThings operation.

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
	//
	// This member is required.
	EntityId *string

	// The maximum number of results to return in the response.
	MaxResults *int32

	// The version of the user's namespace. Defaults to the latest version of the
	// user's namespace.
	NamespaceVersion *int64

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

type SearchThingsOutput 

type SearchThingsOutput struct {

	// The string to specify as nextToken when you request the next page of results.
	NextToken *string

	// An array of things in the result set.
	Things []types.Thing

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type SearchThingsPaginator added in v0.30.0 

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

SearchThingsPaginator is a paginator for SearchThings

func NewSearchThingsPaginator added in v0.30.0 

func NewSearchThingsPaginator(client SearchThingsAPIClient, params *SearchThingsInput, optFns ...func(*SearchThingsPaginatorOptions)) *SearchThingsPaginator

NewSearchThingsPaginator returns a new SearchThingsPaginator

func (*SearchThingsPaginator) HasMorePages added in v0.30.0 

func (p *SearchThingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*SearchThingsPaginator) NextPage added in v0.30.0 

func (p *SearchThingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchThingsOutput, error)

NextPage retrieves the next SearchThings page.

type SearchThingsPaginatorOptions added in v0.30.0 

type SearchThingsPaginatorOptions struct {
	// The maximum number of results to return in the response.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

SearchThingsPaginatorOptions is the paginator options for SearchThings

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags are returned.
	//
	// This member is required.
	ResourceArn *string

	// A list of tags to add to the resource.>
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UndeploySystemInstanceInput 

type UndeploySystemInstanceInput struct {

	// The ID of the system instance to remove from its target.
	Id *string
	// contains filtered or unexported fields
}

type UndeploySystemInstanceOutput 

type UndeploySystemInstanceOutput struct {

	// An object that contains summary information about the system instance that was
	// removed from its target.
	Summary *types.SystemInstanceSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags are to be removed.
	//
	// This member is required.
	ResourceArn *string

	// 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]in the AWS CLI User Guide.
	//
	// [Using JSON for Parameters]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateFlowTemplateInput 

type UpdateFlowTemplateInput struct {

	// The DefinitionDocument that contains the updated workflow definition.
	//
	// This member is required.
	Definition *types.DefinitionDocument

	// The ID of the workflow to be updated.
	//
	// The ID should be in the following format.
	//
	//     urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
	//
	// This member is required.
	Id *string

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

type UpdateFlowTemplateOutput 

type UpdateFlowTemplateOutput struct {

	// An object containing summary information about the updated workflow.
	Summary *types.FlowTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateSystemTemplateInput 

type UpdateSystemTemplateInput struct {

	// The DefinitionDocument that contains the updated system definition.
	//
	// This member is required.
	Definition *types.DefinitionDocument

	// The ID of the system to be updated.
	//
	// The ID should be in the following format.
	//
	//     urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
	//
	// This member is required.
	Id *string

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

type UpdateSystemTemplateOutput 

type UpdateSystemTemplateOutput struct {

	// An object containing summary information about the updated system.
	Summary *types.SystemTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// The DefinitionDocument that defines the updated entities.
	Document *types.DefinitionDocument

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

type UploadEntityDefinitionsOutput 

type UploadEntityDefinitionsOutput struct {

	// The ID that specifies the upload action. You can use this to track the status
	// of the upload.
	//
	// This member is required.
	UploadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.