{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-iotdeviceadvisor","description":"AWS IoT Core Device Advisor","version":"2020-09-18","base_url":"","endpoints":14,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS IoT Core Device Advisor\n@version 2020-09-18\n@auth AWS SigV4\n@endpoints 14\n@toc suiteDefinitions(9), endpoint(1), suiteRuns(1), tags(3)\n\n@group suiteDefinitions\n@endpoint POST /suiteDefinitions\n@desc Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.\n@required {suiteDefinitionConfiguration: SuiteDefinitionConfiguration}\n@optional {tags: map<str,str>}\n@returns(200) {suiteDefinitionId: str?, suiteDefinitionArn: str?, suiteDefinitionName: str?, createdAt: str(timestamp)?}\n\n@endpoint DELETE /suiteDefinitions/{suiteDefinitionId}\n@desc Deletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.\n@required {suiteDefinitionId: str}\n\n@endgroup\n\n@group endpoint\n@endpoint GET /endpoint\n@desc Gets information about an Device Advisor endpoint.\n@optional {thingArn: str, certificateArn: str, deviceRoleArn: str, authenticationMethod: str}\n@returns(200) {endpoint: str?}\n\n@endgroup\n\n@group suiteDefinitions\n@endpoint GET /suiteDefinitions/{suiteDefinitionId}\n@desc Gets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action.\n@required {suiteDefinitionId: str}\n@optional {suiteDefinitionVersion: str}\n@returns(200) {suiteDefinitionId: str?, suiteDefinitionArn: str?, suiteDefinitionVersion: str?, latestVersion: str?, suiteDefinitionConfiguration: SuiteDefinitionConfiguration?{suiteDefinitionName: str, devices: [DeviceUnderTest]?, intendedForQualification: bool?, isLongDurationTest: bool?, rootGroup: str, devicePermissionRoleArn: str, protocol: str?}, createdAt: str(timestamp)?, lastModifiedAt: str(timestamp)?, tags: map<str,str>?}\n\n@endpoint GET /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}\n@desc Gets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.\n@required {suiteDefinitionId: str, suiteRunId: str}\n@returns(200) {suiteDefinitionId: str?, suiteDefinitionVersion: str?, suiteRunId: str?, suiteRunArn: str?, suiteRunConfiguration: SuiteRunConfiguration?{primaryDevice: DeviceUnderTest{thingArn: str?, certificateArn: str?, deviceRoleArn: str?}, selectedTestList: [str]?, parallelRun: bool?}, testResult: TestResult?{groups: [GroupResult]?}, startTime: str(timestamp)?, endTime: str(timestamp)?, status: str?, errorReason: str?, tags: map<str,str>?}\n\n@endpoint GET /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/report\n@desc Gets a report download link for a successful Device Advisor qualifying test suite run. Requires permission to access the GetSuiteRunReport action.\n@required {suiteDefinitionId: str, suiteRunId: str}\n@returns(200) {qualificationReportDownloadUrl: str?}\n\n@endpoint GET /suiteDefinitions\n@desc Lists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.\n@optional {maxResults: int, nextToken: str}\n@returns(200) {suiteDefinitionInformationList: [SuiteDefinitionInformation]?, nextToken: str?}\n\n@endgroup\n\n@group suiteRuns\n@endpoint GET /suiteRuns\n@desc 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.\n@optional {suiteDefinitionId: str, suiteDefinitionVersion: str, maxResults: int, nextToken: str}\n@returns(200) {suiteRunsList: [SuiteRunInformation]?, nextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resourceArn}\n@desc Lists the tags attached to an IoT Device Advisor resource. Requires permission to access the ListTagsForResource action.\n@required {resourceArn: str}\n@returns(200) {tags: map<str,str>?}\n\n@endgroup\n\n@group suiteDefinitions\n@endpoint POST /suiteDefinitions/{suiteDefinitionId}/suiteRuns\n@desc Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.\n@required {suiteDefinitionId: str, suiteRunConfiguration: SuiteRunConfiguration}\n@optional {suiteDefinitionVersion: str, tags: map<str,str>}\n@returns(200) {suiteRunId: str?, suiteRunArn: str?, createdAt: str(timestamp)?, endpoint: str?}\n\n@endpoint POST /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop\n@desc Stops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.\n@required {suiteDefinitionId: str, suiteRunId: str}\n\n@endgroup\n\n@group tags\n@endpoint POST /tags/{resourceArn}\n@desc Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the TagResource action.\n@required {resourceArn: str, tags: map<str,str>}\n\n@endpoint DELETE /tags/{resourceArn}\n@desc Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.\n@required {resourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group suiteDefinitions\n@endpoint PATCH /suiteDefinitions/{suiteDefinitionId}\n@desc Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.\n@required {suiteDefinitionId: str, suiteDefinitionConfiguration: SuiteDefinitionConfiguration}\n@returns(200) {suiteDefinitionId: str?, suiteDefinitionArn: str?, suiteDefinitionName: str?, suiteDefinitionVersion: str?, createdAt: str(timestamp)?, lastUpdatedAt: str(timestamp)?}\n\n@endgroup\n\n@end\n"}