diff --git a/.changes/next-release/feature-AWSIoTCoreDeviceAdvisor-68a3f5b.json b/.changes/next-release/feature-AWSIoTCoreDeviceAdvisor-68a3f5b.json new file mode 100644 index 000000000000..5ef2eb09b404 --- /dev/null +++ b/.changes/next-release/feature-AWSIoTCoreDeviceAdvisor-68a3f5b.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS IoT Core Device Advisor", + "contributor": "", + "description": "Documentation update for Device Advisor GetEndpoint API" +} diff --git a/services/iotdeviceadvisor/src/main/resources/codegen-resources/service-2.json b/services/iotdeviceadvisor/src/main/resources/codegen-resources/service-2.json index fad6522bfa9c..1cb1ea3db4eb 100644 --- a/services/iotdeviceadvisor/src/main/resources/codegen-resources/service-2.json +++ b/services/iotdeviceadvisor/src/main/resources/codegen-resources/service-2.json @@ -53,7 +53,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} - ] + ], + "documentation":"
Gets information about an Device Advisor endpoint.
" }, "GetSuiteDefinition":{ "name":"GetSuiteDefinition", @@ -126,7 +127,7 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"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.
Requires permission to access the ListSuiteRuns action.
" + "documentation":"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.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -229,10 +230,10 @@ "members":{ "message":{ "shape":"Message", - "documentation":"Sends Conflict Exception message.
" + "documentation":"Sends a Conflict Exception message.
" } }, - "documentation":"Sends Conflict Exception.
", + "documentation":"Sends a Conflict Exception.
", "error":{"httpStatusCode":400}, "exception":true }, @@ -299,7 +300,7 @@ "documentation":"Lists devices certificate ARN.
" } }, - "documentation":"Information of a test device. Required to provide either a thing ARN or a certificate ARN.
" + "documentation":"Information of a test device. A thing ARN or a certificate ARN is required.
" }, "DeviceUnderTestList":{ "type":"list", @@ -319,11 +320,13 @@ "members":{ "thingArn":{ "shape":"AmazonResourceName", + "documentation":"The thing ARN of the device. This is an optional parameter.
", "location":"querystring", "locationName":"thingArn" }, "certificateArn":{ "shape":"AmazonResourceName", + "documentation":"The certificate ARN of the device. This is an optional parameter.
", "location":"querystring", "locationName":"certificateArn" } @@ -332,7 +335,10 @@ "GetEndpointResponse":{ "type":"structure", "members":{ - "endpoint":{"shape":"Endpoint"} + "endpoint":{ + "shape":"Endpoint", + "documentation":"The response of an Device Advisor endpoint.
" + } } }, "GetSuiteDefinitionRequest":{ @@ -470,7 +476,7 @@ }, "startTime":{ "shape":"Timestamp", - "documentation":"Date (in Unix epoch time) when the test suite run was started.
" + "documentation":"Date (in Unix epoch time) when the test suite run started.
" }, "endTime":{ "shape":"Timestamp", @@ -520,10 +526,10 @@ "members":{ "message":{ "shape":"Message", - "documentation":"Sends Internal Failure Exception message.
" + "documentation":"Sends an Internal Failure Exception message.
" } }, - "documentation":"Sends Internal Failure Exception.
", + "documentation":"Sends an Internal Failure exception.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true @@ -569,7 +575,7 @@ }, "suiteDefinitionVersion":{ "shape":"SuiteDefinitionVersion", - "documentation":"Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.
", + "documentation":"Must be passed along with suiteDefinitionId
. Lists the test suite runs of the specified test suite based on suite definition version.
Sends Resource Not Found Exception message.
" + "documentation":"Sends a Resource Not Found Exception message.
" } }, - "documentation":"Sends Resource Not Found Exception.
", + "documentation":"Sends a Resource Not Found exception.
", "error":{"httpStatusCode":404}, "exception":true }, @@ -769,7 +775,7 @@ }, "devicePermissionRoleArn":{ "shape":"AmazonResourceName", - "documentation":"Gets device permission ARN.
" + "documentation":"Gets the device permission ARN.
" } }, "documentation":"Gets Suite Definition Configuration.
" @@ -787,7 +793,7 @@ }, "defaultDevices":{ "shape":"DeviceUnderTestList", - "documentation":"Specifies the devices under test for the test suite.
" + "documentation":"Specifies the devices that are under test for the test suite.
" }, "intendedForQualification":{ "shape":"IntendedForQualificationBoolean", @@ -825,7 +831,10 @@ "shape":"SelectedTestList", "documentation":"Gets test case list.
" }, - "parallelRun":{"shape":"ParallelRun"} + "parallelRun":{ + "shape":"ParallelRun", + "documentation":"TRUE if multiple test suites run in parallel.
" + } }, "documentation":"Gets suite run configuration.
" }, @@ -941,19 +950,19 @@ "members":{ "testCaseRunId":{ "shape":"UUID", - "documentation":"Provides test case run ID.
" + "documentation":"Provides the test case run ID.
" }, "testCaseDefinitionId":{ "shape":"UUID", - "documentation":"Provides test case run definition ID.
" + "documentation":"Provides the test case run definition ID.
" }, "testCaseDefinitionName":{ "shape":"TestCaseDefinitionName", - "documentation":"Provides test case run definition Name.
" + "documentation":"Provides the test case run definition name.
" }, "status":{ "shape":"Status", - "documentation":"Provides test case run status.
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.
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.
Provides test case run log Url.
" + "documentation":"Provides test case run log URL.
" }, "warnings":{ "shape":"Warnings", @@ -976,7 +985,7 @@ "documentation":"Provides test case run failure result.
" } }, - "documentation":"Provides test case run.
" + "documentation":"Provides the test case run.
" }, "TestCaseRuns":{ "type":"list", @@ -1079,10 +1088,10 @@ "members":{ "message":{ "shape":"Message", - "documentation":"Sends invalid request exception message.
" + "documentation":"Sends a Validation Exception message.
" } }, - "documentation":"Sends invalid request exception.
", + "documentation":"Sends a validation exception.
", "error":{"httpStatusCode":400}, "exception":true },