serverless-offline-msk
Version:
A serverless offline plugin that enables AWS MSK events
725 lines (724 loc) • 27.8 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class IotDeviceAdvisor extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: IotDeviceAdvisor.Types.ClientConfiguration)
config: Config & IotDeviceAdvisor.Types.ClientConfiguration;
/**
* Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.
*/
createSuiteDefinition(params: IotDeviceAdvisor.Types.CreateSuiteDefinitionRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.CreateSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.CreateSuiteDefinitionResponse, AWSError>;
/**
* Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.
*/
createSuiteDefinition(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.CreateSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.CreateSuiteDefinitionResponse, AWSError>;
/**
* Deletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.
*/
deleteSuiteDefinition(params: IotDeviceAdvisor.Types.DeleteSuiteDefinitionRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.DeleteSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.DeleteSuiteDefinitionResponse, AWSError>;
/**
* Deletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.
*/
deleteSuiteDefinition(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.DeleteSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.DeleteSuiteDefinitionResponse, AWSError>;
/**
* Gets information about an Device Advisor endpoint.
*/
getEndpoint(params: IotDeviceAdvisor.Types.GetEndpointRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetEndpointResponse) => void): Request<IotDeviceAdvisor.Types.GetEndpointResponse, AWSError>;
/**
* Gets information about an Device Advisor endpoint.
*/
getEndpoint(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetEndpointResponse) => void): Request<IotDeviceAdvisor.Types.GetEndpointResponse, AWSError>;
/**
* Gets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action.
*/
getSuiteDefinition(params: IotDeviceAdvisor.Types.GetSuiteDefinitionRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.GetSuiteDefinitionResponse, AWSError>;
/**
* Gets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action.
*/
getSuiteDefinition(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.GetSuiteDefinitionResponse, AWSError>;
/**
* Gets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.
*/
getSuiteRun(params: IotDeviceAdvisor.Types.GetSuiteRunRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetSuiteRunResponse) => void): Request<IotDeviceAdvisor.Types.GetSuiteRunResponse, AWSError>;
/**
* Gets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.
*/
getSuiteRun(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetSuiteRunResponse) => void): Request<IotDeviceAdvisor.Types.GetSuiteRunResponse, AWSError>;
/**
* Gets a report download link for a successful Device Advisor qualifying test suite run. Requires permission to access the GetSuiteRunReport action.
*/
getSuiteRunReport(params: IotDeviceAdvisor.Types.GetSuiteRunReportRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetSuiteRunReportResponse) => void): Request<IotDeviceAdvisor.Types.GetSuiteRunReportResponse, AWSError>;
/**
* Gets a report download link for a successful Device Advisor qualifying test suite run. Requires permission to access the GetSuiteRunReport action.
*/
getSuiteRunReport(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.GetSuiteRunReportResponse) => void): Request<IotDeviceAdvisor.Types.GetSuiteRunReportResponse, AWSError>;
/**
* Lists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.
*/
listSuiteDefinitions(params: IotDeviceAdvisor.Types.ListSuiteDefinitionsRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.ListSuiteDefinitionsResponse) => void): Request<IotDeviceAdvisor.Types.ListSuiteDefinitionsResponse, AWSError>;
/**
* Lists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.
*/
listSuiteDefinitions(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.ListSuiteDefinitionsResponse) => void): Request<IotDeviceAdvisor.Types.ListSuiteDefinitionsResponse, AWSError>;
/**
* 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 action.
*/
listSuiteRuns(params: IotDeviceAdvisor.Types.ListSuiteRunsRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.ListSuiteRunsResponse) => void): Request<IotDeviceAdvisor.Types.ListSuiteRunsResponse, AWSError>;
/**
* 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 action.
*/
listSuiteRuns(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.ListSuiteRunsResponse) => void): Request<IotDeviceAdvisor.Types.ListSuiteRunsResponse, AWSError>;
/**
* Lists the tags attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action.
*/
listTagsForResource(params: IotDeviceAdvisor.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.ListTagsForResourceResponse) => void): Request<IotDeviceAdvisor.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action.
*/
listTagsForResource(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.ListTagsForResourceResponse) => void): Request<IotDeviceAdvisor.Types.ListTagsForResourceResponse, AWSError>;
/**
* Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.
*/
startSuiteRun(params: IotDeviceAdvisor.Types.StartSuiteRunRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.StartSuiteRunResponse) => void): Request<IotDeviceAdvisor.Types.StartSuiteRunResponse, AWSError>;
/**
* Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.
*/
startSuiteRun(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.StartSuiteRunResponse) => void): Request<IotDeviceAdvisor.Types.StartSuiteRunResponse, AWSError>;
/**
* Stops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.
*/
stopSuiteRun(params: IotDeviceAdvisor.Types.StopSuiteRunRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.StopSuiteRunResponse) => void): Request<IotDeviceAdvisor.Types.StopSuiteRunResponse, AWSError>;
/**
* Stops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.
*/
stopSuiteRun(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.StopSuiteRunResponse) => void): Request<IotDeviceAdvisor.Types.StopSuiteRunResponse, AWSError>;
/**
* Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action.
*/
tagResource(params: IotDeviceAdvisor.Types.TagResourceRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.TagResourceResponse) => void): Request<IotDeviceAdvisor.Types.TagResourceResponse, AWSError>;
/**
* Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action.
*/
tagResource(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.TagResourceResponse) => void): Request<IotDeviceAdvisor.Types.TagResourceResponse, AWSError>;
/**
* Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.
*/
untagResource(params: IotDeviceAdvisor.Types.UntagResourceRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.UntagResourceResponse) => void): Request<IotDeviceAdvisor.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.
*/
untagResource(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.UntagResourceResponse) => void): Request<IotDeviceAdvisor.Types.UntagResourceResponse, AWSError>;
/**
* Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.
*/
updateSuiteDefinition(params: IotDeviceAdvisor.Types.UpdateSuiteDefinitionRequest, callback?: (err: AWSError, data: IotDeviceAdvisor.Types.UpdateSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.UpdateSuiteDefinitionResponse, AWSError>;
/**
* Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.
*/
updateSuiteDefinition(callback?: (err: AWSError, data: IotDeviceAdvisor.Types.UpdateSuiteDefinitionResponse) => void): Request<IotDeviceAdvisor.Types.UpdateSuiteDefinitionResponse, AWSError>;
}
declare namespace IotDeviceAdvisor {
export type AmazonResourceName = string;
export interface CreateSuiteDefinitionRequest {
/**
* Creates a Device Advisor test suite with suite definition configuration.
*/
suiteDefinitionConfiguration?: SuiteDefinitionConfiguration;
/**
* The tags to be attached to the suite definition.
*/
tags?: TagMap;
}
export interface CreateSuiteDefinitionResponse {
/**
* Creates a Device Advisor test suite with suite UUID.
*/
suiteDefinitionId?: UUID;
/**
* Creates a Device Advisor test suite with Amazon Resource Name (ARN).
*/
suiteDefinitionArn?: AmazonResourceName;
/**
* Creates a Device Advisor test suite with suite definition name.
*/
suiteDefinitionName?: SuiteDefinitionName;
/**
* Creates a Device Advisor test suite with TimeStamp of when it was created.
*/
createdAt?: Timestamp;
}
export interface DeleteSuiteDefinitionRequest {
/**
* Suite definition ID of the test suite to be deleted.
*/
suiteDefinitionId: UUID;
}
export interface DeleteSuiteDefinitionResponse {
}
export interface DeviceUnderTest {
/**
* Lists devices thing ARN.
*/
thingArn?: AmazonResourceName;
/**
* Lists devices certificate ARN.
*/
certificateArn?: AmazonResourceName;
}
export type DeviceUnderTestList = DeviceUnderTest[];
export type Endpoint = string;
export type ErrorReason = string;
export type Failure = string;
export interface GetEndpointRequest {
/**
* The thing ARN of the device. This is an optional parameter.
*/
thingArn?: AmazonResourceName;
/**
* The certificate ARN of the device. This is an optional parameter.
*/
certificateArn?: AmazonResourceName;
}
export interface GetEndpointResponse {
/**
* The response of an Device Advisor endpoint.
*/
endpoint?: Endpoint;
}
export interface GetSuiteDefinitionRequest {
/**
* Suite definition ID of the test suite to get.
*/
suiteDefinitionId: UUID;
/**
* Suite definition version of the test suite to get.
*/
suiteDefinitionVersion?: SuiteDefinitionVersion;
}
export interface GetSuiteDefinitionResponse {
/**
* Suite definition ID of the suite definition.
*/
suiteDefinitionId?: UUID;
/**
* The ARN of the suite definition.
*/
suiteDefinitionArn?: AmazonResourceName;
/**
* Suite definition version of the suite definition.
*/
suiteDefinitionVersion?: SuiteDefinitionVersion;
/**
* Latest suite definition version of the suite definition.
*/
latestVersion?: SuiteDefinitionVersion;
/**
* Suite configuration of the suite definition.
*/
suiteDefinitionConfiguration?: SuiteDefinitionConfiguration;
/**
* Date (in Unix epoch time) when the suite definition was created.
*/
createdAt?: Timestamp;
/**
* Date (in Unix epoch time) when the suite definition was last modified.
*/
lastModifiedAt?: Timestamp;
/**
* Tags attached to the suite definition.
*/
tags?: TagMap;
}
export interface GetSuiteRunReportRequest {
/**
* Suite definition ID of the test suite.
*/
suiteDefinitionId: UUID;
/**
* Suite run ID of the test suite run.
*/
suiteRunId: UUID;
}
export interface GetSuiteRunReportResponse {
/**
* Download URL of the qualification report.
*/
qualificationReportDownloadUrl?: QualificationReportDownloadUrl;
}
export interface GetSuiteRunRequest {
/**
* Suite definition ID for the test suite run.
*/
suiteDefinitionId: UUID;
/**
* Suite run ID for the test suite run.
*/
suiteRunId: UUID;
}
export interface GetSuiteRunResponse {
/**
* Suite definition ID for the test suite run.
*/
suiteDefinitionId?: UUID;
/**
* Suite definition version for the test suite run.
*/
suiteDefinitionVersion?: SuiteDefinitionVersion;
/**
* Suite run ID for the test suite run.
*/
suiteRunId?: UUID;
/**
* The ARN of the suite run.
*/
suiteRunArn?: AmazonResourceName;
/**
* Suite run configuration for the test suite run.
*/
suiteRunConfiguration?: SuiteRunConfiguration;
/**
* Test results for the test suite run.
*/
testResult?: TestResult;
/**
* Date (in Unix epoch time) when the test suite run started.
*/
startTime?: Timestamp;
/**
* Date (in Unix epoch time) when the test suite run ended.
*/
endTime?: Timestamp;
/**
* Status for the test suite run.
*/
status?: SuiteRunStatus;
/**
* Error reason for any test suite run failure.
*/
errorReason?: ErrorReason;
/**
* The tags attached to the suite run.
*/
tags?: TagMap;
}
export type GroupName = string;
export interface GroupResult {
/**
* Group result ID.
*/
groupId?: UUID;
/**
* Group Result Name.
*/
groupName?: GroupName;
/**
* Tests under Group Result.
*/
tests?: TestCaseRuns;
}
export type GroupResultList = GroupResult[];
export type IntendedForQualificationBoolean = boolean;
export type IsLongDurationTestBoolean = boolean;
export interface ListSuiteDefinitionsRequest {
/**
* The maximum number of results to return at once.
*/
maxResults?: MaxResults;
/**
* A token used to get the next set of results.
*/
nextToken?: Token;
}
export interface ListSuiteDefinitionsResponse {
/**
* An array of objects that provide summaries of information about the suite definitions in the list.
*/
suiteDefinitionInformationList?: SuiteDefinitionInformationList;
/**
* A token used to get the next set of results.
*/
nextToken?: Token;
}
export interface ListSuiteRunsRequest {
/**
* Lists the test suite runs of the specified test suite based on suite definition ID.
*/
suiteDefinitionId?: UUID;
/**
* Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.
*/
suiteDefinitionVersion?: SuiteDefinitionVersion;
/**
* The maximum number of results to return at once.
*/
maxResults?: MaxResults;
/**
* A token to retrieve the next set of results.
*/
nextToken?: Token;
}
export interface ListSuiteRunsResponse {
/**
* An array of objects that provide summaries of information about the suite runs in the list.
*/
suiteRunsList?: SuiteRunsList;
/**
* A token to retrieve the next set of results.
*/
nextToken?: Token;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the IoT Device Advisor resource.
*/
resourceArn: AmazonResourceName;
}
export interface ListTagsForResourceResponse {
/**
* The tags attached to the IoT Device Advisor resource.
*/
tags?: TagMap;
}
export type LogUrl = string;
export type MaxResults = number;
export type ParallelRun = boolean;
export type Protocol = "MqttV3_1_1"|"MqttV5"|string;
export type QualificationReportDownloadUrl = string;
export type RootGroup = string;
export type SelectedTestList = UUID[];
export interface StartSuiteRunRequest {
/**
* Suite definition ID of the test suite.
*/
suiteDefinitionId: UUID;
/**
* Suite definition version of the test suite.
*/
suiteDefinitionVersion?: SuiteDefinitionVersion;
/**
* Suite run configuration.
*/
suiteRunConfiguration?: SuiteRunConfiguration;
/**
* The tags to be attached to the suite run.
*/
tags?: TagMap;
}
export interface StartSuiteRunResponse {
/**
* Suite Run ID of the started suite run.
*/
suiteRunId?: UUID;
/**
* Amazon Resource Name (ARN) of the started suite run.
*/
suiteRunArn?: AmazonResourceName;
/**
* Starts a Device Advisor test suite run based on suite create time.
*/
createdAt?: Timestamp;
}
export type Status = "PASS"|"FAIL"|"CANCELED"|"PENDING"|"RUNNING"|"STOPPING"|"STOPPED"|"PASS_WITH_WARNINGS"|"ERROR"|string;
export interface StopSuiteRunRequest {
/**
* Suite definition ID of the test suite run to be stopped.
*/
suiteDefinitionId: UUID;
/**
* Suite run ID of the test suite run to be stopped.
*/
suiteRunId: UUID;
}
export interface StopSuiteRunResponse {
}
export type String128 = string;
export type String256 = string;
export interface SuiteDefinitionConfiguration {
/**
* Gets Suite Definition Configuration name.
*/
suiteDefinitionName?: SuiteDefinitionName;
/**
* Gets the devices configured.
*/
devices?: DeviceUnderTestList;
/**
* Gets the tests intended for qualification in a suite.
*/
intendedForQualification?: IntendedForQualificationBoolean;
/**
* Verifies if the test suite is a long duration test.
*/
isLongDurationTest?: IsLongDurationTestBoolean;
/**
* Gets test suite root group.
*/
rootGroup?: RootGroup;
/**
* Gets the device permission ARN.
*/
devicePermissionRoleArn?: AmazonResourceName;
/**
* Gets the MQTT protocol that is configured in the suite definition.
*/
protocol?: Protocol;
}
export interface SuiteDefinitionInformation {
/**
* Suite definition ID of the test suite.
*/
suiteDefinitionId?: UUID;
/**
* Suite name of the test suite.
*/
suiteDefinitionName?: SuiteDefinitionName;
/**
* Specifies the devices that are under test for the test suite.
*/
defaultDevices?: DeviceUnderTestList;
/**
* Specifies if the test suite is intended for qualification.
*/
intendedForQualification?: IntendedForQualificationBoolean;
/**
* Verifies if the test suite is a long duration test.
*/
isLongDurationTest?: IsLongDurationTestBoolean;
/**
* Gets the MQTT protocol that is configured in the suite definition.
*/
protocol?: Protocol;
/**
* Date (in Unix epoch time) when the test suite was created.
*/
createdAt?: Timestamp;
}
export type SuiteDefinitionInformationList = SuiteDefinitionInformation[];
export type SuiteDefinitionName = string;
export type SuiteDefinitionVersion = string;
export interface SuiteRunConfiguration {
/**
* Gets the primary device for suite run.
*/
primaryDevice?: DeviceUnderTest;
/**
* Gets test case list.
*/
selectedTestList?: SelectedTestList;
/**
* TRUE if multiple test suites run in parallel.
*/
parallelRun?: ParallelRun;
}
export interface SuiteRunInformation {
/**
* Suite definition ID of the suite run.
*/
suiteDefinitionId?: UUID;
/**
* Suite definition version of the suite run.
*/
suiteDefinitionVersion?: SuiteDefinitionVersion;
/**
* Suite definition name of the suite run.
*/
suiteDefinitionName?: SuiteDefinitionName;
/**
* Suite run ID of the suite run.
*/
suiteRunId?: UUID;
/**
* Date (in Unix epoch time) when the suite run was created.
*/
createdAt?: Timestamp;
/**
* Date (in Unix epoch time) when the suite run was started.
*/
startedAt?: Timestamp;
/**
* Date (in Unix epoch time) when the suite run ended.
*/
endAt?: Timestamp;
/**
* Status of the suite run.
*/
status?: SuiteRunStatus;
/**
* Number of test cases that passed in the suite run.
*/
passed?: SuiteRunResultCount;
/**
* Number of test cases that failed in the suite run.
*/
failed?: SuiteRunResultCount;
}
export type SuiteRunResultCount = number;
export type SuiteRunStatus = "PASS"|"FAIL"|"CANCELED"|"PENDING"|"RUNNING"|"STOPPING"|"STOPPED"|"PASS_WITH_WARNINGS"|"ERROR"|string;
export type SuiteRunsList = SuiteRunInformation[];
export type SystemMessage = string;
export type TagKeyList = String128[];
export type TagMap = {[key: string]: String256};
export interface TagResourceRequest {
/**
* The resource ARN of an IoT Device Advisor resource.
*/
resourceArn: AmazonResourceName;
/**
* The tags to be attached to the IoT Device Advisor resource.
*/
tags: TagMap;
}
export interface TagResourceResponse {
}
export type TestCaseDefinitionName = string;
export interface TestCaseRun {
/**
* Provides the test case run ID.
*/
testCaseRunId?: UUID;
/**
* Provides the test case run definition ID.
*/
testCaseDefinitionId?: UUID;
/**
* Provides the test case run definition name.
*/
testCaseDefinitionName?: TestCaseDefinitionName;
/**
* 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 test case run start time.
*/
startTime?: Timestamp;
/**
* Provides test case run end time.
*/
endTime?: Timestamp;
/**
* Provides test case run log URL.
*/
logUrl?: LogUrl;
/**
* Provides test case run warnings.
*/
warnings?: Warnings;
/**
* Provides test case run failure result.
*/
failure?: Failure;
/**
* Provides the test scenarios for the test case run.
*/
testScenarios?: TestCaseScenariosList;
}
export type TestCaseRuns = TestCaseRun[];
export interface TestCaseScenario {
/**
* Provides test case scenario ID.
*/
testCaseScenarioId?: TestCaseScenarioId;
/**
* Provides test case scenario type. Type is one of the following: Advanced Basic
*/
testCaseScenarioType?: TestCaseScenarioType;
/**
* 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 failure result.
*/
failure?: Failure;
/**
*
*/
systemMessage?: SystemMessage;
}
export type TestCaseScenarioId = string;
export type TestCaseScenarioStatus = "PASS"|"FAIL"|"CANCELED"|"PENDING"|"RUNNING"|"STOPPING"|"STOPPED"|"PASS_WITH_WARNINGS"|"ERROR"|string;
export type TestCaseScenarioType = "Advanced"|"Basic"|string;
export type TestCaseScenariosList = TestCaseScenario[];
export interface TestResult {
/**
* Show each group of test results.
*/
groups?: GroupResultList;
}
export type Timestamp = Date;
export type Token = string;
export type UUID = string;
export interface UntagResourceRequest {
/**
* The resource ARN of an IoT Device Advisor resource.
*/
resourceArn: AmazonResourceName;
/**
* List of tag keys to remove from the IoT Device Advisor resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateSuiteDefinitionRequest {
/**
* Suite definition ID of the test suite to be updated.
*/
suiteDefinitionId: UUID;
/**
* Updates a Device Advisor test suite with suite definition configuration.
*/
suiteDefinitionConfiguration?: SuiteDefinitionConfiguration;
}
export interface UpdateSuiteDefinitionResponse {
/**
* Suite definition ID of the updated test suite.
*/
suiteDefinitionId?: UUID;
/**
* Amazon Resource Name (ARN) of the updated test suite.
*/
suiteDefinitionArn?: AmazonResourceName;
/**
* Suite definition name of the updated test suite.
*/
suiteDefinitionName?: SuiteDefinitionName;
/**
* Suite definition version of the updated test suite.
*/
suiteDefinitionVersion?: SuiteDefinitionVersion;
/**
* Timestamp of when the test suite was created.
*/
createdAt?: Timestamp;
/**
* Timestamp of when the test suite was updated.
*/
lastUpdatedAt?: Timestamp;
}
export type Warnings = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2020-09-18"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the IotDeviceAdvisor client.
*/
export import Types = IotDeviceAdvisor;
}
export = IotDeviceAdvisor;