1051 lines
33 KiB
JSON
1051 lines
33 KiB
JSON
{
|
|
"version":"2.0",
|
|
"metadata":{
|
|
"apiVersion":"2020-09-18",
|
|
"endpointPrefix":"api.iotdeviceadvisor",
|
|
"jsonVersion":"1.1",
|
|
"protocol":"rest-json",
|
|
"serviceAbbreviation":"AWSIoTDeviceAdvisor",
|
|
"serviceFullName":"AWS IoT Core Device Advisor",
|
|
"serviceId":"IotDeviceAdvisor",
|
|
"signatureVersion":"v4",
|
|
"signingName":"iotdeviceadvisor",
|
|
"uid":"iotdeviceadvisor-2020-09-18"
|
|
},
|
|
"operations":{
|
|
"CreateSuiteDefinition":{
|
|
"name":"CreateSuiteDefinition",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/suiteDefinitions"
|
|
},
|
|
"input":{"shape":"CreateSuiteDefinitionRequest"},
|
|
"output":{"shape":"CreateSuiteDefinitionResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"}
|
|
],
|
|
"documentation":"<p>Creates a Device Advisor test suite.</p>"
|
|
},
|
|
"DeleteSuiteDefinition":{
|
|
"name":"DeleteSuiteDefinition",
|
|
"http":{
|
|
"method":"DELETE",
|
|
"requestUri":"/suiteDefinitions/{suiteDefinitionId}"
|
|
},
|
|
"input":{"shape":"DeleteSuiteDefinitionRequest"},
|
|
"output":{"shape":"DeleteSuiteDefinitionResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"}
|
|
],
|
|
"documentation":"<p>Deletes a Device Advisor test suite.</p>"
|
|
},
|
|
"GetSuiteDefinition":{
|
|
"name":"GetSuiteDefinition",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/suiteDefinitions/{suiteDefinitionId}"
|
|
},
|
|
"input":{"shape":"GetSuiteDefinitionRequest"},
|
|
"output":{"shape":"GetSuiteDefinitionResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Gets information about a Device Advisor test suite.</p>"
|
|
},
|
|
"GetSuiteRun":{
|
|
"name":"GetSuiteRun",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}"
|
|
},
|
|
"input":{"shape":"GetSuiteRunRequest"},
|
|
"output":{"shape":"GetSuiteRunResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Gets information about a Device Advisor test suite run.</p>"
|
|
},
|
|
"GetSuiteRunReport":{
|
|
"name":"GetSuiteRunReport",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/report"
|
|
},
|
|
"input":{"shape":"GetSuiteRunReportRequest"},
|
|
"output":{"shape":"GetSuiteRunReportResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Gets a report download link for a successful Device Advisor qualifying test suite run.</p>"
|
|
},
|
|
"ListSuiteDefinitions":{
|
|
"name":"ListSuiteDefinitions",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/suiteDefinitions"
|
|
},
|
|
"input":{"shape":"ListSuiteDefinitionsRequest"},
|
|
"output":{"shape":"ListSuiteDefinitionsResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"}
|
|
],
|
|
"documentation":"<p>Lists the Device Advisor test suites you have created.</p>"
|
|
},
|
|
"ListSuiteRuns":{
|
|
"name":"ListSuiteRuns",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/suiteRuns"
|
|
},
|
|
"input":{"shape":"ListSuiteRunsRequest"},
|
|
"output":{"shape":"ListSuiteRunsResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"}
|
|
],
|
|
"documentation":"<p>Lists the runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.</p>"
|
|
},
|
|
"ListTagsForResource":{
|
|
"name":"ListTagsForResource",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/tags/{resourceArn}"
|
|
},
|
|
"input":{"shape":"ListTagsForResourceRequest"},
|
|
"output":{"shape":"ListTagsForResourceResponse"},
|
|
"errors":[
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ValidationException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Lists the tags attached to an IoT Device Advisor resource.</p>"
|
|
},
|
|
"StartSuiteRun":{
|
|
"name":"StartSuiteRun",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns"
|
|
},
|
|
"input":{"shape":"StartSuiteRunRequest"},
|
|
"output":{"shape":"StartSuiteRunResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ConflictException"}
|
|
],
|
|
"documentation":"<p>Starts a Device Advisor test suite run.</p>"
|
|
},
|
|
"StopSuiteRun":{
|
|
"name":"StopSuiteRun",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop"
|
|
},
|
|
"input":{"shape":"StopSuiteRunRequest"},
|
|
"output":{"shape":"StopSuiteRunResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"ResourceNotFoundException"},
|
|
{"shape":"InternalServerException"}
|
|
],
|
|
"documentation":"<p>Stops a Device Advisor test suite run that is currently running.</p>"
|
|
},
|
|
"TagResource":{
|
|
"name":"TagResource",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/tags/{resourceArn}"
|
|
},
|
|
"input":{"shape":"TagResourceRequest"},
|
|
"output":{"shape":"TagResourceResponse"},
|
|
"errors":[
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ValidationException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Adds to and modifies existing tags of an IoT Device Advisor resource.</p>"
|
|
},
|
|
"UntagResource":{
|
|
"name":"UntagResource",
|
|
"http":{
|
|
"method":"DELETE",
|
|
"requestUri":"/tags/{resourceArn}"
|
|
},
|
|
"input":{"shape":"UntagResourceRequest"},
|
|
"output":{"shape":"UntagResourceResponse"},
|
|
"errors":[
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ValidationException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Removes tags from an IoT Device Advisor resource.</p>"
|
|
},
|
|
"UpdateSuiteDefinition":{
|
|
"name":"UpdateSuiteDefinition",
|
|
"http":{
|
|
"method":"PATCH",
|
|
"requestUri":"/suiteDefinitions/{suiteDefinitionId}"
|
|
},
|
|
"input":{"shape":"UpdateSuiteDefinitionRequest"},
|
|
"output":{"shape":"UpdateSuiteDefinitionResponse"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"}
|
|
],
|
|
"documentation":"<p>Updates a Device Advisor test suite.</p>"
|
|
}
|
|
},
|
|
"shapes":{
|
|
"AmazonResourceName":{
|
|
"type":"string",
|
|
"max":2048,
|
|
"min":20
|
|
},
|
|
"ConflictException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"Message",
|
|
"documentation":"<p>Sends Conflict Exception message.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Sends Conflict Exception.</p>",
|
|
"error":{"httpStatusCode":400},
|
|
"exception":true
|
|
},
|
|
"CreateSuiteDefinitionRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionConfiguration":{
|
|
"shape":"SuiteDefinitionConfiguration",
|
|
"documentation":"<p>Creates a Device Advisor test suite with suite definition configuration.</p>"
|
|
},
|
|
"tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags to be attached to the suite definition.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateSuiteDefinitionResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Creates a Device Advisor test suite with suite UUID.</p>"
|
|
},
|
|
"suiteDefinitionArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>Creates a Device Advisor test suite with Amazon Resource name.</p>"
|
|
},
|
|
"suiteDefinitionName":{
|
|
"shape":"SuiteDefinitionName",
|
|
"documentation":"<p>Creates a Device Advisor test suite with suite definition name.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Creates a Device Advisor test suite with TimeStamp of when it was created.</p>"
|
|
}
|
|
}
|
|
},
|
|
"DeleteSuiteDefinitionRequest":{
|
|
"type":"structure",
|
|
"required":["suiteDefinitionId"],
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the test suite to be deleted.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteDefinitionId"
|
|
}
|
|
}
|
|
},
|
|
"DeleteSuiteDefinitionResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"DeviceUnderTest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"thingArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>Lists devices thing arn</p>"
|
|
},
|
|
"certificateArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>Lists devices certificate arn</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Lists all the devices under test</p>"
|
|
},
|
|
"DeviceUnderTestList":{
|
|
"type":"list",
|
|
"member":{"shape":"DeviceUnderTest"},
|
|
"max":2,
|
|
"min":0
|
|
},
|
|
"ErrorReason":{"type":"string"},
|
|
"Failure":{"type":"string"},
|
|
"GetSuiteDefinitionRequest":{
|
|
"type":"structure",
|
|
"required":["suiteDefinitionId"],
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the test suite to get.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteDefinitionId"
|
|
},
|
|
"suiteDefinitionVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Suite definition version of the test suite to get.</p>",
|
|
"location":"querystring",
|
|
"locationName":"suiteDefinitionVersion"
|
|
}
|
|
}
|
|
},
|
|
"GetSuiteDefinitionResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the suite definition.</p>"
|
|
},
|
|
"suiteDefinitionArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>The ARN of the suite definition.</p>"
|
|
},
|
|
"suiteDefinitionVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Suite definition version of the suite definition.</p>"
|
|
},
|
|
"latestVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Latest suite definition version of the suite definition.</p>"
|
|
},
|
|
"suiteDefinitionConfiguration":{
|
|
"shape":"SuiteDefinitionConfiguration",
|
|
"documentation":"<p>Suite configuration of the suite definition.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the suite definition was created.</p>"
|
|
},
|
|
"lastModifiedAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the suite definition was last modified.</p>"
|
|
},
|
|
"tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>Tags attached to the suite definition.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetSuiteRunReportRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"suiteDefinitionId",
|
|
"suiteRunId"
|
|
],
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the test suite.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteDefinitionId"
|
|
},
|
|
"suiteRunId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite run Id of the test suite run.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteRunId"
|
|
}
|
|
}
|
|
},
|
|
"GetSuiteRunReportResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"qualificationReportDownloadUrl":{
|
|
"shape":"QualificationReportDownloadUrl",
|
|
"documentation":"<p>Download URL of the qualification report.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GetSuiteRunRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"suiteDefinitionId",
|
|
"suiteRunId"
|
|
],
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id for the test suite run.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteDefinitionId"
|
|
},
|
|
"suiteRunId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite run Id for the test suite run.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteRunId"
|
|
}
|
|
}
|
|
},
|
|
"GetSuiteRunResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id for the test suite run.</p>"
|
|
},
|
|
"suiteDefinitionVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Suite definition version for the test suite run.</p>"
|
|
},
|
|
"suiteRunId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite run Id for the test suite run.</p>"
|
|
},
|
|
"suiteRunArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>The ARN of the suite run.</p>"
|
|
},
|
|
"suiteRunConfiguration":{
|
|
"shape":"SuiteRunConfiguration",
|
|
"documentation":"<p>Suite run configuration for the test suite run.</p>"
|
|
},
|
|
"testResult":{
|
|
"shape":"TestResult",
|
|
"documentation":"<p>Test results for the test suite run.</p>"
|
|
},
|
|
"startTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the test suite run was started.</p>"
|
|
},
|
|
"endTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the test suite run ended.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"SuiteRunStatus",
|
|
"documentation":"<p>Status for the test suite run.</p>"
|
|
},
|
|
"errorReason":{
|
|
"shape":"ErrorReason",
|
|
"documentation":"<p>Error reason for any test suite run failure.</p>"
|
|
},
|
|
"tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags attached to the suite run.</p>"
|
|
}
|
|
}
|
|
},
|
|
"GroupName":{"type":"string"},
|
|
"GroupResult":{
|
|
"type":"structure",
|
|
"members":{
|
|
"groupId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Group result Id.</p>"
|
|
},
|
|
"groupName":{
|
|
"shape":"GroupName",
|
|
"documentation":"<p>Group Result Name.</p>"
|
|
},
|
|
"tests":{
|
|
"shape":"TestCaseRuns",
|
|
"documentation":"<p>Tests under Group Result.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Show Group Result.</p>"
|
|
},
|
|
"GroupResultList":{
|
|
"type":"list",
|
|
"member":{"shape":"GroupResult"},
|
|
"documentation":"<p>Group Result list.</p>"
|
|
},
|
|
"IntendedForQualificationBoolean":{"type":"boolean"},
|
|
"InternalServerException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"Message",
|
|
"documentation":"<p>Sends Internal Failure Exception message.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Sends Internal Failure Exception.</p>",
|
|
"error":{"httpStatusCode":500},
|
|
"exception":true,
|
|
"fault":true
|
|
},
|
|
"ListSuiteDefinitionsRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"maxResults":{
|
|
"shape":"MaxResults",
|
|
"documentation":"<p>The maximum number of results to return at once.</p>",
|
|
"location":"querystring",
|
|
"locationName":"maxResults"
|
|
},
|
|
"nextToken":{
|
|
"shape":"Token",
|
|
"documentation":"<p>A token used to get the next set of results.</p>",
|
|
"location":"querystring",
|
|
"locationName":"nextToken"
|
|
}
|
|
}
|
|
},
|
|
"ListSuiteDefinitionsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionInformationList":{
|
|
"shape":"SuiteDefinitionInformationList",
|
|
"documentation":"<p>An array of objects that provide summaries of information about the suite definitions in the list.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"Token",
|
|
"documentation":"<p>A token used to get the next set of results.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListSuiteRunsRequest":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Lists the test suite runs of the specified test suite based on suite definition Id.</p>",
|
|
"location":"querystring",
|
|
"locationName":"suiteDefinitionId"
|
|
},
|
|
"suiteDefinitionVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.</p>",
|
|
"location":"querystring",
|
|
"locationName":"suiteDefinitionVersion"
|
|
},
|
|
"maxResults":{
|
|
"shape":"MaxResults",
|
|
"documentation":"<p>The maximum number of results to return at once.</p>",
|
|
"location":"querystring",
|
|
"locationName":"maxResults"
|
|
},
|
|
"nextToken":{
|
|
"shape":"Token",
|
|
"documentation":"<p>A token to retrieve the next set of results.</p>",
|
|
"location":"querystring",
|
|
"locationName":"nextToken"
|
|
}
|
|
}
|
|
},
|
|
"ListSuiteRunsResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteRunsList":{
|
|
"shape":"SuiteRunsList",
|
|
"documentation":"<p>An array of objects that provide summaries of information about the suite runs in the list.</p>"
|
|
},
|
|
"nextToken":{
|
|
"shape":"Token",
|
|
"documentation":"<p>A token to retrieve the next set of results.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForResourceRequest":{
|
|
"type":"structure",
|
|
"required":["resourceArn"],
|
|
"members":{
|
|
"resourceArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>The ARN of the IoT Device Advisor resource.</p>",
|
|
"location":"uri",
|
|
"locationName":"resourceArn"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForResourceResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags attached to the IoT Device Advisor resource.</p>"
|
|
}
|
|
}
|
|
},
|
|
"LogUrl":{"type":"string"},
|
|
"MaxResults":{
|
|
"type":"integer",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"Message":{
|
|
"type":"string",
|
|
"max":2048,
|
|
"min":1
|
|
},
|
|
"QualificationReportDownloadUrl":{"type":"string"},
|
|
"ResourceNotFoundException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"Message",
|
|
"documentation":"<p>Sends Resource Not Found Exception message.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Sends Resource Not Found Exception.</p>",
|
|
"error":{"httpStatusCode":404},
|
|
"exception":true
|
|
},
|
|
"RootGroup":{
|
|
"type":"string",
|
|
"max":2048,
|
|
"min":1
|
|
},
|
|
"SelectedTestList":{
|
|
"type":"list",
|
|
"member":{"shape":"UUID"},
|
|
"max":100,
|
|
"min":0
|
|
},
|
|
"StartSuiteRunRequest":{
|
|
"type":"structure",
|
|
"required":["suiteDefinitionId"],
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the test suite.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteDefinitionId"
|
|
},
|
|
"suiteDefinitionVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Suite definition version of the test suite.</p>"
|
|
},
|
|
"suiteRunConfiguration":{
|
|
"shape":"SuiteRunConfiguration",
|
|
"documentation":"<p>Suite run configuration.</p>"
|
|
},
|
|
"tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags to be attached to the suite run.</p>"
|
|
}
|
|
}
|
|
},
|
|
"StartSuiteRunResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteRunId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite Run Id of the started suite run.</p>"
|
|
},
|
|
"suiteRunArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>Amazon resource name of the started suite run.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the suite run was created.</p>"
|
|
}
|
|
}
|
|
},
|
|
"Status":{
|
|
"type":"string",
|
|
"enum":[
|
|
"PASS",
|
|
"FAIL",
|
|
"CANCELED",
|
|
"PENDING",
|
|
"RUNNING",
|
|
"STOPPING",
|
|
"STOPPED",
|
|
"PASS_WITH_WARNINGS",
|
|
"ERROR"
|
|
]
|
|
},
|
|
"StopSuiteRunRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"suiteDefinitionId",
|
|
"suiteRunId"
|
|
],
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the test suite run to be stopped.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteDefinitionId"
|
|
},
|
|
"suiteRunId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite run Id of the test suite run to be stopped.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteRunId"
|
|
}
|
|
}
|
|
},
|
|
"StopSuiteRunResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"String128":{
|
|
"type":"string",
|
|
"max":128,
|
|
"min":1
|
|
},
|
|
"String256":{
|
|
"type":"string",
|
|
"max":256,
|
|
"min":1
|
|
},
|
|
"SuiteDefinitionConfiguration":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionName":{
|
|
"shape":"SuiteDefinitionName",
|
|
"documentation":"<p>Gets Suite Definition Configuration name.</p>"
|
|
},
|
|
"devices":{
|
|
"shape":"DeviceUnderTestList",
|
|
"documentation":"<p>Gets the devices configured.</p>"
|
|
},
|
|
"intendedForQualification":{
|
|
"shape":"IntendedForQualificationBoolean",
|
|
"documentation":"<p>Gets the tests intended for qualification in a suite.</p>"
|
|
},
|
|
"rootGroup":{
|
|
"shape":"RootGroup",
|
|
"documentation":"<p>Gets test suite root group.</p>"
|
|
},
|
|
"devicePermissionRoleArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>Gets device permission arn.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Gets Suite Definition Configuration.</p>"
|
|
},
|
|
"SuiteDefinitionInformation":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the test suite.</p>"
|
|
},
|
|
"suiteDefinitionName":{
|
|
"shape":"SuiteDefinitionName",
|
|
"documentation":"<p>Suite name of the test suite.</p>"
|
|
},
|
|
"defaultDevices":{
|
|
"shape":"DeviceUnderTestList",
|
|
"documentation":"<p>Specifies the devices under test for the test suite.</p>"
|
|
},
|
|
"intendedForQualification":{
|
|
"shape":"IntendedForQualificationBoolean",
|
|
"documentation":"<p>Specifies if the test suite is intended for qualification.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the test suite was created.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Information about the suite definition.</p>"
|
|
},
|
|
"SuiteDefinitionInformationList":{
|
|
"type":"list",
|
|
"member":{"shape":"SuiteDefinitionInformation"}
|
|
},
|
|
"SuiteDefinitionName":{
|
|
"type":"string",
|
|
"max":256,
|
|
"min":1
|
|
},
|
|
"SuiteDefinitionVersion":{
|
|
"type":"string",
|
|
"max":255,
|
|
"min":2
|
|
},
|
|
"SuiteRunConfiguration":{
|
|
"type":"structure",
|
|
"members":{
|
|
"primaryDevice":{
|
|
"shape":"DeviceUnderTest",
|
|
"documentation":"<p>Gets the primary device for suite run.</p>"
|
|
},
|
|
"selectedTestList":{
|
|
"shape":"SelectedTestList",
|
|
"documentation":"<p>Gets test case list.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Gets suite run configuration.</p>"
|
|
},
|
|
"SuiteRunInformation":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the suite run.</p>"
|
|
},
|
|
"suiteDefinitionVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Suite definition version of the suite run.</p>"
|
|
},
|
|
"suiteDefinitionName":{
|
|
"shape":"SuiteDefinitionName",
|
|
"documentation":"<p>Suite definition name of the suite run.</p>"
|
|
},
|
|
"suiteRunId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite run Id of the suite run.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the suite run was created.</p>"
|
|
},
|
|
"startedAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the suite run was started.</p>"
|
|
},
|
|
"endAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Date (in Unix epoch time) when the suite run ended.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"SuiteRunStatus",
|
|
"documentation":"<p>Status of the suite run.</p>"
|
|
},
|
|
"passed":{
|
|
"shape":"SuiteRunResultCount",
|
|
"documentation":"<p>Number of test cases that passed in the suite run.</p>"
|
|
},
|
|
"failed":{
|
|
"shape":"SuiteRunResultCount",
|
|
"documentation":"<p>Number of test cases that failed in the suite run.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Information about the suite run.</p>"
|
|
},
|
|
"SuiteRunResultCount":{
|
|
"type":"integer",
|
|
"max":500,
|
|
"min":0
|
|
},
|
|
"SuiteRunStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"PASS",
|
|
"FAIL",
|
|
"CANCELED",
|
|
"PENDING",
|
|
"RUNNING",
|
|
"STOPPING",
|
|
"STOPPED",
|
|
"PASS_WITH_WARNINGS",
|
|
"ERROR"
|
|
]
|
|
},
|
|
"SuiteRunsList":{
|
|
"type":"list",
|
|
"member":{"shape":"SuiteRunInformation"}
|
|
},
|
|
"TagKeyList":{
|
|
"type":"list",
|
|
"member":{"shape":"String128"},
|
|
"max":50,
|
|
"min":0
|
|
},
|
|
"TagMap":{
|
|
"type":"map",
|
|
"key":{"shape":"String128"},
|
|
"value":{"shape":"String256"},
|
|
"max":50,
|
|
"min":0
|
|
},
|
|
"TagResourceRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"resourceArn",
|
|
"tags"
|
|
],
|
|
"members":{
|
|
"resourceArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>The resource ARN of an IoT Device Advisor resource.</p>",
|
|
"location":"uri",
|
|
"locationName":"resourceArn"
|
|
},
|
|
"tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags to be attached to the IoT Device Advisor resource.</p>"
|
|
}
|
|
}
|
|
},
|
|
"TagResourceResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"TestCaseDefinitionName":{"type":"string"},
|
|
"TestCaseRun":{
|
|
"type":"structure",
|
|
"members":{
|
|
"testCaseRunId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Provides test case run Id.</p>"
|
|
},
|
|
"testCaseDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Provides test case run definition Id.</p>"
|
|
},
|
|
"testCaseDefinitionName":{
|
|
"shape":"TestCaseDefinitionName",
|
|
"documentation":"<p>Provides test case run definition Name.</p>"
|
|
},
|
|
"status":{
|
|
"shape":"Status",
|
|
"documentation":"<p>Provides test case run status.</p>"
|
|
},
|
|
"startTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Provides test case run start time.</p>"
|
|
},
|
|
"endTime":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Provides test case run end time.</p>"
|
|
},
|
|
"logUrl":{
|
|
"shape":"LogUrl",
|
|
"documentation":"<p>Provides test case run log Url.</p>"
|
|
},
|
|
"warnings":{
|
|
"shape":"Warnings",
|
|
"documentation":"<p>Provides test case run warnings.</p>"
|
|
},
|
|
"failure":{
|
|
"shape":"Failure",
|
|
"documentation":"<p>Provides test case run failure result.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Provides test case run.</p>"
|
|
},
|
|
"TestCaseRuns":{
|
|
"type":"list",
|
|
"member":{"shape":"TestCaseRun"},
|
|
"documentation":"<p>Tests under each group result.</p>"
|
|
},
|
|
"TestResult":{
|
|
"type":"structure",
|
|
"members":{
|
|
"groups":{
|
|
"shape":"GroupResultList",
|
|
"documentation":"<p>Show each group of test results.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Show each group result.</p>"
|
|
},
|
|
"Timestamp":{"type":"timestamp"},
|
|
"Token":{
|
|
"type":"string",
|
|
"max":2000
|
|
},
|
|
"UUID":{
|
|
"type":"string",
|
|
"max":36,
|
|
"min":12
|
|
},
|
|
"UntagResourceRequest":{
|
|
"type":"structure",
|
|
"required":[
|
|
"resourceArn",
|
|
"tagKeys"
|
|
],
|
|
"members":{
|
|
"resourceArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>The resource ARN of an IoT Device Advisor resource.</p>",
|
|
"location":"uri",
|
|
"locationName":"resourceArn"
|
|
},
|
|
"tagKeys":{
|
|
"shape":"TagKeyList",
|
|
"documentation":"<p>List of tag keys to remove from the IoT Device Advisor resource.</p>",
|
|
"location":"querystring",
|
|
"locationName":"tagKeys"
|
|
}
|
|
}
|
|
},
|
|
"UntagResourceResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"UpdateSuiteDefinitionRequest":{
|
|
"type":"structure",
|
|
"required":["suiteDefinitionId"],
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the test suite to be updated.</p>",
|
|
"location":"uri",
|
|
"locationName":"suiteDefinitionId"
|
|
},
|
|
"suiteDefinitionConfiguration":{
|
|
"shape":"SuiteDefinitionConfiguration",
|
|
"documentation":"<p>Updates a Device Advisor test suite with suite definition configuration.</p>"
|
|
}
|
|
}
|
|
},
|
|
"UpdateSuiteDefinitionResponse":{
|
|
"type":"structure",
|
|
"members":{
|
|
"suiteDefinitionId":{
|
|
"shape":"UUID",
|
|
"documentation":"<p>Suite definition Id of the updated test suite.</p>"
|
|
},
|
|
"suiteDefinitionArn":{
|
|
"shape":"AmazonResourceName",
|
|
"documentation":"<p>Amazon Resource name of the updated test suite.</p>"
|
|
},
|
|
"suiteDefinitionName":{
|
|
"shape":"SuiteDefinitionName",
|
|
"documentation":"<p>Suite definition name of the updated test suite.</p>"
|
|
},
|
|
"suiteDefinitionVersion":{
|
|
"shape":"SuiteDefinitionVersion",
|
|
"documentation":"<p>Suite definition version of the updated test suite.</p>"
|
|
},
|
|
"createdAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Timestamp of when the test suite was created.</p>"
|
|
},
|
|
"lastUpdatedAt":{
|
|
"shape":"Timestamp",
|
|
"documentation":"<p>Timestamp of when the test suite was updated.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ValidationException":{
|
|
"type":"structure",
|
|
"members":{
|
|
"message":{
|
|
"shape":"Message",
|
|
"documentation":"<p>Sends invalid request exception message.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Sends invalid request exception.</p>",
|
|
"error":{"httpStatusCode":400},
|
|
"exception":true
|
|
},
|
|
"Warnings":{"type":"string"}
|
|
},
|
|
"documentation":"<p>AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the AWS Partner Network to get your device qualified for the AWS Partner Device Catalog without the need to send your device in and wait for it to be tested.</p>"
|
|
}
|