iotdeviceadvisor

package module
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 27 Imported by: 6

Documentation

Overview

Package iotdeviceadvisor provides the API client, operations, and parameter types for AWS IoT Core Device Advisor.

AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the AWS Partner Network to get your device qualified for the AWS Partner Device Catalog without the need to send your device in and wait for it to be tested.

Index

Constants

View Source 
const ServiceAPIVersion = "2020-09-18"
View Source 
const ServiceID = "IotDeviceAdvisor"

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 

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 Core Device Advisor.

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

func (c *Client) CreateSuiteDefinition(ctx context.Context, params *CreateSuiteDefinitionInput, optFns ...func(*Options)) (*CreateSuiteDefinitionOutput, error)

Creates a Device Advisor test suite.

func (*Client) DeleteSuiteDefinition 

func (c *Client) DeleteSuiteDefinition(ctx context.Context, params *DeleteSuiteDefinitionInput, optFns ...func(*Options)) (*DeleteSuiteDefinitionOutput, error)

Deletes a Device Advisor test suite.

func (*Client) GetSuiteDefinition 

func (c *Client) GetSuiteDefinition(ctx context.Context, params *GetSuiteDefinitionInput, optFns ...func(*Options)) (*GetSuiteDefinitionOutput, error)

Gets information about a Device Advisor test suite.

func (*Client) GetSuiteRun 

func (c *Client) GetSuiteRun(ctx context.Context, params *GetSuiteRunInput, optFns ...func(*Options)) (*GetSuiteRunOutput, error)

Gets information about a Device Advisor test suite run.

func (*Client) GetSuiteRunReport 

func (c *Client) GetSuiteRunReport(ctx context.Context, params *GetSuiteRunReportInput, optFns ...func(*Options)) (*GetSuiteRunReportOutput, error)

Gets a report download link for a successful Device Advisor qualifying test suite run.

func (*Client) ListSuiteDefinitions 

func (c *Client) ListSuiteDefinitions(ctx context.Context, params *ListSuiteDefinitionsInput, optFns ...func(*Options)) (*ListSuiteDefinitionsOutput, error)

Lists the Device Advisor test suites you have created.

func (*Client) ListSuiteRuns 

func (c *Client) ListSuiteRuns(ctx context.Context, params *ListSuiteRunsInput, optFns ...func(*Options)) (*ListSuiteRunsOutput, error)

Lists the runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

func (*Client) ListTagsForResource 

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

Lists the tags attached to an IoT Device Advisor resource.

func (*Client) ListTestCases 

func (c *Client) ListTestCases(ctx context.Context, params *ListTestCasesInput, optFns ...func(*Options)) (*ListTestCasesOutput, error)

Lists all the test cases in the test suite.

func (*Client) StartSuiteRun 

func (c *Client) StartSuiteRun(ctx context.Context, params *StartSuiteRunInput, optFns ...func(*Options)) (*StartSuiteRunOutput, error)

Starts a Device Advisor test suite run.

func (*Client) TagResource 

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

Adds to and modifies existing tags of an IoT Device Advisor resource.

func (*Client) UntagResource 

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

Removes tags from an IoT Device Advisor resource.

func (*Client) UpdateSuiteDefinition 

func (c *Client) UpdateSuiteDefinition(ctx context.Context, params *UpdateSuiteDefinitionInput, optFns ...func(*Options)) (*UpdateSuiteDefinitionOutput, error)

Updates a Device Advisor test suite.

type CreateSuiteDefinitionInput 

type CreateSuiteDefinitionInput struct {

	// Creates a Device Advisor test suite with suite definition configuration.
	SuiteDefinitionConfiguration *types.SuiteDefinitionConfiguration

	// The tags to be attached to the suite definition.
	Tags map[string]string
}

type CreateSuiteDefinitionOutput 

type CreateSuiteDefinitionOutput struct {

	// Creates a Device Advisor test suite with TimeStamp of when it was created.
	CreatedAt *time.Time

	// Creates a Device Advisor test suite with Amazon Resource name.
	SuiteDefinitionArn *string

	// Creates a Device Advisor test suite with suite UUID.
	SuiteDefinitionId *string

	// Creates a Device Advisor test suite with suite definition name.
	SuiteDefinitionName *string

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

type DeleteSuiteDefinitionInput 

type DeleteSuiteDefinitionInput struct {

	// Deletes a Device Advisor test suite with defined suite Id.
	//
	// This member is required.
	SuiteDefinitionId *string
}

type DeleteSuiteDefinitionOutput 

type DeleteSuiteDefinitionOutput 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 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 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetSuiteDefinitionInput 

type GetSuiteDefinitionInput struct {

	// Requests suite definition Id with GetSuiteDefinition API call.
	//
	// This member is required.
	SuiteDefinitionId *string

	// Requests the suite definition version of a test suite.
	SuiteDefinitionVersion *string
}

type GetSuiteDefinitionOutput 

type GetSuiteDefinitionOutput struct {

	// Gets the timestamp of the time suite was created with GetSuiteDefinition API
	// call.
	CreatedAt *time.Time

	// Gets the timestamp of the time suite was modified with GetSuiteDefinition API
	// call.
	LastModifiedAt *time.Time

	// Gets latest suite definition version with GetSuiteDefinition API call.
	LatestVersion *string

	// The ARN of the suite definition.
	SuiteDefinitionArn *string

	// Gets the suite configuration with GetSuiteDefinition API call.
	SuiteDefinitionConfiguration *types.SuiteDefinitionConfiguration

	// Gets suite definition Id with GetSuiteDefinition API call.
	SuiteDefinitionId *string

	// Gets suite definition version with GetSuiteDefinition API call.
	SuiteDefinitionVersion *string

	// Tags attached to the suite definition.
	Tags map[string]string

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

type GetSuiteRunInput 

type GetSuiteRunInput struct {

	// Requests the information about Device Advisor test suite run based on suite
	// definition Id.
	//
	// This member is required.
	SuiteDefinitionId *string

	// Requests the information about Device Advisor test suite run based on suite run
	// Id.
	//
	// This member is required.
	SuiteRunId *string
}

type GetSuiteRunOutput 

type GetSuiteRunOutput struct {

	// Gets the information about Device Advisor test suite run based on end time.
	EndTime *time.Time

	// Gets the information about Device Advisor test suite run based on error.
	ErrorReason *string

	// Gets the information about Device Advisor test suite run based on start time.
	StartTime *time.Time

	// Gets the information about Device Advisor test suite run based on its status.
	Status types.SuiteRunStatus

	// Gets the information about Device Advisor test suite run based on suite
	// definition Id.
	SuiteDefinitionId *string

	// Gets the information about Device Advisor test suite run based on suite
	// definition version.
	SuiteDefinitionVersion *string

	// The ARN of the suite run.
	SuiteRunArn *string

	// Gets the information about Device Advisor test suite run based on suite
	// configuration.
	SuiteRunConfiguration *types.SuiteRunConfiguration

	// Gets the information about Device Advisor test suite run based on suite run Id.
	SuiteRunId *string

	// The tags attached to the suite run.
	Tags map[string]string

	// Gets the information about Device Advisor test suite run based on test case
	// runs.
	TestResult *types.TestResult

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

type GetSuiteRunReportInput 

type GetSuiteRunReportInput struct {

	// Device Advisor suite definition Id.
	//
	// This member is required.
	SuiteDefinitionId *string

	// Device Advisor suite run Id.
	//
	// This member is required.
	SuiteRunId *string
}

type GetSuiteRunReportOutput 

type GetSuiteRunReportOutput struct {

	// Gets the download URL of the qualification report.
	QualificationReportDownloadUrl *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 ListSuiteDefinitionsAPIClient 

type ListSuiteDefinitionsAPIClient interface {
	ListSuiteDefinitions(context.Context, *ListSuiteDefinitionsInput, ...func(*Options)) (*ListSuiteDefinitionsOutput, error)
}

ListSuiteDefinitionsAPIClient is a client that implements the ListSuiteDefinitions operation.

type ListSuiteDefinitionsInput 

type ListSuiteDefinitionsInput struct {

	// Request the list of all the Device Advisor test suites.
	MaxResults int32

	// Requests the Device Advisor test suites next token.
	NextToken *string
}

type ListSuiteDefinitionsOutput 

type ListSuiteDefinitionsOutput struct {

	// Creates a Device Advisor test suite.
	NextToken *string

	// Lists test suite information using List suite definition.
	SuiteDefinitionInformationList []types.SuiteDefinitionInformation

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

type ListSuiteDefinitionsPaginator 

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

ListSuiteDefinitionsPaginator is a paginator for ListSuiteDefinitions

func NewListSuiteDefinitionsPaginator 

func NewListSuiteDefinitionsPaginator(client ListSuiteDefinitionsAPIClient, params *ListSuiteDefinitionsInput, optFns ...func(*ListSuiteDefinitionsPaginatorOptions)) *ListSuiteDefinitionsPaginator

NewListSuiteDefinitionsPaginator returns a new ListSuiteDefinitionsPaginator

func (*ListSuiteDefinitionsPaginator) HasMorePages 

func (p *ListSuiteDefinitionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSuiteDefinitionsPaginator) NextPage 

func (p *ListSuiteDefinitionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSuiteDefinitionsOutput, error)

NextPage retrieves the next ListSuiteDefinitions page.

type ListSuiteDefinitionsPaginatorOptions 

type ListSuiteDefinitionsPaginatorOptions struct {
	// Request the list of all the Device Advisor test suites.
	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
}

ListSuiteDefinitionsPaginatorOptions is the paginator options for ListSuiteDefinitions

type ListSuiteRunsAPIClient 

type ListSuiteRunsAPIClient interface {
	ListSuiteRuns(context.Context, *ListSuiteRunsInput, ...func(*Options)) (*ListSuiteRunsOutput, error)
}

ListSuiteRunsAPIClient is a client that implements the ListSuiteRuns operation.

type ListSuiteRunsInput 

type ListSuiteRunsInput struct {

	// MaxResults for list suite run API request.
	MaxResults int32

	// Next pagination token for list suite run request.
	NextToken *string

	// Lists the runs of the specified Device Advisor test suite based on suite
	// definition Id.
	SuiteDefinitionId *string

	// Lists the runs of the specified Device Advisor test suite based on suite
	// definition version.
	SuiteDefinitionVersion *string
}

type ListSuiteRunsOutput 

type ListSuiteRunsOutput struct {

	// Next pagination token for list suite run response.
	NextToken *string

	// Lists the runs of the specified Device Advisor test suite.
	SuiteRunsList []types.SuiteRunInformation

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

type ListSuiteRunsPaginator 

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

ListSuiteRunsPaginator is a paginator for ListSuiteRuns

func NewListSuiteRunsPaginator 

func NewListSuiteRunsPaginator(client ListSuiteRunsAPIClient, params *ListSuiteRunsInput, optFns ...func(*ListSuiteRunsPaginatorOptions)) *ListSuiteRunsPaginator

NewListSuiteRunsPaginator returns a new ListSuiteRunsPaginator

func (*ListSuiteRunsPaginator) HasMorePages 

func (p *ListSuiteRunsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSuiteRunsPaginator) NextPage 

func (p *ListSuiteRunsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSuiteRunsOutput, error)

NextPage retrieves the next ListSuiteRuns page.

type ListSuiteRunsPaginatorOptions 

type ListSuiteRunsPaginatorOptions struct {
	// MaxResults for list suite run API request.
	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
}

ListSuiteRunsPaginatorOptions is the paginator options for ListSuiteRuns

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the IoT Device Advisor resource.
	//
	// This member is required.
	ResourceArn *string
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags attached to the IoT Device Advisor resource.
	Tags map[string]string

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

type ListTestCasesAPIClient 

type ListTestCasesAPIClient interface {
	ListTestCases(context.Context, *ListTestCasesInput, ...func(*Options)) (*ListTestCasesOutput, error)
}

ListTestCasesAPIClient is a client that implements the ListTestCases operation.

type ListTestCasesInput 

type ListTestCasesInput struct {

	// Lists all the qualification test cases in the test suite.
	IntendedForQualification bool

	// Requests the test cases max results.
	MaxResults int32

	// Requests the test cases next token.
	NextToken *string
}

type ListTestCasesOutput 

type ListTestCasesOutput struct {

	// Gets the category of test case.
	Categories []types.TestCaseCategory

	// Gets the configuration of test group.
	GroupConfiguration map[string]string

	// Test cases next token response.
	NextToken *string

	// Gets the configuration of root test group.
	RootGroupConfiguration map[string]string

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

type ListTestCasesPaginator 

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

ListTestCasesPaginator is a paginator for ListTestCases

func NewListTestCasesPaginator 

func NewListTestCasesPaginator(client ListTestCasesAPIClient, params *ListTestCasesInput, optFns ...func(*ListTestCasesPaginatorOptions)) *ListTestCasesPaginator

NewListTestCasesPaginator returns a new ListTestCasesPaginator

func (*ListTestCasesPaginator) HasMorePages 

func (p *ListTestCasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTestCasesPaginator) NextPage 

func (p *ListTestCasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTestCasesOutput, error)

NextPage retrieves the next ListTestCases page.

type ListTestCasesPaginatorOptions 

type ListTestCasesPaginatorOptions struct {
	// Requests the test cases max results.
	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
}

ListTestCasesPaginatorOptions is the paginator options for ListTestCases

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 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 (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 StartSuiteRunInput 

type StartSuiteRunInput struct {

	// Request to start suite run based on suite definition Id.
	//
	// This member is required.
	SuiteDefinitionId *string

	// Request to start suite run based on suite definition version.
	SuiteDefinitionVersion *string

	// Request to start suite run based on suite configuration.
	SuiteRunConfiguration *types.SuiteRunConfiguration

	// The tags to be attached to the suite run.
	Tags map[string]string
}

type StartSuiteRunOutput 

type StartSuiteRunOutput struct {

	// Starts a Device Advisor test suite run based on suite create time.
	CreatedAt *time.Time

	// Starts a Device Advisor test suite run based on suite run arn.
	SuiteRunArn *string

	// Starts a Device Advisor test suite run based on suite Run Id.
	SuiteRunId *string

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

type TagResourceInput 

type TagResourceInput struct {

	// The resource ARN of an IoT Device Advisor resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags to be attached to the IoT Device Advisor 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 resource ARN of an IoT Device Advisor resource.
	//
	// This member is required.
	ResourceArn *string

	// List of tag keys to remove from the IoT Device Advisor resource.
	//
	// This member is required.
	TagKeys []string
}

type UntagResourceOutput 

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

type UpdateSuiteDefinitionInput 

type UpdateSuiteDefinitionInput struct {

	// Updates a Device Advisor test suite with suite definition id.
	//
	// This member is required.
	SuiteDefinitionId *string

	// Updates a Device Advisor test suite with suite definition configuration.
	SuiteDefinitionConfiguration *types.SuiteDefinitionConfiguration
}

type UpdateSuiteDefinitionOutput 

type UpdateSuiteDefinitionOutput struct {

	// Updates a Device Advisor test suite with TimeStamp of when it was created.
	CreatedAt *time.Time

	// Updates a Device Advisor test suite with TimeStamp of when it was updated.
	LastUpdatedAt *time.Time

	// Updates a Device Advisor test suite with Amazon Resource name.
	SuiteDefinitionArn *string

	// Updates a Device Advisor test suite with suite UUID.
	SuiteDefinitionId *string

	// Updates a Device Advisor test suite with suite definition name.
	SuiteDefinitionName *string

	// Updates a Device Advisor test suite with suite definition version.
	SuiteDefinitionVersion *string

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