types

package
v1.26.4 Latest Latest
Warning

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

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthenticationMethod added in v1.18.0 

type AuthenticationMethod string
const (
	AuthenticationMethodX509ClientCertificate AuthenticationMethod = "X509ClientCertificate"
	AuthenticationMethodSignatureVersion4     AuthenticationMethod = "SignatureVersion4"
)

Enum values for AuthenticationMethod

func (AuthenticationMethod) Values added in v1.18.0 

func (AuthenticationMethod) Values() []AuthenticationMethod

Values returns all known values for AuthenticationMethod. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Sends a Conflict Exception.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type DeviceUnderTest 

type DeviceUnderTest struct {

	// Lists device's certificate ARN.
	CertificateArn *string

	// Lists device's role ARN.
	DeviceRoleArn *string

	// Lists device's thing ARN.
	ThingArn *string
	// contains filtered or unexported fields
}

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

type GroupResult 

type GroupResult struct {

	// Group result ID.
	GroupId *string

	// Group Result Name.
	GroupName *string

	// Tests under Group Result.
	Tests []TestCaseRun
	// contains filtered or unexported fields
}

Show Group Result.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Sends an Internal Failure exception.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type Protocol added in v1.15.0 

type Protocol string
const (
	ProtocolMqttV311              Protocol = "MqttV3_1_1"
	ProtocolMqttV5                Protocol = "MqttV5"
	ProtocolMqttV311OverWebSocket Protocol = "MqttV3_1_1_OverWebSocket"
	ProtocolMqttV5OverWebSocket   Protocol = "MqttV5_OverWebSocket"
)

Enum values for Protocol

func (Protocol) Values added in v1.15.0 

func (Protocol) Values() []Protocol

Values returns all known values for Protocol. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Sends a Resource Not Found exception.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type Status 

type Status string
const (
	StatusPass             Status = "PASS"
	StatusFail             Status = "FAIL"
	StatusCanceled         Status = "CANCELED"
	StatusPending          Status = "PENDING"
	StatusRunning          Status = "RUNNING"
	StatusStopping         Status = "STOPPING"
	StatusStopped          Status = "STOPPED"
	StatusPassWithWarnings Status = "PASS_WITH_WARNINGS"
	StatusError            Status = "ERROR"
)

Enum values for Status

func (Status) Values 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SuiteDefinitionConfiguration 

type SuiteDefinitionConfiguration struct {

	// Gets the device permission ARN. This is a required parameter.
	//
	// This member is required.
	DevicePermissionRoleArn *string

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

	// Gets the suite definition name. This is a required parameter.
	//
	// This member is required.
	SuiteDefinitionName *string

	// Gets the devices configured.
	Devices []DeviceUnderTest

	// Gets the tests intended for qualification in a suite.
	IntendedForQualification *bool

	// Verifies if the test suite is a long duration test.
	IsLongDurationTest *bool

	// Sets the MQTT protocol that is configured in the suite definition.
	Protocol Protocol
	// contains filtered or unexported fields
}

Gets the suite definition configuration.

type SuiteDefinitionInformation 

type SuiteDefinitionInformation struct {

	// Date (in Unix epoch time) when the test suite was created.
	CreatedAt *time.Time

	// Specifies the devices that are under test for the test suite.
	DefaultDevices []DeviceUnderTest

	// Specifies if the test suite is intended for qualification.
	IntendedForQualification *bool

	// Verifies if the test suite is a long duration test.
	IsLongDurationTest *bool

	// Gets the MQTT protocol that is configured in the suite definition.
	Protocol Protocol

	// Suite definition ID of the test suite.
	SuiteDefinitionId *string

	// Suite name of the test suite.
	SuiteDefinitionName *string
	// contains filtered or unexported fields
}

Information about the suite definition.

type SuiteRunConfiguration 

type SuiteRunConfiguration struct {

	// Sets the primary device for the test suite run. This requires a thing ARN or a
	// certificate ARN.
	//
	// This member is required.
	PrimaryDevice *DeviceUnderTest

	// TRUE if multiple test suites run in parallel.
	ParallelRun *bool

	// Sets test case list.
	SelectedTestList []string
	// contains filtered or unexported fields
}

Gets suite run configuration.

type SuiteRunInformation 

type SuiteRunInformation struct {

	// Date (in Unix epoch time) when the suite run was created.
	CreatedAt *time.Time

	// Date (in Unix epoch time) when the suite run ended.
	EndAt *time.Time

	// Number of test cases that failed in the suite run.
	Failed *int32

	// Number of test cases that passed in the suite run.
	Passed *int32

	// Date (in Unix epoch time) when the suite run was started.
	StartedAt *time.Time

	// Status of the suite run.
	Status SuiteRunStatus

	// Suite definition ID of the suite run.
	SuiteDefinitionId *string

	// Suite definition name of the suite run.
	SuiteDefinitionName *string

	// Suite definition version of the suite run.
	SuiteDefinitionVersion *string

	// Suite run ID of the suite run.
	SuiteRunId *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.

type SuiteRunStatus 

type SuiteRunStatus string
const (
	SuiteRunStatusPass             SuiteRunStatus = "PASS"
	SuiteRunStatusFail             SuiteRunStatus = "FAIL"
	SuiteRunStatusCanceled         SuiteRunStatus = "CANCELED"
	SuiteRunStatusPending          SuiteRunStatus = "PENDING"
	SuiteRunStatusRunning          SuiteRunStatus = "RUNNING"
	SuiteRunStatusStopping         SuiteRunStatus = "STOPPING"
	SuiteRunStatusStopped          SuiteRunStatus = "STOPPED"
	SuiteRunStatusPassWithWarnings SuiteRunStatus = "PASS_WITH_WARNINGS"
	SuiteRunStatusError            SuiteRunStatus = "ERROR"
)

Enum values for SuiteRunStatus

func (SuiteRunStatus) Values 

func (SuiteRunStatus) Values() []SuiteRunStatus

Values returns all known values for SuiteRunStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestCaseRun 

type TestCaseRun struct {

	// Provides test case run end time.
	EndTime *time.Time

	// Provides test case run failure result.
	Failure *string

	// Provides test case run log URL.
	LogUrl *string

	// Provides test case run start time.
	StartTime *time.Time

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

	// Provides the test case run definition ID.
	TestCaseDefinitionId *string

	// Provides the test case run definition name.
	TestCaseDefinitionName *string

	// Provides the test case run ID.
	TestCaseRunId *string

	// Provides the test scenarios for the test case run.
	TestScenarios []TestCaseScenario

	// Provides test case run warnings.
	Warnings *string
	// contains filtered or unexported fields
}

Provides the test case run.

type TestCaseScenario added in v1.15.0 

type TestCaseScenario struct {

	// Provides test case scenario failure result.
	Failure *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 TestCaseScenarioStatus

	// Provides test case scenario system messages if any.
	SystemMessage *string

	// Provides test case scenario ID.
	TestCaseScenarioId *string

	// Provides test case scenario type. Type is one of the following:
	//   - Advanced
	//   - Basic
	TestCaseScenarioType TestCaseScenarioType
	// contains filtered or unexported fields
}

Provides test case scenario.

type TestCaseScenarioStatus added in v1.15.0 

type TestCaseScenarioStatus string
const (
	TestCaseScenarioStatusPass             TestCaseScenarioStatus = "PASS"
	TestCaseScenarioStatusFail             TestCaseScenarioStatus = "FAIL"
	TestCaseScenarioStatusCanceled         TestCaseScenarioStatus = "CANCELED"
	TestCaseScenarioStatusPending          TestCaseScenarioStatus = "PENDING"
	TestCaseScenarioStatusRunning          TestCaseScenarioStatus = "RUNNING"
	TestCaseScenarioStatusStopping         TestCaseScenarioStatus = "STOPPING"
	TestCaseScenarioStatusStopped          TestCaseScenarioStatus = "STOPPED"
	TestCaseScenarioStatusPassWithWarnings TestCaseScenarioStatus = "PASS_WITH_WARNINGS"
	TestCaseScenarioStatusError            TestCaseScenarioStatus = "ERROR"
)

Enum values for TestCaseScenarioStatus

func (TestCaseScenarioStatus) Values added in v1.15.0 

func (TestCaseScenarioStatus) Values() []TestCaseScenarioStatus

Values returns all known values for TestCaseScenarioStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestCaseScenarioType added in v1.15.0 

type TestCaseScenarioType string
const (
	TestCaseScenarioTypeAdvanced TestCaseScenarioType = "Advanced"
	TestCaseScenarioTypeBasic    TestCaseScenarioType = "Basic"
)

Enum values for TestCaseScenarioType

func (TestCaseScenarioType) Values added in v1.15.0 

func (TestCaseScenarioType) Values() []TestCaseScenarioType

Values returns all known values for TestCaseScenarioType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TestResult 

type TestResult struct {

	// Show each group of test results.
	Groups []GroupResult
	// contains filtered or unexported fields
}

Show each group result.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Sends a validation exception.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.