Documentation

Overview

    Package iotfleethub provides the API client, operations, and parameter types for AWS IoT Fleet Hub.

    With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2020-11-03"
    View Source
    const ServiceID = "IoTFleetHub"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

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

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

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

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

            Client provides the API client to make operations call for AWS IoT Fleet Hub.

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

                func (c *Client) CreateApplication(ctx context.Context, params *CreateApplicationInput, optFns ...func(*Options)) (*CreateApplicationOutput, error)

                  Creates a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                  func (*Client) DeleteApplication

                  func (c *Client) DeleteApplication(ctx context.Context, params *DeleteApplicationInput, optFns ...func(*Options)) (*DeleteApplicationOutput, error)

                    Deletes a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                    func (*Client) DescribeApplication

                    func (c *Client) DescribeApplication(ctx context.Context, params *DescribeApplicationInput, optFns ...func(*Options)) (*DescribeApplicationOutput, error)

                      Gets information about a Fleet Hub for AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                      func (*Client) ListApplications

                      func (c *Client) ListApplications(ctx context.Context, params *ListApplicationsInput, optFns ...func(*Options)) (*ListApplicationsOutput, error)

                        Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                        func (*Client) ListTagsForResource

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

                          Lists the tags for the specified resource. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                          func (*Client) TagResource

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

                            Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                            func (*Client) UntagResource

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

                              Removes the specified tags (metadata) from the resource. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                              func (*Client) UpdateApplication

                              func (c *Client) UpdateApplication(ctx context.Context, params *UpdateApplicationInput, optFns ...func(*Options)) (*UpdateApplicationOutput, error)

                                Updates information about a Fleet Hub for a AWS IoT Device Management web application. Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

                                type CreateApplicationInput

                                type CreateApplicationInput struct {
                                
                                	// The name of the web application.
                                	//
                                	// This member is required.
                                	ApplicationName *string
                                
                                	// The ARN of the role that the web application assumes when it interacts with AWS
                                	// IoT Core. The name of the role must be in the form AWSIotFleetHub_random_string
                                	// .
                                	//
                                	// This member is required.
                                	RoleArn *string
                                
                                	// An optional description of the web application.
                                	ApplicationDescription *string
                                
                                	// A unique case-sensitive identifier that you can provide to ensure the
                                	// idempotency of the request. Don't reuse this client token if a new idempotent
                                	// request is required.
                                	ClientToken *string
                                
                                	// A set of key/value pairs that you can use to manage the web application
                                	// resource.
                                	Tags map[string]string
                                }

                                type CreateApplicationOutput

                                type CreateApplicationOutput struct {
                                
                                	// The ARN of the web application.
                                	//
                                	// This member is required.
                                	ApplicationArn *string
                                
                                	// The unique Id of the web application.
                                	//
                                	// This member is required.
                                	ApplicationId *string
                                
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type DeleteApplicationInput

                                type DeleteApplicationInput struct {
                                
                                	// The unique Id of the web application.
                                	//
                                	// This member is required.
                                	ApplicationId *string
                                
                                	// A unique case-sensitive identifier that you can provide to ensure the
                                	// idempotency of the request. Don't reuse this client token if a new idempotent
                                	// request is required.
                                	ClientToken *string
                                }

                                type DeleteApplicationOutput

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

                                type DescribeApplicationInput

                                type DescribeApplicationInput struct {
                                
                                	// The unique Id of the web application.
                                	//
                                	// This member is required.
                                	ApplicationId *string
                                }

                                type DescribeApplicationOutput

                                type DescribeApplicationOutput struct {
                                
                                	// The ARN of the web application.
                                	//
                                	// This member is required.
                                	ApplicationArn *string
                                
                                	// The date (in Unix epoch time) when the application was created.
                                	//
                                	// This member is required.
                                	ApplicationCreationDate int64
                                
                                	// The unique Id of the web application.
                                	//
                                	// This member is required.
                                	ApplicationId *string
                                
                                	// The date (in Unix epoch time) when the application was last updated.
                                	//
                                	// This member is required.
                                	ApplicationLastUpdateDate int64
                                
                                	// The name of the web application.
                                	//
                                	// This member is required.
                                	ApplicationName *string
                                
                                	// The current state of the web application.
                                	//
                                	// This member is required.
                                	ApplicationState types.ApplicationState
                                
                                	// The URL of the web application.
                                	//
                                	// This member is required.
                                	ApplicationUrl *string
                                
                                	// The ARN of the role that the web application assumes when it interacts with AWS
                                	// IoT Core.
                                	//
                                	// This member is required.
                                	RoleArn *string
                                
                                	// An optional description of the web application.
                                	ApplicationDescription *string
                                
                                	// A message indicating why the DescribeApplication API failed.
                                	ErrorMessage *string
                                
                                	// The Id of the single sign-on client that you use to authenticate and authorize
                                	// users on the web application.
                                	SsoClientId *string
                                
                                	// A set of key/value pairs that you can use to manage the web application
                                	// resource.
                                	Tags map[string]string
                                
                                	// 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 EndpointResolverFromURL

                                  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

                                      type EndpointResolverOptions = internalendpoints.Options

                                        EndpointResolverOptions is the service endpoint resolver options

                                        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 IdempotencyTokenProvider

                                        type IdempotencyTokenProvider interface {
                                        	GetIdempotencyToken() (string, error)
                                        }

                                          IdempotencyTokenProvider interface for providing idempotency token

                                          type ListApplicationsAPIClient

                                          type ListApplicationsAPIClient interface {
                                          	ListApplications(context.Context, *ListApplicationsInput, ...func(*Options)) (*ListApplicationsOutput, error)
                                          }

                                            ListApplicationsAPIClient is a client that implements the ListApplications operation.

                                            type ListApplicationsInput

                                            type ListApplicationsInput struct {
                                            
                                            	// A token used to get the next set of results.
                                            	NextToken *string
                                            }

                                            type ListApplicationsOutput

                                            type ListApplicationsOutput struct {
                                            
                                            	// An array of objects that provide summaries of information about the web
                                            	// applications in the list.
                                            	ApplicationSummaries []types.ApplicationSummary
                                            
                                            	// A token used to get the next set of results.
                                            	NextToken *string
                                            
                                            	// Metadata pertaining to the operation's result.
                                            	ResultMetadata middleware.Metadata
                                            }

                                            type ListApplicationsPaginator

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

                                              ListApplicationsPaginator is a paginator for ListApplications

                                              func NewListApplicationsPaginator

                                              func NewListApplicationsPaginator(client ListApplicationsAPIClient, params *ListApplicationsInput, optFns ...func(*ListApplicationsPaginatorOptions)) *ListApplicationsPaginator

                                                NewListApplicationsPaginator returns a new ListApplicationsPaginator

                                                func (*ListApplicationsPaginator) HasMorePages

                                                func (p *ListApplicationsPaginator) HasMorePages() bool

                                                  HasMorePages returns a boolean indicating whether more pages are available

                                                  func (*ListApplicationsPaginator) NextPage

                                                  func (p *ListApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApplicationsOutput, error)

                                                    NextPage retrieves the next ListApplications page.

                                                    type ListApplicationsPaginatorOptions

                                                    type ListApplicationsPaginatorOptions struct {
                                                    	// 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
                                                    }

                                                      ListApplicationsPaginatorOptions is the paginator options for ListApplications

                                                      type ListTagsForResourceInput

                                                      type ListTagsForResourceInput struct {
                                                      
                                                      	// The ARN of the resource.
                                                      	//
                                                      	// This member is required.
                                                      	ResourceArn *string
                                                      }

                                                      type ListTagsForResourceOutput

                                                      type ListTagsForResourceOutput struct {
                                                      
                                                      	// The list of tags 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
                                                      
                                                      	// Provides idempotency tokens values that will be automatically populated into
                                                      	// idempotent API operations.
                                                      	IdempotencyTokenProvider IdempotencyTokenProvider
                                                      
                                                      	// 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 aws.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 (*ResolveEndpoint) ID

                                                        func (*ResolveEndpoint) ID() string

                                                        type TagResourceInput

                                                        type TagResourceInput struct {
                                                        
                                                        	// The ARN of the resource.
                                                        	//
                                                        	// This member is required.
                                                        	ResourceArn *string
                                                        
                                                        	// The new or modified tags for the 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.
                                                        	//
                                                        	// This member is required.
                                                        	ResourceArn *string
                                                        
                                                        	// A list of the keys of the tags to be removed from the resource.
                                                        	//
                                                        	// This member is required.
                                                        	TagKeys []string
                                                        }

                                                        type UntagResourceOutput

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

                                                        type UpdateApplicationInput

                                                        type UpdateApplicationInput struct {
                                                        
                                                        	// The unique Id of the web application.
                                                        	//
                                                        	// This member is required.
                                                        	ApplicationId *string
                                                        
                                                        	// An optional description of the web application.
                                                        	ApplicationDescription *string
                                                        
                                                        	// The name of the web application.
                                                        	ApplicationName *string
                                                        
                                                        	// A unique case-sensitive identifier that you can provide to ensure the
                                                        	// idempotency of the request. Don't reuse this client token if a new idempotent
                                                        	// request is required.
                                                        	ClientToken *string
                                                        }

                                                        type UpdateApplicationOutput

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

                                                        Directories

                                                        Path Synopsis
                                                        internal