iot1clickprojects

package module
v0.31.0 Latest Latest
Warning

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

 Go to latest Published: Dec 24, 2020 License: Apache-2.0 Imports: 27 Imported by: 10

Documentation

Overview

Package iot1clickprojects provides the API client, operations, and parameter types for AWS IoT 1-Click Projects Service.

The AWS IoT 1-Click Projects API Reference

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-14"
View Source 
const ServiceID = "IoT 1Click Projects"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

Types

type AssociateDeviceWithPlacementInput 

type AssociateDeviceWithPlacementInput struct {

	// The ID of the physical device to be associated with the given placement in the
	// project. Note that a mandatory 4 character prefix is required for all deviceId
	// values.
	//
	// This member is required.
	DeviceId *string

	// The device template name to associate with the device ID.
	//
	// This member is required.
	DeviceTemplateName *string

	// The name of the placement in which to associate the device.
	//
	// This member is required.
	PlacementName *string

	// The name of the project containing the placement in which to associate the
	// device.
	//
	// This member is required.
	ProjectName *string
}

type AssociateDeviceWithPlacementOutput 

type AssociateDeviceWithPlacementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Client 

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

Client provides the API client to make operations call for AWS IoT 1-Click Projects Service.

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

func (c *Client) AssociateDeviceWithPlacement(ctx context.Context, params *AssociateDeviceWithPlacementInput, optFns ...func(*Options)) (*AssociateDeviceWithPlacementOutput, error)

Associates a physical device with a placement.

func (*Client) CreatePlacement 

func (c *Client) CreatePlacement(ctx context.Context, params *CreatePlacementInput, optFns ...func(*Options)) (*CreatePlacementOutput, error)

Creates an empty placement.

func (*Client) CreateProject 

func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.

func (*Client) DeletePlacement 

func (c *Client) DeletePlacement(ctx context.Context, params *DeletePlacementInput, optFns ...func(*Options)) (*DeletePlacementOutput, error)

Deletes a placement. To delete a placement, it must not have any devices associated with it. When you delete a placement, all associated data becomes irretrievable.

func (*Client) DeleteProject 

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Deletes a project. To delete a project, it must not have any placements associated with it. When you delete a project, all associated data becomes irretrievable.

func (*Client) DescribePlacement 

func (c *Client) DescribePlacement(ctx context.Context, params *DescribePlacementInput, optFns ...func(*Options)) (*DescribePlacementOutput, error)

Describes a placement in a project.

func (*Client) DescribeProject 

func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)

Returns an object describing a project.

func (*Client) DisassociateDeviceFromPlacement 

func (c *Client) DisassociateDeviceFromPlacement(ctx context.Context, params *DisassociateDeviceFromPlacementInput, optFns ...func(*Options)) (*DisassociateDeviceFromPlacementOutput, error)

Removes a physical device from a placement.

func (*Client) GetDevicesInPlacement 

func (c *Client) GetDevicesInPlacement(ctx context.Context, params *GetDevicesInPlacementInput, optFns ...func(*Options)) (*GetDevicesInPlacementOutput, error)

Returns an object enumerating the devices in a placement.

func (*Client) ListPlacements 

func (c *Client) ListPlacements(ctx context.Context, params *ListPlacementsInput, optFns ...func(*Options)) (*ListPlacementsOutput, error)

Lists the placement(s) of a project.

func (*Client) ListProjects 

func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

func (*Client) ListTagsForResource 

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

Lists the tags (metadata key/value pairs) which you have assigned to the resource.

func (*Client) TagResource 

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

Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/).

func (*Client) UntagResource 

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

Removes one or more tags (metadata key/value pairs) from a resource.

func (*Client) UpdatePlacement 

func (c *Client) UpdatePlacement(ctx context.Context, params *UpdatePlacementInput, optFns ...func(*Options)) (*UpdatePlacementOutput, error)

Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").

func (*Client) UpdateProject 

func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").

type CreatePlacementInput 

type CreatePlacementInput struct {

	// The name of the placement to be created.
	//
	// This member is required.
	PlacementName *string

	// The name of the project in which to create the placement.
	//
	// This member is required.
	ProjectName *string

	// Optional user-defined key/value pairs providing contextual data (such as
	// location or function) for the placement.
	Attributes map[string]string
}

type CreatePlacementOutput 

type CreatePlacementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProjectInput 

type CreateProjectInput struct {

	// The name of the project to create.
	//
	// This member is required.
	ProjectName *string

	// An optional description for the project.
	Description *string

	// The schema defining the placement to be created. A placement template defines
	// placement default attributes and device templates. You cannot add or remove
	// device templates after the project has been created. However, you can update
	// callbackOverrides for the device templates using the UpdateProject API.
	PlacementTemplate *types.PlacementTemplate

	// Optional tags (metadata key/value pairs) to be associated with the project. For
	// example, { {"key1": "value1", "key2": "value2"} }. For more information, see AWS
	// Tagging Strategies
	// (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/).
	Tags map[string]string
}

type CreateProjectOutput 

type CreateProjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeletePlacementInput 

type DeletePlacementInput struct {

	// The name of the empty placement to delete.
	//
	// This member is required.
	PlacementName *string

	// The project containing the empty placement to delete.
	//
	// This member is required.
	ProjectName *string
}

type DeletePlacementOutput 

type DeletePlacementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProjectInput 

type DeleteProjectInput struct {

	// The name of the empty project to delete.
	//
	// This member is required.
	ProjectName *string
}

type DeleteProjectOutput 

type DeleteProjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribePlacementInput 

type DescribePlacementInput struct {

	// The name of the placement within a project.
	//
	// This member is required.
	PlacementName *string

	// The project containing the placement to be described.
	//
	// This member is required.
	ProjectName *string
}

type DescribePlacementOutput 

type DescribePlacementOutput struct {

	// An object describing the placement.
	//
	// This member is required.
	Placement *types.PlacementDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeProjectInput 

type DescribeProjectInput struct {

	// The name of the project to be described.
	//
	// This member is required.
	ProjectName *string
}

type DescribeProjectOutput 

type DescribeProjectOutput struct {

	// An object describing the project.
	//
	// This member is required.
	Project *types.ProjectDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateDeviceFromPlacementInput 

type DisassociateDeviceFromPlacementInput struct {

	// The device ID that should be removed from the placement.
	//
	// This member is required.
	DeviceTemplateName *string

	// The name of the placement that the device should be removed from.
	//
	// This member is required.
	PlacementName *string

	// The name of the project that contains the placement.
	//
	// This member is required.
	ProjectName *string
}

type DisassociateDeviceFromPlacementOutput 

type DisassociateDeviceFromPlacementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver 

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

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 GetDevicesInPlacementInput 

type GetDevicesInPlacementInput struct {

	// The name of the placement to get the devices from.
	//
	// This member is required.
	PlacementName *string

	// The name of the project containing the placement.
	//
	// This member is required.
	ProjectName *string
}

type GetDevicesInPlacementOutput 

type GetDevicesInPlacementOutput struct {

	// An object containing the devices (zero or more) within the placement.
	//
	// This member is required.
	Devices map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 ListPlacementsAPIClient added in v0.30.0 

type ListPlacementsAPIClient interface {
	ListPlacements(context.Context, *ListPlacementsInput, ...func(*Options)) (*ListPlacementsOutput, error)
}

ListPlacementsAPIClient is a client that implements the ListPlacements operation.

type ListPlacementsInput 

type ListPlacementsInput struct {

	// The project containing the placements to be listed.
	//
	// This member is required.
	ProjectName *string

	// The maximum number of results to return per request. If not set, a default value
	// of 100 is used.
	MaxResults *int32

	// The token to retrieve the next set of results.
	NextToken *string
}

type ListPlacementsOutput 

type ListPlacementsOutput struct {

	// An object listing the requested placements.
	//
	// This member is required.
	Placements []types.PlacementSummary

	// The token used to retrieve the next set of results - will be effectively empty
	// if there are no further results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListPlacementsPaginator added in v0.30.0 

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

ListPlacementsPaginator is a paginator for ListPlacements

func NewListPlacementsPaginator added in v0.30.0 

func NewListPlacementsPaginator(client ListPlacementsAPIClient, params *ListPlacementsInput, optFns ...func(*ListPlacementsPaginatorOptions)) *ListPlacementsPaginator

NewListPlacementsPaginator returns a new ListPlacementsPaginator

func (*ListPlacementsPaginator) HasMorePages added in v0.30.0 

func (p *ListPlacementsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPlacementsPaginator) NextPage added in v0.30.0 

func (p *ListPlacementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPlacementsOutput, error)

NextPage retrieves the next ListPlacements page.

type ListPlacementsPaginatorOptions added in v0.30.0 

type ListPlacementsPaginatorOptions struct {
	// The maximum number of results to return per request. If not set, a default value
	// of 100 is used.
	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
}

ListPlacementsPaginatorOptions is the paginator options for ListPlacements

type ListProjectsAPIClient added in v0.30.0 

type ListProjectsAPIClient interface {
	ListProjects(context.Context, *ListProjectsInput, ...func(*Options)) (*ListProjectsOutput, error)
}

ListProjectsAPIClient is a client that implements the ListProjects operation.

type ListProjectsInput 

type ListProjectsInput struct {

	// The maximum number of results to return per request. If not set, a default value
	// of 100 is used.
	MaxResults *int32

	// The token to retrieve the next set of results.
	NextToken *string
}

type ListProjectsOutput 

type ListProjectsOutput struct {

	// An object containing the list of projects.
	//
	// This member is required.
	Projects []types.ProjectSummary

	// The token used to retrieve the next set of results - will be effectively empty
	// if there are no further results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListProjectsPaginator added in v0.30.0 

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

ListProjectsPaginator is a paginator for ListProjects

func NewListProjectsPaginator added in v0.30.0 

func NewListProjectsPaginator(client ListProjectsAPIClient, params *ListProjectsInput, optFns ...func(*ListProjectsPaginatorOptions)) *ListProjectsPaginator

NewListProjectsPaginator returns a new ListProjectsPaginator

func (*ListProjectsPaginator) HasMorePages added in v0.30.0 

func (p *ListProjectsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProjectsPaginator) NextPage added in v0.30.0 

func (p *ListProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectsOutput, error)

NextPage retrieves the next ListProjects page.

type ListProjectsPaginatorOptions added in v0.30.0 

type ListProjectsPaginatorOptions struct {
	// The maximum number of results to return per request. If not set, a default value
	// of 100 is used.
	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
}

ListProjectsPaginatorOptions is the paginator options for ListProjects

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource whose tags you want to list.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags (metadata key/value pairs) which you have assigned to the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

	// 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 endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

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

func (Options) Copy 

func (o Options) Copy() Options

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

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 TagResourceInput 

type TagResourceInput struct {

	// The ARN of the resouce for which tag(s) should be added or modified.
	//
	// This member is required.
	ResourceArn *string

	// The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits
	// (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits)
	// for the maximum number of tags allowed per resource.
	//
	// This member is required.
	Tags map[string]string
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN of the resource whose tag you want to remove.
	//
	// This member is required.
	ResourceArn *string

	// The keys of those tags which you want to remove.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdatePlacementInput 

type UpdatePlacementInput struct {

	// The name of the placement to update.
	//
	// This member is required.
	PlacementName *string

	// The name of the project containing the placement to be updated.
	//
	// This member is required.
	ProjectName *string

	// The user-defined object of attributes used to update the placement. The maximum
	// number of key/value pairs is 50.
	Attributes map[string]string
}

type UpdatePlacementOutput 

type UpdatePlacementOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateProjectInput 

type UpdateProjectInput struct {

	// The name of the project to be updated.
	//
	// This member is required.
	ProjectName *string

	// An optional user-defined description for the project.
	Description *string

	// An object defining the project update. Once a project has been created, you
	// cannot add device template names to the project. However, for a given
	// placementTemplate, you can update the associated callbackOverrides for the
	// device definition using this API.
	PlacementTemplate *types.PlacementTemplate
}

type UpdateProjectOutput 

type UpdateProjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.