iotdeviceadvisor

package
v0.0.0-...-7b44715 Latest Latest
Warning

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

Go to latest
Published: Dec 3, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package iotdeviceadvisor provides the client and types for making API requests to AWS IoT Core Device Advisor.

Amazon Web Services 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 Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to Amazon Web Services 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 Amazon Web Services Partner Network to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in and wait for it to be tested.

See https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18 for more information on this service.

See iotdeviceadvisor package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotdeviceadvisor/

Using the Client

To contact AWS IoT Core Device Advisor with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT Core Device Advisor client IoTDeviceAdvisor for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotdeviceadvisor/#New

Index

Constants

View Source
const (
	// AuthenticationMethodX509clientCertificate is a AuthenticationMethod enum value
	AuthenticationMethodX509clientCertificate = "X509ClientCertificate"

	// AuthenticationMethodSignatureVersion4 is a AuthenticationMethod enum value
	AuthenticationMethodSignatureVersion4 = "SignatureVersion4"
)
View Source
const (
	// ProtocolMqttV311 is a Protocol enum value
	ProtocolMqttV311 = "MqttV3_1_1"

	// ProtocolMqttV5 is a Protocol enum value
	ProtocolMqttV5 = "MqttV5"

	// ProtocolMqttV311OverWebSocket is a Protocol enum value
	ProtocolMqttV311OverWebSocket = "MqttV3_1_1_OverWebSocket"

	// ProtocolMqttV5OverWebSocket is a Protocol enum value
	ProtocolMqttV5OverWebSocket = "MqttV5_OverWebSocket"
)
View Source
const (
	// StatusPass is a Status enum value
	StatusPass = "PASS"

	// StatusFail is a Status enum value
	StatusFail = "FAIL"

	// StatusCanceled is a Status enum value
	StatusCanceled = "CANCELED"

	// StatusPending is a Status enum value
	StatusPending = "PENDING"

	// StatusRunning is a Status enum value
	StatusRunning = "RUNNING"

	// StatusStopping is a Status enum value
	StatusStopping = "STOPPING"

	// StatusStopped is a Status enum value
	StatusStopped = "STOPPED"

	// StatusPassWithWarnings is a Status enum value
	StatusPassWithWarnings = "PASS_WITH_WARNINGS"

	// StatusError is a Status enum value
	StatusError = "ERROR"
)
View Source
const (
	// SuiteRunStatusPass is a SuiteRunStatus enum value
	SuiteRunStatusPass = "PASS"

	// SuiteRunStatusFail is a SuiteRunStatus enum value
	SuiteRunStatusFail = "FAIL"

	// SuiteRunStatusCanceled is a SuiteRunStatus enum value
	SuiteRunStatusCanceled = "CANCELED"

	// SuiteRunStatusPending is a SuiteRunStatus enum value
	SuiteRunStatusPending = "PENDING"

	// SuiteRunStatusRunning is a SuiteRunStatus enum value
	SuiteRunStatusRunning = "RUNNING"

	// SuiteRunStatusStopping is a SuiteRunStatus enum value
	SuiteRunStatusStopping = "STOPPING"

	// SuiteRunStatusStopped is a SuiteRunStatus enum value
	SuiteRunStatusStopped = "STOPPED"

	// SuiteRunStatusPassWithWarnings is a SuiteRunStatus enum value
	SuiteRunStatusPassWithWarnings = "PASS_WITH_WARNINGS"

	// SuiteRunStatusError is a SuiteRunStatus enum value
	SuiteRunStatusError = "ERROR"
)
View Source
const (
	// TestCaseScenarioStatusPass is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusPass = "PASS"

	// TestCaseScenarioStatusFail is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusFail = "FAIL"

	// TestCaseScenarioStatusCanceled is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusCanceled = "CANCELED"

	// TestCaseScenarioStatusPending is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusPending = "PENDING"

	// TestCaseScenarioStatusRunning is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusRunning = "RUNNING"

	// TestCaseScenarioStatusStopping is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusStopping = "STOPPING"

	// TestCaseScenarioStatusStopped is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusStopped = "STOPPED"

	// TestCaseScenarioStatusPassWithWarnings is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusPassWithWarnings = "PASS_WITH_WARNINGS"

	// TestCaseScenarioStatusError is a TestCaseScenarioStatus enum value
	TestCaseScenarioStatusError = "ERROR"
)
View Source
const (
	// TestCaseScenarioTypeAdvanced is a TestCaseScenarioType enum value
	TestCaseScenarioTypeAdvanced = "Advanced"

	// TestCaseScenarioTypeBasic is a TestCaseScenarioType enum value
	TestCaseScenarioTypeBasic = "Basic"
)
View Source
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Sends a Conflict Exception.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Sends an Internal Failure exception.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Sends a Resource Not Found exception.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Sends a validation exception.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "IotDeviceAdvisor"     // Name of service.
	EndpointsID = "api.iotdeviceadvisor" // ID to lookup a service endpoint with.
	ServiceID   = "IotDeviceAdvisor"     // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AuthenticationMethod_Values

func AuthenticationMethod_Values() []string

AuthenticationMethod_Values returns all elements of the AuthenticationMethod enum

func Protocol_Values

func Protocol_Values() []string

Protocol_Values returns all elements of the Protocol enum

func Status_Values

func Status_Values() []string

Status_Values returns all elements of the Status enum

func SuiteRunStatus_Values

func SuiteRunStatus_Values() []string

SuiteRunStatus_Values returns all elements of the SuiteRunStatus enum

func TestCaseScenarioStatus_Values

func TestCaseScenarioStatus_Values() []string

TestCaseScenarioStatus_Values returns all elements of the TestCaseScenarioStatus enum

func TestCaseScenarioType_Values

func TestCaseScenarioType_Values() []string

TestCaseScenarioType_Values returns all elements of the TestCaseScenarioType enum

Types

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Sends a Conflict Exception message.
	Message_ *string `locationName:"message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Sends a Conflict Exception.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateSuiteDefinitionInput

type CreateSuiteDefinitionInput struct {

	// Creates a Device Advisor test suite with suite definition configuration.
	//
	// SuiteDefinitionConfiguration is a required field
	SuiteDefinitionConfiguration *SuiteDefinitionConfiguration `locationName:"suiteDefinitionConfiguration" type:"structure" required:"true"`

	// The tags to be attached to the suite definition.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateSuiteDefinitionInput) GoString

func (s CreateSuiteDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSuiteDefinitionInput) SetSuiteDefinitionConfiguration

SetSuiteDefinitionConfiguration sets the SuiteDefinitionConfiguration field's value.

func (*CreateSuiteDefinitionInput) SetTags

SetTags sets the Tags field's value.

func (CreateSuiteDefinitionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSuiteDefinitionInput) Validate

func (s *CreateSuiteDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSuiteDefinitionOutput

type CreateSuiteDefinitionOutput struct {

	// The timestamp of when the test suite was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the test suite.
	SuiteDefinitionArn *string `locationName:"suiteDefinitionArn" min:"20" type:"string"`

	// The UUID of the test suite created.
	SuiteDefinitionId *string `locationName:"suiteDefinitionId" min:"12" type:"string"`

	// The suite definition name of the test suite. This is a required parameter.
	SuiteDefinitionName *string `locationName:"suiteDefinitionName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateSuiteDefinitionOutput) GoString

func (s CreateSuiteDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateSuiteDefinitionOutput) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*CreateSuiteDefinitionOutput) SetSuiteDefinitionArn

func (s *CreateSuiteDefinitionOutput) SetSuiteDefinitionArn(v string) *CreateSuiteDefinitionOutput

SetSuiteDefinitionArn sets the SuiteDefinitionArn field's value.

func (*CreateSuiteDefinitionOutput) SetSuiteDefinitionId

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*CreateSuiteDefinitionOutput) SetSuiteDefinitionName

func (s *CreateSuiteDefinitionOutput) SetSuiteDefinitionName(v string) *CreateSuiteDefinitionOutput

SetSuiteDefinitionName sets the SuiteDefinitionName field's value.

func (CreateSuiteDefinitionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteSuiteDefinitionInput

type DeleteSuiteDefinitionInput struct {

	// Suite definition ID of the test suite to be deleted.
	//
	// SuiteDefinitionId is a required field
	SuiteDefinitionId *string `location:"uri" locationName:"suiteDefinitionId" min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSuiteDefinitionInput) GoString

func (s DeleteSuiteDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSuiteDefinitionInput) SetSuiteDefinitionId

func (s *DeleteSuiteDefinitionInput) SetSuiteDefinitionId(v string) *DeleteSuiteDefinitionInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (DeleteSuiteDefinitionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteSuiteDefinitionInput) Validate

func (s *DeleteSuiteDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSuiteDefinitionOutput

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

func (DeleteSuiteDefinitionOutput) GoString

func (s DeleteSuiteDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteSuiteDefinitionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeviceUnderTest

type DeviceUnderTest struct {

	// Lists device's certificate ARN.
	CertificateArn *string `locationName:"certificateArn" min:"20" type:"string"`

	// Lists device's role ARN.
	DeviceRoleArn *string `locationName:"deviceRoleArn" min:"20" type:"string"`

	// Lists device's thing ARN.
	ThingArn *string `locationName:"thingArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

Information of a test device. A thing ARN, certificate ARN or device role ARN is required.

func (DeviceUnderTest) GoString

func (s DeviceUnderTest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceUnderTest) SetCertificateArn

func (s *DeviceUnderTest) SetCertificateArn(v string) *DeviceUnderTest

SetCertificateArn sets the CertificateArn field's value.

func (*DeviceUnderTest) SetDeviceRoleArn

func (s *DeviceUnderTest) SetDeviceRoleArn(v string) *DeviceUnderTest

SetDeviceRoleArn sets the DeviceRoleArn field's value.

func (*DeviceUnderTest) SetThingArn

func (s *DeviceUnderTest) SetThingArn(v string) *DeviceUnderTest

SetThingArn sets the ThingArn field's value.

func (DeviceUnderTest) String

func (s DeviceUnderTest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeviceUnderTest) Validate

func (s *DeviceUnderTest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEndpointInput

type GetEndpointInput struct {

	// The authentication method used during the device connection.
	AuthenticationMethod *string `location:"querystring" locationName:"authenticationMethod" type:"string" enum:"AuthenticationMethod"`

	// The certificate ARN of the device. This is an optional parameter.
	CertificateArn *string `location:"querystring" locationName:"certificateArn" min:"20" type:"string"`

	// The device role ARN of the device. This is an optional parameter.
	DeviceRoleArn *string `location:"querystring" locationName:"deviceRoleArn" min:"20" type:"string"`

	// The thing ARN of the device. This is an optional parameter.
	ThingArn *string `location:"querystring" locationName:"thingArn" min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (GetEndpointInput) GoString

func (s GetEndpointInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEndpointInput) SetAuthenticationMethod

func (s *GetEndpointInput) SetAuthenticationMethod(v string) *GetEndpointInput

SetAuthenticationMethod sets the AuthenticationMethod field's value.

func (*GetEndpointInput) SetCertificateArn

func (s *GetEndpointInput) SetCertificateArn(v string) *GetEndpointInput

SetCertificateArn sets the CertificateArn field's value.

func (*GetEndpointInput) SetDeviceRoleArn

func (s *GetEndpointInput) SetDeviceRoleArn(v string) *GetEndpointInput

SetDeviceRoleArn sets the DeviceRoleArn field's value.

func (*GetEndpointInput) SetThingArn

func (s *GetEndpointInput) SetThingArn(v string) *GetEndpointInput

SetThingArn sets the ThingArn field's value.

func (GetEndpointInput) String

func (s GetEndpointInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEndpointInput) Validate

func (s *GetEndpointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetEndpointOutput

type GetEndpointOutput struct {

	// The response of an Device Advisor endpoint.
	Endpoint *string `locationName:"endpoint" min:"45" type:"string"`
	// contains filtered or unexported fields
}

func (GetEndpointOutput) GoString

func (s GetEndpointOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetEndpointOutput) SetEndpoint

func (s *GetEndpointOutput) SetEndpoint(v string) *GetEndpointOutput

SetEndpoint sets the Endpoint field's value.

func (GetEndpointOutput) String

func (s GetEndpointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSuiteDefinitionInput

type GetSuiteDefinitionInput struct {

	// Suite definition ID of the test suite to get.
	//
	// SuiteDefinitionId is a required field
	SuiteDefinitionId *string `location:"uri" locationName:"suiteDefinitionId" min:"12" type:"string" required:"true"`

	// Suite definition version of the test suite to get.
	SuiteDefinitionVersion *string `location:"querystring" locationName:"suiteDefinitionVersion" min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (GetSuiteDefinitionInput) GoString

func (s GetSuiteDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteDefinitionInput) SetSuiteDefinitionId

func (s *GetSuiteDefinitionInput) SetSuiteDefinitionId(v string) *GetSuiteDefinitionInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*GetSuiteDefinitionInput) SetSuiteDefinitionVersion

func (s *GetSuiteDefinitionInput) SetSuiteDefinitionVersion(v string) *GetSuiteDefinitionInput

SetSuiteDefinitionVersion sets the SuiteDefinitionVersion field's value.

func (GetSuiteDefinitionInput) String

func (s GetSuiteDefinitionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteDefinitionInput) Validate

func (s *GetSuiteDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSuiteDefinitionOutput

type GetSuiteDefinitionOutput struct {

	// Date (in Unix epoch time) when the suite definition was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Date (in Unix epoch time) when the suite definition was last modified.
	LastModifiedAt *time.Time `locationName:"lastModifiedAt" type:"timestamp"`

	// Latest suite definition version of the suite definition.
	LatestVersion *string `locationName:"latestVersion" min:"2" type:"string"`

	// The ARN of the suite definition.
	SuiteDefinitionArn *string `locationName:"suiteDefinitionArn" min:"20" type:"string"`

	// Suite configuration of the suite definition.
	SuiteDefinitionConfiguration *SuiteDefinitionConfiguration `locationName:"suiteDefinitionConfiguration" type:"structure"`

	// Suite definition ID of the suite definition.
	SuiteDefinitionId *string `locationName:"suiteDefinitionId" min:"12" type:"string"`

	// Suite definition version of the suite definition.
	SuiteDefinitionVersion *string `locationName:"suiteDefinitionVersion" min:"2" type:"string"`

	// Tags attached to the suite definition.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (GetSuiteDefinitionOutput) GoString

func (s GetSuiteDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteDefinitionOutput) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*GetSuiteDefinitionOutput) SetLastModifiedAt

SetLastModifiedAt sets the LastModifiedAt field's value.

func (*GetSuiteDefinitionOutput) SetLatestVersion

SetLatestVersion sets the LatestVersion field's value.

func (*GetSuiteDefinitionOutput) SetSuiteDefinitionArn

func (s *GetSuiteDefinitionOutput) SetSuiteDefinitionArn(v string) *GetSuiteDefinitionOutput

SetSuiteDefinitionArn sets the SuiteDefinitionArn field's value.

func (*GetSuiteDefinitionOutput) SetSuiteDefinitionConfiguration

func (s *GetSuiteDefinitionOutput) SetSuiteDefinitionConfiguration(v *SuiteDefinitionConfiguration) *GetSuiteDefinitionOutput

SetSuiteDefinitionConfiguration sets the SuiteDefinitionConfiguration field's value.

func (*GetSuiteDefinitionOutput) SetSuiteDefinitionId

func (s *GetSuiteDefinitionOutput) SetSuiteDefinitionId(v string) *GetSuiteDefinitionOutput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*GetSuiteDefinitionOutput) SetSuiteDefinitionVersion

func (s *GetSuiteDefinitionOutput) SetSuiteDefinitionVersion(v string) *GetSuiteDefinitionOutput

SetSuiteDefinitionVersion sets the SuiteDefinitionVersion field's value.

func (*GetSuiteDefinitionOutput) SetTags

SetTags sets the Tags field's value.

func (GetSuiteDefinitionOutput) String

func (s GetSuiteDefinitionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSuiteRunInput

type GetSuiteRunInput struct {

	// Suite definition ID for the test suite run.
	//
	// SuiteDefinitionId is a required field
	SuiteDefinitionId *string `location:"uri" locationName:"suiteDefinitionId" min:"12" type:"string" required:"true"`

	// Suite run ID for the test suite run.
	//
	// SuiteRunId is a required field
	SuiteRunId *string `location:"uri" locationName:"suiteRunId" min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSuiteRunInput) GoString

func (s GetSuiteRunInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteRunInput) SetSuiteDefinitionId

func (s *GetSuiteRunInput) SetSuiteDefinitionId(v string) *GetSuiteRunInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*GetSuiteRunInput) SetSuiteRunId

func (s *GetSuiteRunInput) SetSuiteRunId(v string) *GetSuiteRunInput

SetSuiteRunId sets the SuiteRunId field's value.

func (GetSuiteRunInput) String

func (s GetSuiteRunInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteRunInput) Validate

func (s *GetSuiteRunInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSuiteRunOutput

type GetSuiteRunOutput struct {

	// Date (in Unix epoch time) when the test suite run ended.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// Error reason for any test suite run failure.
	ErrorReason *string `locationName:"errorReason" type:"string"`

	// Date (in Unix epoch time) when the test suite run started.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// Status for the test suite run.
	Status *string `locationName:"status" type:"string" enum:"SuiteRunStatus"`

	// Suite definition ID for the test suite run.
	SuiteDefinitionId *string `locationName:"suiteDefinitionId" min:"12" type:"string"`

	// Suite definition version for the test suite run.
	SuiteDefinitionVersion *string `locationName:"suiteDefinitionVersion" min:"2" type:"string"`

	// The ARN of the suite run.
	SuiteRunArn *string `locationName:"suiteRunArn" min:"20" type:"string"`

	// Suite run configuration for the test suite run.
	SuiteRunConfiguration *SuiteRunConfiguration `locationName:"suiteRunConfiguration" type:"structure"`

	// Suite run ID for the test suite run.
	SuiteRunId *string `locationName:"suiteRunId" min:"12" type:"string"`

	// The tags attached to the suite run.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Test results for the test suite run.
	TestResult *TestResult `locationName:"testResult" type:"structure"`
	// contains filtered or unexported fields
}

func (GetSuiteRunOutput) GoString

func (s GetSuiteRunOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteRunOutput) SetEndTime

func (s *GetSuiteRunOutput) SetEndTime(v time.Time) *GetSuiteRunOutput

SetEndTime sets the EndTime field's value.

func (*GetSuiteRunOutput) SetErrorReason

func (s *GetSuiteRunOutput) SetErrorReason(v string) *GetSuiteRunOutput

SetErrorReason sets the ErrorReason field's value.

func (*GetSuiteRunOutput) SetStartTime

func (s *GetSuiteRunOutput) SetStartTime(v time.Time) *GetSuiteRunOutput

SetStartTime sets the StartTime field's value.

func (*GetSuiteRunOutput) SetStatus

func (s *GetSuiteRunOutput) SetStatus(v string) *GetSuiteRunOutput

SetStatus sets the Status field's value.

func (*GetSuiteRunOutput) SetSuiteDefinitionId

func (s *GetSuiteRunOutput) SetSuiteDefinitionId(v string) *GetSuiteRunOutput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*GetSuiteRunOutput) SetSuiteDefinitionVersion

func (s *GetSuiteRunOutput) SetSuiteDefinitionVersion(v string) *GetSuiteRunOutput

SetSuiteDefinitionVersion sets the SuiteDefinitionVersion field's value.

func (*GetSuiteRunOutput) SetSuiteRunArn

func (s *GetSuiteRunOutput) SetSuiteRunArn(v string) *GetSuiteRunOutput

SetSuiteRunArn sets the SuiteRunArn field's value.

func (*GetSuiteRunOutput) SetSuiteRunConfiguration

func (s *GetSuiteRunOutput) SetSuiteRunConfiguration(v *SuiteRunConfiguration) *GetSuiteRunOutput

SetSuiteRunConfiguration sets the SuiteRunConfiguration field's value.

func (*GetSuiteRunOutput) SetSuiteRunId

func (s *GetSuiteRunOutput) SetSuiteRunId(v string) *GetSuiteRunOutput

SetSuiteRunId sets the SuiteRunId field's value.

func (*GetSuiteRunOutput) SetTags

func (s *GetSuiteRunOutput) SetTags(v map[string]*string) *GetSuiteRunOutput

SetTags sets the Tags field's value.

func (*GetSuiteRunOutput) SetTestResult

func (s *GetSuiteRunOutput) SetTestResult(v *TestResult) *GetSuiteRunOutput

SetTestResult sets the TestResult field's value.

func (GetSuiteRunOutput) String

func (s GetSuiteRunOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSuiteRunReportInput

type GetSuiteRunReportInput struct {

	// Suite definition ID of the test suite.
	//
	// SuiteDefinitionId is a required field
	SuiteDefinitionId *string `location:"uri" locationName:"suiteDefinitionId" min:"12" type:"string" required:"true"`

	// Suite run ID of the test suite run.
	//
	// SuiteRunId is a required field
	SuiteRunId *string `location:"uri" locationName:"suiteRunId" min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSuiteRunReportInput) GoString

func (s GetSuiteRunReportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteRunReportInput) SetSuiteDefinitionId

func (s *GetSuiteRunReportInput) SetSuiteDefinitionId(v string) *GetSuiteRunReportInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*GetSuiteRunReportInput) SetSuiteRunId

SetSuiteRunId sets the SuiteRunId field's value.

func (GetSuiteRunReportInput) String

func (s GetSuiteRunReportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteRunReportInput) Validate

func (s *GetSuiteRunReportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSuiteRunReportOutput

type GetSuiteRunReportOutput struct {

	// Download URL of the qualification report.
	QualificationReportDownloadUrl *string `locationName:"qualificationReportDownloadUrl" type:"string"`
	// contains filtered or unexported fields
}

func (GetSuiteRunReportOutput) GoString

func (s GetSuiteRunReportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSuiteRunReportOutput) SetQualificationReportDownloadUrl

func (s *GetSuiteRunReportOutput) SetQualificationReportDownloadUrl(v string) *GetSuiteRunReportOutput

SetQualificationReportDownloadUrl sets the QualificationReportDownloadUrl field's value.

func (GetSuiteRunReportOutput) String

func (s GetSuiteRunReportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GroupResult

type GroupResult struct {

	// Group result ID.
	GroupId *string `locationName:"groupId" min:"12" type:"string"`

	// Group Result Name.
	GroupName *string `locationName:"groupName" type:"string"`

	// Tests under Group Result.
	Tests []*TestCaseRun `locationName:"tests" type:"list"`
	// contains filtered or unexported fields
}

Show Group Result.

func (GroupResult) GoString

func (s GroupResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupResult) SetGroupId

func (s *GroupResult) SetGroupId(v string) *GroupResult

SetGroupId sets the GroupId field's value.

func (*GroupResult) SetGroupName

func (s *GroupResult) SetGroupName(v string) *GroupResult

SetGroupName sets the GroupName field's value.

func (*GroupResult) SetTests

func (s *GroupResult) SetTests(v []*TestCaseRun) *GroupResult

SetTests sets the Tests field's value.

func (GroupResult) String

func (s GroupResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Sends an Internal Failure Exception message.
	Message_ *string `locationName:"message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Sends an Internal Failure exception.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IoTDeviceAdvisor

type IoTDeviceAdvisor struct {
	*client.Client
}

IoTDeviceAdvisor provides the API operation methods for making requests to AWS IoT Core Device Advisor. See this package's package overview docs for details on the service.

IoTDeviceAdvisor methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the IoTDeviceAdvisor client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a IoTDeviceAdvisor client from just a session.
svc := iotdeviceadvisor.New(mySession)

// Create a IoTDeviceAdvisor client with additional configuration
svc := iotdeviceadvisor.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoTDeviceAdvisor) CreateSuiteDefinition

CreateSuiteDefinition API operation for AWS IoT Core Device Advisor.

Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation CreateSuiteDefinition for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/CreateSuiteDefinition

func (*IoTDeviceAdvisor) CreateSuiteDefinitionRequest

func (c *IoTDeviceAdvisor) CreateSuiteDefinitionRequest(input *CreateSuiteDefinitionInput) (req *request.Request, output *CreateSuiteDefinitionOutput)

CreateSuiteDefinitionRequest generates a "aws/request.Request" representing the client's request for the CreateSuiteDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSuiteDefinition for more information on using the CreateSuiteDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSuiteDefinitionRequest method.
req, resp := client.CreateSuiteDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/CreateSuiteDefinition

func (*IoTDeviceAdvisor) CreateSuiteDefinitionWithContext

func (c *IoTDeviceAdvisor) CreateSuiteDefinitionWithContext(ctx aws.Context, input *CreateSuiteDefinitionInput, opts ...request.Option) (*CreateSuiteDefinitionOutput, error)

CreateSuiteDefinitionWithContext is the same as CreateSuiteDefinition with the addition of the ability to pass a context and additional request options.

See CreateSuiteDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) DeleteSuiteDefinition

DeleteSuiteDefinition API operation for AWS IoT Core Device Advisor.

Deletes a Device Advisor test suite.

Requires permission to access the DeleteSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation DeleteSuiteDefinition for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/DeleteSuiteDefinition

func (*IoTDeviceAdvisor) DeleteSuiteDefinitionRequest

func (c *IoTDeviceAdvisor) DeleteSuiteDefinitionRequest(input *DeleteSuiteDefinitionInput) (req *request.Request, output *DeleteSuiteDefinitionOutput)

DeleteSuiteDefinitionRequest generates a "aws/request.Request" representing the client's request for the DeleteSuiteDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSuiteDefinition for more information on using the DeleteSuiteDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSuiteDefinitionRequest method.
req, resp := client.DeleteSuiteDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/DeleteSuiteDefinition

func (*IoTDeviceAdvisor) DeleteSuiteDefinitionWithContext

func (c *IoTDeviceAdvisor) DeleteSuiteDefinitionWithContext(ctx aws.Context, input *DeleteSuiteDefinitionInput, opts ...request.Option) (*DeleteSuiteDefinitionOutput, error)

DeleteSuiteDefinitionWithContext is the same as DeleteSuiteDefinition with the addition of the ability to pass a context and additional request options.

See DeleteSuiteDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) GetEndpoint

func (c *IoTDeviceAdvisor) GetEndpoint(input *GetEndpointInput) (*GetEndpointOutput, error)

GetEndpoint API operation for AWS IoT Core Device Advisor.

Gets information about an Device Advisor endpoint.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation GetEndpoint for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetEndpoint

func (*IoTDeviceAdvisor) GetEndpointRequest

func (c *IoTDeviceAdvisor) GetEndpointRequest(input *GetEndpointInput) (req *request.Request, output *GetEndpointOutput)

GetEndpointRequest generates a "aws/request.Request" representing the client's request for the GetEndpoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetEndpoint for more information on using the GetEndpoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetEndpointRequest method.
req, resp := client.GetEndpointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetEndpoint

func (*IoTDeviceAdvisor) GetEndpointWithContext

func (c *IoTDeviceAdvisor) GetEndpointWithContext(ctx aws.Context, input *GetEndpointInput, opts ...request.Option) (*GetEndpointOutput, error)

GetEndpointWithContext is the same as GetEndpoint with the addition of the ability to pass a context and additional request options.

See GetEndpoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) GetSuiteDefinition

func (c *IoTDeviceAdvisor) GetSuiteDefinition(input *GetSuiteDefinitionInput) (*GetSuiteDefinitionOutput, error)

GetSuiteDefinition API operation for AWS IoT Core Device Advisor.

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation GetSuiteDefinition for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetSuiteDefinition

func (*IoTDeviceAdvisor) GetSuiteDefinitionRequest

func (c *IoTDeviceAdvisor) GetSuiteDefinitionRequest(input *GetSuiteDefinitionInput) (req *request.Request, output *GetSuiteDefinitionOutput)

GetSuiteDefinitionRequest generates a "aws/request.Request" representing the client's request for the GetSuiteDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSuiteDefinition for more information on using the GetSuiteDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSuiteDefinitionRequest method.
req, resp := client.GetSuiteDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetSuiteDefinition

func (*IoTDeviceAdvisor) GetSuiteDefinitionWithContext

func (c *IoTDeviceAdvisor) GetSuiteDefinitionWithContext(ctx aws.Context, input *GetSuiteDefinitionInput, opts ...request.Option) (*GetSuiteDefinitionOutput, error)

GetSuiteDefinitionWithContext is the same as GetSuiteDefinition with the addition of the ability to pass a context and additional request options.

See GetSuiteDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) GetSuiteRun

func (c *IoTDeviceAdvisor) GetSuiteRun(input *GetSuiteRunInput) (*GetSuiteRunOutput, error)

GetSuiteRun API operation for AWS IoT Core Device Advisor.

Gets information about a Device Advisor test suite run.

Requires permission to access the GetSuiteRun (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation GetSuiteRun for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetSuiteRun

func (*IoTDeviceAdvisor) GetSuiteRunReport

func (c *IoTDeviceAdvisor) GetSuiteRunReport(input *GetSuiteRunReportInput) (*GetSuiteRunReportOutput, error)

GetSuiteRunReport API operation for AWS IoT Core Device Advisor.

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

Requires permission to access the GetSuiteRunReport (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation GetSuiteRunReport for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetSuiteRunReport

func (*IoTDeviceAdvisor) GetSuiteRunReportRequest

func (c *IoTDeviceAdvisor) GetSuiteRunReportRequest(input *GetSuiteRunReportInput) (req *request.Request, output *GetSuiteRunReportOutput)

GetSuiteRunReportRequest generates a "aws/request.Request" representing the client's request for the GetSuiteRunReport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSuiteRunReport for more information on using the GetSuiteRunReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSuiteRunReportRequest method.
req, resp := client.GetSuiteRunReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetSuiteRunReport

func (*IoTDeviceAdvisor) GetSuiteRunReportWithContext

func (c *IoTDeviceAdvisor) GetSuiteRunReportWithContext(ctx aws.Context, input *GetSuiteRunReportInput, opts ...request.Option) (*GetSuiteRunReportOutput, error)

GetSuiteRunReportWithContext is the same as GetSuiteRunReport with the addition of the ability to pass a context and additional request options.

See GetSuiteRunReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) GetSuiteRunRequest

func (c *IoTDeviceAdvisor) GetSuiteRunRequest(input *GetSuiteRunInput) (req *request.Request, output *GetSuiteRunOutput)

GetSuiteRunRequest generates a "aws/request.Request" representing the client's request for the GetSuiteRun operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSuiteRun for more information on using the GetSuiteRun API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSuiteRunRequest method.
req, resp := client.GetSuiteRunRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/GetSuiteRun

func (*IoTDeviceAdvisor) GetSuiteRunWithContext

func (c *IoTDeviceAdvisor) GetSuiteRunWithContext(ctx aws.Context, input *GetSuiteRunInput, opts ...request.Option) (*GetSuiteRunOutput, error)

GetSuiteRunWithContext is the same as GetSuiteRun with the addition of the ability to pass a context and additional request options.

See GetSuiteRun for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) ListSuiteDefinitions

func (c *IoTDeviceAdvisor) ListSuiteDefinitions(input *ListSuiteDefinitionsInput) (*ListSuiteDefinitionsOutput, error)

ListSuiteDefinitions API operation for AWS IoT Core Device Advisor.

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation ListSuiteDefinitions for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/ListSuiteDefinitions

func (*IoTDeviceAdvisor) ListSuiteDefinitionsPages

func (c *IoTDeviceAdvisor) ListSuiteDefinitionsPages(input *ListSuiteDefinitionsInput, fn func(*ListSuiteDefinitionsOutput, bool) bool) error

ListSuiteDefinitionsPages iterates over the pages of a ListSuiteDefinitions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSuiteDefinitions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSuiteDefinitions operation.
pageNum := 0
err := client.ListSuiteDefinitionsPages(params,
    func(page *iotdeviceadvisor.ListSuiteDefinitionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTDeviceAdvisor) ListSuiteDefinitionsPagesWithContext

func (c *IoTDeviceAdvisor) ListSuiteDefinitionsPagesWithContext(ctx aws.Context, input *ListSuiteDefinitionsInput, fn func(*ListSuiteDefinitionsOutput, bool) bool, opts ...request.Option) error

ListSuiteDefinitionsPagesWithContext same as ListSuiteDefinitionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) ListSuiteDefinitionsRequest

func (c *IoTDeviceAdvisor) ListSuiteDefinitionsRequest(input *ListSuiteDefinitionsInput) (req *request.Request, output *ListSuiteDefinitionsOutput)

ListSuiteDefinitionsRequest generates a "aws/request.Request" representing the client's request for the ListSuiteDefinitions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSuiteDefinitions for more information on using the ListSuiteDefinitions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSuiteDefinitionsRequest method.
req, resp := client.ListSuiteDefinitionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/ListSuiteDefinitions

func (*IoTDeviceAdvisor) ListSuiteDefinitionsWithContext

func (c *IoTDeviceAdvisor) ListSuiteDefinitionsWithContext(ctx aws.Context, input *ListSuiteDefinitionsInput, opts ...request.Option) (*ListSuiteDefinitionsOutput, error)

ListSuiteDefinitionsWithContext is the same as ListSuiteDefinitions with the addition of the ability to pass a context and additional request options.

See ListSuiteDefinitions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) ListSuiteRuns

func (c *IoTDeviceAdvisor) ListSuiteRuns(input *ListSuiteRunsInput) (*ListSuiteRunsOutput, error)

ListSuiteRuns API operation for AWS IoT Core Device Advisor.

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

Requires permission to access the ListSuiteRuns (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation ListSuiteRuns for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/ListSuiteRuns

func (*IoTDeviceAdvisor) ListSuiteRunsPages

func (c *IoTDeviceAdvisor) ListSuiteRunsPages(input *ListSuiteRunsInput, fn func(*ListSuiteRunsOutput, bool) bool) error

ListSuiteRunsPages iterates over the pages of a ListSuiteRuns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListSuiteRuns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListSuiteRuns operation.
pageNum := 0
err := client.ListSuiteRunsPages(params,
    func(page *iotdeviceadvisor.ListSuiteRunsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTDeviceAdvisor) ListSuiteRunsPagesWithContext

func (c *IoTDeviceAdvisor) ListSuiteRunsPagesWithContext(ctx aws.Context, input *ListSuiteRunsInput, fn func(*ListSuiteRunsOutput, bool) bool, opts ...request.Option) error

ListSuiteRunsPagesWithContext same as ListSuiteRunsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) ListSuiteRunsRequest

func (c *IoTDeviceAdvisor) ListSuiteRunsRequest(input *ListSuiteRunsInput) (req *request.Request, output *ListSuiteRunsOutput)

ListSuiteRunsRequest generates a "aws/request.Request" representing the client's request for the ListSuiteRuns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListSuiteRuns for more information on using the ListSuiteRuns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListSuiteRunsRequest method.
req, resp := client.ListSuiteRunsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/ListSuiteRuns

func (*IoTDeviceAdvisor) ListSuiteRunsWithContext

func (c *IoTDeviceAdvisor) ListSuiteRunsWithContext(ctx aws.Context, input *ListSuiteRunsInput, opts ...request.Option) (*ListSuiteRunsOutput, error)

ListSuiteRunsWithContext is the same as ListSuiteRuns with the addition of the ability to pass a context and additional request options.

See ListSuiteRuns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) ListTagsForResource

func (c *IoTDeviceAdvisor) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT Core Device Advisor.

Lists the tags attached to an IoT Device Advisor resource.

Requires permission to access the ListTagsForResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalServerException Sends an Internal Failure exception.

  • ValidationException Sends a validation exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/ListTagsForResource

func (*IoTDeviceAdvisor) ListTagsForResourceRequest

func (c *IoTDeviceAdvisor) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/ListTagsForResource

func (*IoTDeviceAdvisor) ListTagsForResourceWithContext

func (c *IoTDeviceAdvisor) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) StartSuiteRun

func (c *IoTDeviceAdvisor) StartSuiteRun(input *StartSuiteRunInput) (*StartSuiteRunOutput, error)

StartSuiteRun API operation for AWS IoT Core Device Advisor.

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation StartSuiteRun for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

  • ConflictException Sends a Conflict Exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/StartSuiteRun

func (*IoTDeviceAdvisor) StartSuiteRunRequest

func (c *IoTDeviceAdvisor) StartSuiteRunRequest(input *StartSuiteRunInput) (req *request.Request, output *StartSuiteRunOutput)

StartSuiteRunRequest generates a "aws/request.Request" representing the client's request for the StartSuiteRun operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartSuiteRun for more information on using the StartSuiteRun API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartSuiteRunRequest method.
req, resp := client.StartSuiteRunRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/StartSuiteRun

func (*IoTDeviceAdvisor) StartSuiteRunWithContext

func (c *IoTDeviceAdvisor) StartSuiteRunWithContext(ctx aws.Context, input *StartSuiteRunInput, opts ...request.Option) (*StartSuiteRunOutput, error)

StartSuiteRunWithContext is the same as StartSuiteRun with the addition of the ability to pass a context and additional request options.

See StartSuiteRun for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) StopSuiteRun

func (c *IoTDeviceAdvisor) StopSuiteRun(input *StopSuiteRunInput) (*StopSuiteRunOutput, error)

StopSuiteRun API operation for AWS IoT Core Device Advisor.

Stops a Device Advisor test suite run that is currently running.

Requires permission to access the StopSuiteRun (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation StopSuiteRun for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

  • InternalServerException Sends an Internal Failure exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/StopSuiteRun

func (*IoTDeviceAdvisor) StopSuiteRunRequest

func (c *IoTDeviceAdvisor) StopSuiteRunRequest(input *StopSuiteRunInput) (req *request.Request, output *StopSuiteRunOutput)

StopSuiteRunRequest generates a "aws/request.Request" representing the client's request for the StopSuiteRun operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopSuiteRun for more information on using the StopSuiteRun API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopSuiteRunRequest method.
req, resp := client.StopSuiteRunRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/StopSuiteRun

func (*IoTDeviceAdvisor) StopSuiteRunWithContext

func (c *IoTDeviceAdvisor) StopSuiteRunWithContext(ctx aws.Context, input *StopSuiteRunInput, opts ...request.Option) (*StopSuiteRunOutput, error)

StopSuiteRunWithContext is the same as StopSuiteRun with the addition of the ability to pass a context and additional request options.

See StopSuiteRun for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) TagResource

func (c *IoTDeviceAdvisor) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT Core Device Advisor.

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

Requires permission to access the TagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalServerException Sends an Internal Failure exception.

  • ValidationException Sends a validation exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/TagResource

func (*IoTDeviceAdvisor) TagResourceRequest

func (c *IoTDeviceAdvisor) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/TagResource

func (*IoTDeviceAdvisor) TagResourceWithContext

func (c *IoTDeviceAdvisor) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) UntagResource

func (c *IoTDeviceAdvisor) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT Core Device Advisor.

Removes tags from an IoT Device Advisor resource.

Requires permission to access the UntagResource (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalServerException Sends an Internal Failure exception.

  • ValidationException Sends a validation exception.

  • ResourceNotFoundException Sends a Resource Not Found exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/UntagResource

func (*IoTDeviceAdvisor) UntagResourceRequest

func (c *IoTDeviceAdvisor) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/UntagResource

func (*IoTDeviceAdvisor) UntagResourceWithContext

func (c *IoTDeviceAdvisor) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTDeviceAdvisor) UpdateSuiteDefinition

UpdateSuiteDefinition API operation for AWS IoT Core Device Advisor.

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT Core Device Advisor's API operation UpdateSuiteDefinition for usage and error information.

Returned Error Types:

  • ValidationException Sends a validation exception.

  • InternalServerException Sends an Internal Failure exception.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/UpdateSuiteDefinition

func (*IoTDeviceAdvisor) UpdateSuiteDefinitionRequest

func (c *IoTDeviceAdvisor) UpdateSuiteDefinitionRequest(input *UpdateSuiteDefinitionInput) (req *request.Request, output *UpdateSuiteDefinitionOutput)

UpdateSuiteDefinitionRequest generates a "aws/request.Request" representing the client's request for the UpdateSuiteDefinition operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSuiteDefinition for more information on using the UpdateSuiteDefinition API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSuiteDefinitionRequest method.
req, resp := client.UpdateSuiteDefinitionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/UpdateSuiteDefinition

func (*IoTDeviceAdvisor) UpdateSuiteDefinitionWithContext

func (c *IoTDeviceAdvisor) UpdateSuiteDefinitionWithContext(ctx aws.Context, input *UpdateSuiteDefinitionInput, opts ...request.Option) (*UpdateSuiteDefinitionOutput, error)

UpdateSuiteDefinitionWithContext is the same as UpdateSuiteDefinition with the addition of the ability to pass a context and additional request options.

See UpdateSuiteDefinition for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListSuiteDefinitionsInput

type ListSuiteDefinitionsInput struct {

	// The maximum number of results to return at once.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token used to get the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListSuiteDefinitionsInput) GoString

func (s ListSuiteDefinitionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSuiteDefinitionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListSuiteDefinitionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListSuiteDefinitionsInput) String

func (s ListSuiteDefinitionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSuiteDefinitionsInput) Validate

func (s *ListSuiteDefinitionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSuiteDefinitionsOutput

type ListSuiteDefinitionsOutput struct {

	// A token used to get the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that provide summaries of information about the suite
	// definitions in the list.
	SuiteDefinitionInformationList []*SuiteDefinitionInformation `locationName:"suiteDefinitionInformationList" type:"list"`
	// contains filtered or unexported fields
}

func (ListSuiteDefinitionsOutput) GoString

func (s ListSuiteDefinitionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSuiteDefinitionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListSuiteDefinitionsOutput) SetSuiteDefinitionInformationList

func (s *ListSuiteDefinitionsOutput) SetSuiteDefinitionInformationList(v []*SuiteDefinitionInformation) *ListSuiteDefinitionsOutput

SetSuiteDefinitionInformationList sets the SuiteDefinitionInformationList field's value.

func (ListSuiteDefinitionsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListSuiteRunsInput

type ListSuiteRunsInput struct {

	// The maximum number of results to return at once.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A token to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// Lists the test suite runs of the specified test suite based on suite definition
	// ID.
	SuiteDefinitionId *string `location:"querystring" locationName:"suiteDefinitionId" min:"12" type:"string"`

	// Must be passed along with suiteDefinitionId. Lists the test suite runs of
	// the specified test suite based on suite definition version.
	SuiteDefinitionVersion *string `location:"querystring" locationName:"suiteDefinitionVersion" min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (ListSuiteRunsInput) GoString

func (s ListSuiteRunsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSuiteRunsInput) SetMaxResults

func (s *ListSuiteRunsInput) SetMaxResults(v int64) *ListSuiteRunsInput

SetMaxResults sets the MaxResults field's value.

func (*ListSuiteRunsInput) SetNextToken

func (s *ListSuiteRunsInput) SetNextToken(v string) *ListSuiteRunsInput

SetNextToken sets the NextToken field's value.

func (*ListSuiteRunsInput) SetSuiteDefinitionId

func (s *ListSuiteRunsInput) SetSuiteDefinitionId(v string) *ListSuiteRunsInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*ListSuiteRunsInput) SetSuiteDefinitionVersion

func (s *ListSuiteRunsInput) SetSuiteDefinitionVersion(v string) *ListSuiteRunsInput

SetSuiteDefinitionVersion sets the SuiteDefinitionVersion field's value.

func (ListSuiteRunsInput) String

func (s ListSuiteRunsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSuiteRunsInput) Validate

func (s *ListSuiteRunsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListSuiteRunsOutput

type ListSuiteRunsOutput struct {

	// A token to retrieve the next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of objects that provide summaries of information about the suite
	// runs in the list.
	SuiteRunsList []*SuiteRunInformation `locationName:"suiteRunsList" type:"list"`
	// contains filtered or unexported fields
}

func (ListSuiteRunsOutput) GoString

func (s ListSuiteRunsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListSuiteRunsOutput) SetNextToken

func (s *ListSuiteRunsOutput) SetNextToken(v string) *ListSuiteRunsOutput

SetNextToken sets the NextToken field's value.

func (*ListSuiteRunsOutput) SetSuiteRunsList

func (s *ListSuiteRunsOutput) SetSuiteRunsList(v []*SuiteRunInformation) *ListSuiteRunsOutput

SetSuiteRunsList sets the SuiteRunsList field's value.

func (ListSuiteRunsOutput) String

func (s ListSuiteRunsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition
	// ARN or SuiteRun ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The tags attached to the IoT Device Advisor resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Sends a Resource Not Found Exception message.
	Message_ *string `locationName:"message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Sends a Resource Not Found exception.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartSuiteRunInput

type StartSuiteRunInput struct {

	// Suite definition ID of the test suite.
	//
	// SuiteDefinitionId is a required field
	SuiteDefinitionId *string `location:"uri" locationName:"suiteDefinitionId" min:"12" type:"string" required:"true"`

	// Suite definition version of the test suite.
	SuiteDefinitionVersion *string `locationName:"suiteDefinitionVersion" min:"2" type:"string"`

	// Suite run configuration.
	//
	// SuiteRunConfiguration is a required field
	SuiteRunConfiguration *SuiteRunConfiguration `locationName:"suiteRunConfiguration" type:"structure" required:"true"`

	// The tags to be attached to the suite run.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (StartSuiteRunInput) GoString

func (s StartSuiteRunInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSuiteRunInput) SetSuiteDefinitionId

func (s *StartSuiteRunInput) SetSuiteDefinitionId(v string) *StartSuiteRunInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*StartSuiteRunInput) SetSuiteDefinitionVersion

func (s *StartSuiteRunInput) SetSuiteDefinitionVersion(v string) *StartSuiteRunInput

SetSuiteDefinitionVersion sets the SuiteDefinitionVersion field's value.

func (*StartSuiteRunInput) SetSuiteRunConfiguration

func (s *StartSuiteRunInput) SetSuiteRunConfiguration(v *SuiteRunConfiguration) *StartSuiteRunInput

SetSuiteRunConfiguration sets the SuiteRunConfiguration field's value.

func (*StartSuiteRunInput) SetTags

func (s *StartSuiteRunInput) SetTags(v map[string]*string) *StartSuiteRunInput

SetTags sets the Tags field's value.

func (StartSuiteRunInput) String

func (s StartSuiteRunInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSuiteRunInput) Validate

func (s *StartSuiteRunInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartSuiteRunOutput

type StartSuiteRunOutput struct {

	// Starts a Device Advisor test suite run based on suite create time.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The response of an Device Advisor test endpoint.
	Endpoint *string `locationName:"endpoint" min:"45" type:"string"`

	// Amazon Resource Name (ARN) of the started suite run.
	SuiteRunArn *string `locationName:"suiteRunArn" min:"20" type:"string"`

	// Suite Run ID of the started suite run.
	SuiteRunId *string `locationName:"suiteRunId" min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (StartSuiteRunOutput) GoString

func (s StartSuiteRunOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartSuiteRunOutput) SetCreatedAt

func (s *StartSuiteRunOutput) SetCreatedAt(v time.Time) *StartSuiteRunOutput

SetCreatedAt sets the CreatedAt field's value.

func (*StartSuiteRunOutput) SetEndpoint

func (s *StartSuiteRunOutput) SetEndpoint(v string) *StartSuiteRunOutput

SetEndpoint sets the Endpoint field's value.

func (*StartSuiteRunOutput) SetSuiteRunArn

func (s *StartSuiteRunOutput) SetSuiteRunArn(v string) *StartSuiteRunOutput

SetSuiteRunArn sets the SuiteRunArn field's value.

func (*StartSuiteRunOutput) SetSuiteRunId

func (s *StartSuiteRunOutput) SetSuiteRunId(v string) *StartSuiteRunOutput

SetSuiteRunId sets the SuiteRunId field's value.

func (StartSuiteRunOutput) String

func (s StartSuiteRunOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopSuiteRunInput

type StopSuiteRunInput struct {

	// Suite definition ID of the test suite run to be stopped.
	//
	// SuiteDefinitionId is a required field
	SuiteDefinitionId *string `location:"uri" locationName:"suiteDefinitionId" min:"12" type:"string" required:"true"`

	// Suite run ID of the test suite run to be stopped.
	//
	// SuiteRunId is a required field
	SuiteRunId *string `location:"uri" locationName:"suiteRunId" min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopSuiteRunInput) GoString

func (s StopSuiteRunInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopSuiteRunInput) SetSuiteDefinitionId

func (s *StopSuiteRunInput) SetSuiteDefinitionId(v string) *StopSuiteRunInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*StopSuiteRunInput) SetSuiteRunId

func (s *StopSuiteRunInput) SetSuiteRunId(v string) *StopSuiteRunInput

SetSuiteRunId sets the SuiteRunId field's value.

func (StopSuiteRunInput) String

func (s StopSuiteRunInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopSuiteRunInput) Validate

func (s *StopSuiteRunInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopSuiteRunOutput

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

func (StopSuiteRunOutput) GoString

func (s StopSuiteRunOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopSuiteRunOutput) String

func (s StopSuiteRunOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuiteDefinitionConfiguration

type SuiteDefinitionConfiguration struct {

	// Gets the device permission ARN. This is a required parameter.
	//
	// DevicePermissionRoleArn is a required field
	DevicePermissionRoleArn *string `locationName:"devicePermissionRoleArn" min:"20" type:"string" required:"true"`

	// Gets the devices configured.
	Devices []*DeviceUnderTest `locationName:"devices" type:"list"`

	// Gets the tests intended for qualification in a suite.
	IntendedForQualification *bool `locationName:"intendedForQualification" type:"boolean"`

	// Verifies if the test suite is a long duration test.
	IsLongDurationTest *bool `locationName:"isLongDurationTest" type:"boolean"`

	// Sets the MQTT protocol that is configured in the suite definition.
	Protocol *string `locationName:"protocol" type:"string" enum:"Protocol"`

	// Gets the test suite root group. This is a required parameter. For updating
	// or creating the latest qualification suite, if intendedForQualification is
	// set to true, rootGroup can be an empty string. If intendedForQualification
	// is false, rootGroup cannot be an empty string. If rootGroup is empty, and
	// intendedForQualification is set to true, all the qualification tests are
	// included, and the configuration is default.
	//
	// For a qualification suite, the minimum length is 0, and the maximum is 2048.
	// For a non-qualification suite, the minimum length is 1, and the maximum is
	// 2048.
	//
	// RootGroup is a required field
	RootGroup *string `locationName:"rootGroup" type:"string" required:"true"`

	// Gets the suite definition name. This is a required parameter.
	//
	// SuiteDefinitionName is a required field
	SuiteDefinitionName *string `locationName:"suiteDefinitionName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Gets the suite definition configuration.

func (SuiteDefinitionConfiguration) GoString

func (s SuiteDefinitionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuiteDefinitionConfiguration) SetDevicePermissionRoleArn

func (s *SuiteDefinitionConfiguration) SetDevicePermissionRoleArn(v string) *SuiteDefinitionConfiguration

SetDevicePermissionRoleArn sets the DevicePermissionRoleArn field's value.

func (*SuiteDefinitionConfiguration) SetDevices

SetDevices sets the Devices field's value.

func (*SuiteDefinitionConfiguration) SetIntendedForQualification

func (s *SuiteDefinitionConfiguration) SetIntendedForQualification(v bool) *SuiteDefinitionConfiguration

SetIntendedForQualification sets the IntendedForQualification field's value.

func (*SuiteDefinitionConfiguration) SetIsLongDurationTest

func (s *SuiteDefinitionConfiguration) SetIsLongDurationTest(v bool) *SuiteDefinitionConfiguration

SetIsLongDurationTest sets the IsLongDurationTest field's value.

func (*SuiteDefinitionConfiguration) SetProtocol

SetProtocol sets the Protocol field's value.

func (*SuiteDefinitionConfiguration) SetRootGroup

SetRootGroup sets the RootGroup field's value.

func (*SuiteDefinitionConfiguration) SetSuiteDefinitionName

SetSuiteDefinitionName sets the SuiteDefinitionName field's value.

func (SuiteDefinitionConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuiteDefinitionConfiguration) Validate

func (s *SuiteDefinitionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SuiteDefinitionInformation

type SuiteDefinitionInformation struct {

	// Date (in Unix epoch time) when the test suite was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Specifies the devices that are under test for the test suite.
	DefaultDevices []*DeviceUnderTest `locationName:"defaultDevices" type:"list"`

	// Specifies if the test suite is intended for qualification.
	IntendedForQualification *bool `locationName:"intendedForQualification" type:"boolean"`

	// Verifies if the test suite is a long duration test.
	IsLongDurationTest *bool `locationName:"isLongDurationTest" type:"boolean"`

	// Gets the MQTT protocol that is configured in the suite definition.
	Protocol *string `locationName:"protocol" type:"string" enum:"Protocol"`

	// Suite definition ID of the test suite.
	SuiteDefinitionId *string `locationName:"suiteDefinitionId" min:"12" type:"string"`

	// Suite name of the test suite.
	SuiteDefinitionName *string `locationName:"suiteDefinitionName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about the suite definition.

func (SuiteDefinitionInformation) GoString

func (s SuiteDefinitionInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuiteDefinitionInformation) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*SuiteDefinitionInformation) SetDefaultDevices

SetDefaultDevices sets the DefaultDevices field's value.

func (*SuiteDefinitionInformation) SetIntendedForQualification

func (s *SuiteDefinitionInformation) SetIntendedForQualification(v bool) *SuiteDefinitionInformation

SetIntendedForQualification sets the IntendedForQualification field's value.

func (*SuiteDefinitionInformation) SetIsLongDurationTest

func (s *SuiteDefinitionInformation) SetIsLongDurationTest(v bool) *SuiteDefinitionInformation

SetIsLongDurationTest sets the IsLongDurationTest field's value.

func (*SuiteDefinitionInformation) SetProtocol

SetProtocol sets the Protocol field's value.

func (*SuiteDefinitionInformation) SetSuiteDefinitionId

func (s *SuiteDefinitionInformation) SetSuiteDefinitionId(v string) *SuiteDefinitionInformation

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*SuiteDefinitionInformation) SetSuiteDefinitionName

func (s *SuiteDefinitionInformation) SetSuiteDefinitionName(v string) *SuiteDefinitionInformation

SetSuiteDefinitionName sets the SuiteDefinitionName field's value.

func (SuiteDefinitionInformation) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SuiteRunConfiguration

type SuiteRunConfiguration struct {

	// TRUE if multiple test suites run in parallel.
	ParallelRun *bool `locationName:"parallelRun" type:"boolean"`

	// Sets the primary device for the test suite run. This requires a thing ARN
	// or a certificate ARN.
	//
	// PrimaryDevice is a required field
	PrimaryDevice *DeviceUnderTest `locationName:"primaryDevice" type:"structure" required:"true"`

	// Sets test case list.
	SelectedTestList []*string `locationName:"selectedTestList" type:"list"`
	// contains filtered or unexported fields
}

Gets suite run configuration.

func (SuiteRunConfiguration) GoString

func (s SuiteRunConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuiteRunConfiguration) SetParallelRun

func (s *SuiteRunConfiguration) SetParallelRun(v bool) *SuiteRunConfiguration

SetParallelRun sets the ParallelRun field's value.

func (*SuiteRunConfiguration) SetPrimaryDevice

SetPrimaryDevice sets the PrimaryDevice field's value.

func (*SuiteRunConfiguration) SetSelectedTestList

func (s *SuiteRunConfiguration) SetSelectedTestList(v []*string) *SuiteRunConfiguration

SetSelectedTestList sets the SelectedTestList field's value.

func (SuiteRunConfiguration) String

func (s SuiteRunConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuiteRunConfiguration) Validate

func (s *SuiteRunConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SuiteRunInformation

type SuiteRunInformation struct {

	// Date (in Unix epoch time) when the suite run was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Date (in Unix epoch time) when the suite run ended.
	EndAt *time.Time `locationName:"endAt" type:"timestamp"`

	// Number of test cases that failed in the suite run.
	Failed *int64 `locationName:"failed" type:"integer"`

	// Number of test cases that passed in the suite run.
	Passed *int64 `locationName:"passed" type:"integer"`

	// Date (in Unix epoch time) when the suite run was started.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp"`

	// Status of the suite run.
	Status *string `locationName:"status" type:"string" enum:"SuiteRunStatus"`

	// Suite definition ID of the suite run.
	SuiteDefinitionId *string `locationName:"suiteDefinitionId" min:"12" type:"string"`

	// Suite definition name of the suite run.
	SuiteDefinitionName *string `locationName:"suiteDefinitionName" min:"1" type:"string"`

	// Suite definition version of the suite run.
	SuiteDefinitionVersion *string `locationName:"suiteDefinitionVersion" min:"2" type:"string"`

	// Suite run ID of the suite run.
	SuiteRunId *string `locationName:"suiteRunId" min:"12" type:"string"`
	// contains filtered or unexported fields
}

Information about the suite run.

Requires permission to access the SuiteRunInformation (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

func (SuiteRunInformation) GoString

func (s SuiteRunInformation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SuiteRunInformation) SetCreatedAt

func (s *SuiteRunInformation) SetCreatedAt(v time.Time) *SuiteRunInformation

SetCreatedAt sets the CreatedAt field's value.

func (*SuiteRunInformation) SetEndAt

SetEndAt sets the EndAt field's value.

func (*SuiteRunInformation) SetFailed

SetFailed sets the Failed field's value.

func (*SuiteRunInformation) SetPassed

SetPassed sets the Passed field's value.

func (*SuiteRunInformation) SetStartedAt

func (s *SuiteRunInformation) SetStartedAt(v time.Time) *SuiteRunInformation

SetStartedAt sets the StartedAt field's value.

func (*SuiteRunInformation) SetStatus

SetStatus sets the Status field's value.

func (*SuiteRunInformation) SetSuiteDefinitionId

func (s *SuiteRunInformation) SetSuiteDefinitionId(v string) *SuiteRunInformation

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*SuiteRunInformation) SetSuiteDefinitionName

func (s *SuiteRunInformation) SetSuiteDefinitionName(v string) *SuiteRunInformation

SetSuiteDefinitionName sets the SuiteDefinitionName field's value.

func (*SuiteRunInformation) SetSuiteDefinitionVersion

func (s *SuiteRunInformation) SetSuiteDefinitionVersion(v string) *SuiteRunInformation

SetSuiteDefinitionVersion sets the SuiteDefinitionVersion field's value.

func (*SuiteRunInformation) SetSuiteRunId

func (s *SuiteRunInformation) SetSuiteRunId(v string) *SuiteRunInformation

SetSuiteRunId sets the SuiteRunId field's value.

func (SuiteRunInformation) String

func (s SuiteRunInformation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput

type TagResourceInput struct {

	// The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition
	// ARN or SuiteRun ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The tags to be attached to the IoT Device Advisor resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestCaseRun

type TestCaseRun struct {

	// Provides test case run end time.
	EndTime *time.Time `locationName:"endTime" type:"timestamp"`

	// Provides test case run failure result.
	Failure *string `locationName:"failure" type:"string"`

	// Provides test case run log URL.
	LogUrl *string `locationName:"logUrl" type:"string"`

	// Provides test case run start time.
	StartTime *time.Time `locationName:"startTime" type:"timestamp"`

	// Provides the test case run status. Status is one of the following:
	//
	//    * PASS: Test passed.
	//
	//    * FAIL: Test failed.
	//
	//    * PENDING: Test has not started running but is scheduled.
	//
	//    * RUNNING: Test is running.
	//
	//    * STOPPING: Test is performing cleanup steps. You will see this status
	//    only if you stop a suite run.
	//
	//    * STOPPED Test is stopped. You will see this status only if you stop a
	//    suite run.
	//
	//    * PASS_WITH_WARNINGS: Test passed with warnings.
	//
	//    * ERORR: Test faced an error when running due to an internal issue.
	Status *string `locationName:"status" type:"string" enum:"Status"`

	// Provides the test case run definition ID.
	TestCaseDefinitionId *string `locationName:"testCaseDefinitionId" min:"12" type:"string"`

	// Provides the test case run definition name.
	TestCaseDefinitionName *string `locationName:"testCaseDefinitionName" type:"string"`

	// Provides the test case run ID.
	TestCaseRunId *string `locationName:"testCaseRunId" min:"12" type:"string"`

	// Provides the test scenarios for the test case run.
	TestScenarios []*TestCaseScenario `locationName:"testScenarios" type:"list"`

	// Provides test case run warnings.
	Warnings *string `locationName:"warnings" type:"string"`
	// contains filtered or unexported fields
}

Provides the test case run.

func (TestCaseRun) GoString

func (s TestCaseRun) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestCaseRun) SetEndTime

func (s *TestCaseRun) SetEndTime(v time.Time) *TestCaseRun

SetEndTime sets the EndTime field's value.

func (*TestCaseRun) SetFailure

func (s *TestCaseRun) SetFailure(v string) *TestCaseRun

SetFailure sets the Failure field's value.

func (*TestCaseRun) SetLogUrl

func (s *TestCaseRun) SetLogUrl(v string) *TestCaseRun

SetLogUrl sets the LogUrl field's value.

func (*TestCaseRun) SetStartTime

func (s *TestCaseRun) SetStartTime(v time.Time) *TestCaseRun

SetStartTime sets the StartTime field's value.

func (*TestCaseRun) SetStatus

func (s *TestCaseRun) SetStatus(v string) *TestCaseRun

SetStatus sets the Status field's value.

func (*TestCaseRun) SetTestCaseDefinitionId

func (s *TestCaseRun) SetTestCaseDefinitionId(v string) *TestCaseRun

SetTestCaseDefinitionId sets the TestCaseDefinitionId field's value.

func (*TestCaseRun) SetTestCaseDefinitionName

func (s *TestCaseRun) SetTestCaseDefinitionName(v string) *TestCaseRun

SetTestCaseDefinitionName sets the TestCaseDefinitionName field's value.

func (*TestCaseRun) SetTestCaseRunId

func (s *TestCaseRun) SetTestCaseRunId(v string) *TestCaseRun

SetTestCaseRunId sets the TestCaseRunId field's value.

func (*TestCaseRun) SetTestScenarios

func (s *TestCaseRun) SetTestScenarios(v []*TestCaseScenario) *TestCaseRun

SetTestScenarios sets the TestScenarios field's value.

func (*TestCaseRun) SetWarnings

func (s *TestCaseRun) SetWarnings(v string) *TestCaseRun

SetWarnings sets the Warnings field's value.

func (TestCaseRun) String

func (s TestCaseRun) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestCaseScenario

type TestCaseScenario struct {

	// Provides test case scenario failure result.
	Failure *string `locationName:"failure" type:"string"`

	// Provides the test case scenario status. Status is one of the following:
	//
	//    * PASS: Test passed.
	//
	//    * FAIL: Test failed.
	//
	//    * PENDING: Test has not started running but is scheduled.
	//
	//    * RUNNING: Test is running.
	//
	//    * STOPPING: Test is performing cleanup steps. You will see this status
	//    only if you stop a suite run.
	//
	//    * STOPPED Test is stopped. You will see this status only if you stop a
	//    suite run.
	//
	//    * PASS_WITH_WARNINGS: Test passed with warnings.
	//
	//    * ERORR: Test faced an error when running due to an internal issue.
	Status *string `locationName:"status" type:"string" enum:"TestCaseScenarioStatus"`

	// Provides test case scenario system messages if any.
	SystemMessage *string `locationName:"systemMessage" type:"string"`

	// Provides test case scenario ID.
	TestCaseScenarioId *string `locationName:"testCaseScenarioId" type:"string"`

	// Provides test case scenario type. Type is one of the following:
	//
	//    * Advanced
	//
	//    * Basic
	TestCaseScenarioType *string `locationName:"testCaseScenarioType" type:"string" enum:"TestCaseScenarioType"`
	// contains filtered or unexported fields
}

Provides test case scenario.

func (TestCaseScenario) GoString

func (s TestCaseScenario) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestCaseScenario) SetFailure

func (s *TestCaseScenario) SetFailure(v string) *TestCaseScenario

SetFailure sets the Failure field's value.

func (*TestCaseScenario) SetStatus

func (s *TestCaseScenario) SetStatus(v string) *TestCaseScenario

SetStatus sets the Status field's value.

func (*TestCaseScenario) SetSystemMessage

func (s *TestCaseScenario) SetSystemMessage(v string) *TestCaseScenario

SetSystemMessage sets the SystemMessage field's value.

func (*TestCaseScenario) SetTestCaseScenarioId

func (s *TestCaseScenario) SetTestCaseScenarioId(v string) *TestCaseScenario

SetTestCaseScenarioId sets the TestCaseScenarioId field's value.

func (*TestCaseScenario) SetTestCaseScenarioType

func (s *TestCaseScenario) SetTestCaseScenarioType(v string) *TestCaseScenario

SetTestCaseScenarioType sets the TestCaseScenarioType field's value.

func (TestCaseScenario) String

func (s TestCaseScenario) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TestResult

type TestResult struct {

	// Show each group of test results.
	Groups []*GroupResult `locationName:"groups" type:"list"`
	// contains filtered or unexported fields
}

Show each group result.

func (TestResult) GoString

func (s TestResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestResult) SetGroups

func (s *TestResult) SetGroups(v []*GroupResult) *TestResult

SetGroups sets the Groups field's value.

func (TestResult) String

func (s TestResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition
	// ARN or SuiteRun ARN.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// List of tag keys to remove from the IoT Device Advisor resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSuiteDefinitionInput

type UpdateSuiteDefinitionInput struct {

	// Updates a Device Advisor test suite with suite definition configuration.
	//
	// SuiteDefinitionConfiguration is a required field
	SuiteDefinitionConfiguration *SuiteDefinitionConfiguration `locationName:"suiteDefinitionConfiguration" type:"structure" required:"true"`

	// Suite definition ID of the test suite to be updated.
	//
	// SuiteDefinitionId is a required field
	SuiteDefinitionId *string `location:"uri" locationName:"suiteDefinitionId" min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSuiteDefinitionInput) GoString

func (s UpdateSuiteDefinitionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSuiteDefinitionInput) SetSuiteDefinitionConfiguration

SetSuiteDefinitionConfiguration sets the SuiteDefinitionConfiguration field's value.

func (*UpdateSuiteDefinitionInput) SetSuiteDefinitionId

func (s *UpdateSuiteDefinitionInput) SetSuiteDefinitionId(v string) *UpdateSuiteDefinitionInput

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (UpdateSuiteDefinitionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSuiteDefinitionInput) Validate

func (s *UpdateSuiteDefinitionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSuiteDefinitionOutput

type UpdateSuiteDefinitionOutput struct {

	// Timestamp of when the test suite was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// Timestamp of when the test suite was updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// Amazon Resource Name (ARN) of the updated test suite.
	SuiteDefinitionArn *string `locationName:"suiteDefinitionArn" min:"20" type:"string"`

	// Suite definition ID of the updated test suite.
	SuiteDefinitionId *string `locationName:"suiteDefinitionId" min:"12" type:"string"`

	// Updates the suite definition name. This is a required parameter.
	SuiteDefinitionName *string `locationName:"suiteDefinitionName" min:"1" type:"string"`

	// Suite definition version of the updated test suite.
	SuiteDefinitionVersion *string `locationName:"suiteDefinitionVersion" min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSuiteDefinitionOutput) GoString

func (s UpdateSuiteDefinitionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSuiteDefinitionOutput) SetCreatedAt

SetCreatedAt sets the CreatedAt field's value.

func (*UpdateSuiteDefinitionOutput) SetLastUpdatedAt

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*UpdateSuiteDefinitionOutput) SetSuiteDefinitionArn

func (s *UpdateSuiteDefinitionOutput) SetSuiteDefinitionArn(v string) *UpdateSuiteDefinitionOutput

SetSuiteDefinitionArn sets the SuiteDefinitionArn field's value.

func (*UpdateSuiteDefinitionOutput) SetSuiteDefinitionId

SetSuiteDefinitionId sets the SuiteDefinitionId field's value.

func (*UpdateSuiteDefinitionOutput) SetSuiteDefinitionName

func (s *UpdateSuiteDefinitionOutput) SetSuiteDefinitionName(v string) *UpdateSuiteDefinitionOutput

SetSuiteDefinitionName sets the SuiteDefinitionName field's value.

func (*UpdateSuiteDefinitionOutput) SetSuiteDefinitionVersion

func (s *UpdateSuiteDefinitionOutput) SetSuiteDefinitionVersion(v string) *UpdateSuiteDefinitionOutput

SetSuiteDefinitionVersion sets the SuiteDefinitionVersion field's value.

func (UpdateSuiteDefinitionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Sends a Validation Exception message.
	Message_ *string `locationName:"message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Sends a validation exception.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package iotdeviceadvisoriface provides an interface to enable mocking the AWS IoT Core Device Advisor service client for testing your code.
Package iotdeviceadvisoriface provides an interface to enable mocking the AWS IoT Core Device Advisor service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL