{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.iotdeviceadvisor#AmazonResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.iotdeviceadvisor#AuthenticationMethod": { "type": "enum", "members": { "X509ClientCertificate": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "X509ClientCertificate" } }, "SignatureVersion4": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SignatureVersion4" } } } }, "com.amazonaws.iotdeviceadvisor#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\u0021-\\u007E]+$" } }, "com.amazonaws.iotdeviceadvisor#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { "smithy.api#documentation": "
Sends a Conflict Exception message.
" } } }, "traits": { "smithy.api#documentation": "Sends a Conflict Exception.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinition": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a Device Advisor test suite.
\nRequires permission to access the CreateSuiteDefinition action.
", "smithy.api#http": { "method": "POST", "uri": "/suiteDefinitions", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionRequest": { "type": "structure", "members": { "suiteDefinitionConfiguration": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Creates a Device Advisor test suite with suite definition configuration.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iotdeviceadvisor#TagMap", "traits": { "smithy.api#documentation": "The tags to be attached to the suite definition.
" } }, "clientToken": { "target": "com.amazonaws.iotdeviceadvisor#ClientToken", "traits": { "smithy.api#documentation": "The client token for the test suite definition creation. \n This token is used for tracking test suite definition creation \n using retries and obtaining its status. This parameter is optional.
", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinitionResponse": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "The UUID of the test suite created.
" } }, "suiteDefinitionArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the test suite.
" } }, "suiteDefinitionName": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", "traits": { "smithy.api#documentation": "The suite definition name of the test suite. This is a required parameter.
" } }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the test suite was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinition": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a Device Advisor test suite.
\nRequires permission to access the DeleteSuiteDefinition action.
", "smithy.api#http": { "method": "DELETE", "uri": "/suiteDefinitions/{suiteDefinitionId}", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the test suite to be deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinitionResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#DeviceUnderTest": { "type": "structure", "members": { "thingArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "Lists device's thing ARN.
" } }, "certificateArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "Lists device's certificate ARN.
" } }, "deviceRoleArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "Lists device's role ARN.
" } } }, "traits": { "smithy.api#documentation": "Information of a test device. A thing ARN, certificate ARN \n or device role ARN is required.
" } }, "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTest" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.iotdeviceadvisor#Endpoint": { "type": "string", "traits": { "smithy.api#length": { "min": 45, "max": 75 } } }, "com.amazonaws.iotdeviceadvisor#ErrorReason": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#Failure": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#GetEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#GetEndpointRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#GetEndpointResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets information about an Device Advisor endpoint.
", "smithy.api#http": { "method": "GET", "uri": "/endpoint", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#GetEndpointRequest": { "type": "structure", "members": { "thingArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The thing ARN of the device. This is an optional parameter.
", "smithy.api#httpQuery": "thingArn" } }, "certificateArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The certificate ARN of the device. This is an optional parameter.
", "smithy.api#httpQuery": "certificateArn" } }, "deviceRoleArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The device role ARN of the device. This is an optional parameter.
", "smithy.api#httpQuery": "deviceRoleArn" } }, "authenticationMethod": { "target": "com.amazonaws.iotdeviceadvisor#AuthenticationMethod", "traits": { "smithy.api#documentation": "The authentication method used during the device connection.
", "smithy.api#httpQuery": "authenticationMethod" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#GetEndpointResponse": { "type": "structure", "members": { "endpoint": { "target": "com.amazonaws.iotdeviceadvisor#Endpoint", "traits": { "smithy.api#documentation": "The response of an Device Advisor endpoint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#GetSuiteDefinition": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets information about a Device Advisor test suite.
\nRequires permission to access the GetSuiteDefinition action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions/{suiteDefinitionId}", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the test suite to get.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Suite definition version of the test suite to get.
", "smithy.api#httpQuery": "suiteDefinitionVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#GetSuiteDefinitionResponse": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the suite definition.
" } }, "suiteDefinitionArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the suite definition.
" } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Suite definition version of the suite definition.
" } }, "latestVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Latest suite definition version of the suite definition.
" } }, "suiteDefinitionConfiguration": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration", "traits": { "smithy.api#documentation": "Suite configuration of the suite definition.
" } }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the suite definition was created.
" } }, "lastModifiedAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the suite definition was last modified.
" } }, "tags": { "target": "com.amazonaws.iotdeviceadvisor#TagMap", "traits": { "smithy.api#documentation": "Tags attached to the suite definition.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#GetSuiteRun": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets information about a Device Advisor test suite run.
\nRequires permission to access the GetSuiteRun action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#GetSuiteRunReport": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets a report download link for a successful Device Advisor qualifying test suite run.
\nRequires permission to access the GetSuiteRunReport action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/report", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the test suite.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite run ID of the test suite run.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#GetSuiteRunReportResponse": { "type": "structure", "members": { "qualificationReportDownloadUrl": { "target": "com.amazonaws.iotdeviceadvisor#QualificationReportDownloadUrl", "traits": { "smithy.api#documentation": "Download URL of the qualification report.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#GetSuiteRunRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID for the test suite run.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite run ID for the test suite run.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#GetSuiteRunResponse": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID for the test suite run.
" } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Suite definition version for the test suite run.
" } }, "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite run ID for the test suite run.
" } }, "suiteRunArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The ARN of the suite run.
" } }, "suiteRunConfiguration": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunConfiguration", "traits": { "smithy.api#documentation": "Suite run configuration for the test suite run.
" } }, "testResult": { "target": "com.amazonaws.iotdeviceadvisor#TestResult", "traits": { "smithy.api#documentation": "Test results for the test suite run.
" } }, "startTime": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the test suite run started.
" } }, "endTime": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the test suite run ended.
" } }, "status": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunStatus", "traits": { "smithy.api#documentation": "Status for the test suite run.
" } }, "errorReason": { "target": "com.amazonaws.iotdeviceadvisor#ErrorReason", "traits": { "smithy.api#documentation": "Error reason for any test suite run failure.
" } }, "tags": { "target": "com.amazonaws.iotdeviceadvisor#TagMap", "traits": { "smithy.api#documentation": "The tags attached to the suite run.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#GroupName": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#GroupResult": { "type": "structure", "members": { "groupId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Group result ID.
" } }, "groupName": { "target": "com.amazonaws.iotdeviceadvisor#GroupName", "traits": { "smithy.api#documentation": "Group Result Name.
" } }, "tests": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseRuns", "traits": { "smithy.api#documentation": "Tests under Group Result.
" } } }, "traits": { "smithy.api#documentation": "Show Group Result.
" } }, "com.amazonaws.iotdeviceadvisor#GroupResultList": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#GroupResult" }, "traits": { "smithy.api#documentation": "Group Result list.
" } }, "com.amazonaws.iotdeviceadvisor#IntendedForQualificationBoolean": { "type": "boolean" }, "com.amazonaws.iotdeviceadvisor#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { "smithy.api#documentation": "Sends an Internal Failure Exception message.
" } } }, "traits": { "smithy.api#documentation": "Sends an Internal Failure exception.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.iotdeviceadvisor#IotSenateService": { "type": "service", "version": "2020-09-18", "operations": [ { "target": "com.amazonaws.iotdeviceadvisor#CreateSuiteDefinition" }, { "target": "com.amazonaws.iotdeviceadvisor#DeleteSuiteDefinition" }, { "target": "com.amazonaws.iotdeviceadvisor#GetEndpoint" }, { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteDefinition" }, { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRun" }, { "target": "com.amazonaws.iotdeviceadvisor#GetSuiteRunReport" }, { "target": "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitions" }, { "target": "com.amazonaws.iotdeviceadvisor#ListSuiteRuns" }, { "target": "com.amazonaws.iotdeviceadvisor#ListTagsForResource" }, { "target": "com.amazonaws.iotdeviceadvisor#StartSuiteRun" }, { "target": "com.amazonaws.iotdeviceadvisor#StopSuiteRun" }, { "target": "com.amazonaws.iotdeviceadvisor#TagResource" }, { "target": "com.amazonaws.iotdeviceadvisor#UntagResource" }, { "target": "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinition" } ], "traits": { "aws.api#service": { "sdkId": "IotDeviceAdvisor", "arnNamespace": "iotdeviceadvisor", "cloudFormationName": "IotDeviceAdvisor", "cloudTrailEventSource": "iotdeviceadvisor.amazonaws.com", "endpointPrefix": "api.iotdeviceadvisor" }, "aws.auth#sigv4": { "name": "iotdeviceadvisor" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT\n devices during device software development. Device Advisor provides pre-built tests that you\n can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core\n before deploying devices to production. By using Device Advisor, you can confirm that your\n devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable,\n receive software updates from IoT Device Management. You can also download signed\n qualification reports to submit to the Amazon Web Services Partner Network to get your device\n qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in\n and wait for it to be tested.
", "smithy.api#title": "AWS IoT Core Device Advisor", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://api.iotdeviceadvisor.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://api.iotdeviceadvisor.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.iotdeviceadvisor#IsLongDurationTestBoolean": { "type": "boolean" }, "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitions": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the Device Advisor test suites you have created.
\nRequires permission to access the ListSuiteDefinitions action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteDefinitions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.iotdeviceadvisor#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to return at once.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iotdeviceadvisor#Token", "traits": { "smithy.api#documentation": "A token used to get the next set of results.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#ListSuiteDefinitionsResponse": { "type": "structure", "members": { "suiteDefinitionInformationList": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformationList", "traits": { "smithy.api#documentation": "An array of objects that provide summaries of information about the suite definitions\n in the list.
" } }, "nextToken": { "target": "com.amazonaws.iotdeviceadvisor#Token", "traits": { "smithy.api#documentation": "A token used to get the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#ListSuiteRuns": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#ListSuiteRunsRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#ListSuiteRunsResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists runs of the specified Device Advisor test suite. You can list all runs of the test\n suite, or the runs of a specific version of the test suite.
\nRequires permission to access the ListSuiteRuns action.
", "smithy.api#http": { "method": "GET", "uri": "/suiteRuns", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" } } }, "com.amazonaws.iotdeviceadvisor#ListSuiteRunsRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Lists the test suite runs of the specified test suite based on suite definition\n ID.
", "smithy.api#httpQuery": "suiteDefinitionId" } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Must be passed along with suiteDefinitionId. Lists the test suite runs of\n the specified test suite based on suite definition version.
The maximum number of results to return at once.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.iotdeviceadvisor#Token", "traits": { "smithy.api#documentation": "A token to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#ListSuiteRunsResponse": { "type": "structure", "members": { "suiteRunsList": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunsList", "traits": { "smithy.api#documentation": "An array of objects that provide summaries of information about the suite runs in the\n list.
" } }, "nextToken": { "target": "com.amazonaws.iotdeviceadvisor#Token", "traits": { "smithy.api#documentation": "A token to retrieve the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the tags attached to an IoT Device Advisor resource.
\nRequires permission to access the ListTagsForResource action.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.iotdeviceadvisor#TagMap", "traits": { "smithy.api#documentation": "The tags attached to the IoT Device Advisor resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#LogUrl": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.iotdeviceadvisor#Message": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.iotdeviceadvisor#ParallelRun": { "type": "boolean" }, "com.amazonaws.iotdeviceadvisor#Protocol": { "type": "enum", "members": { "MqttV3_1_1": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MqttV3_1_1" } }, "MqttV5": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MqttV5" } }, "MqttV3_1_1_OverWebSocket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MqttV3_1_1_OverWebSocket" } }, "MqttV5_OverWebSocket": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MqttV5_OverWebSocket" } } } }, "com.amazonaws.iotdeviceadvisor#QualificationReportDownloadUrl": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { "smithy.api#documentation": "Sends a Resource Not Found Exception message.
" } } }, "traits": { "smithy.api#documentation": "Sends a Resource Not Found exception.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.iotdeviceadvisor#RootGroup": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.iotdeviceadvisor#SelectedTestList": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#UUID" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.iotdeviceadvisor#StartSuiteRun": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#StartSuiteRunRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#StartSuiteRunResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#ConflictException" }, { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Starts a Device Advisor test suite run.
\nRequires permission to access the StartSuiteRun action.
", "smithy.api#http": { "method": "POST", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#StartSuiteRunRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the test suite.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Suite definition version of the test suite.
" } }, "suiteRunConfiguration": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Suite run configuration.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iotdeviceadvisor#TagMap", "traits": { "smithy.api#documentation": "The tags to be attached to the suite run.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#StartSuiteRunResponse": { "type": "structure", "members": { "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite Run ID of the started suite run.
" } }, "suiteRunArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "Amazon Resource Name (ARN) of the started suite run.
" } }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Starts a Device Advisor test suite run based on suite create time.
" } }, "endpoint": { "target": "com.amazonaws.iotdeviceadvisor#Endpoint", "traits": { "smithy.api#documentation": "The response of an Device Advisor test endpoint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#Status": { "type": "enum", "members": { "PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS" } }, "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } }, "PASS_WITH_WARNINGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS_WITH_WARNINGS" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } } }, "com.amazonaws.iotdeviceadvisor#StopSuiteRun": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#StopSuiteRunRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#StopSuiteRunResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Stops a Device Advisor test suite run that is currently running.
\nRequires permission to access the StopSuiteRun action.
", "smithy.api#http": { "method": "POST", "uri": "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#StopSuiteRunRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the test suite run to be stopped.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite run ID of the test suite run to be stopped.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#StopSuiteRunResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#String128": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.iotdeviceadvisor#String256": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration": { "type": "structure", "members": { "suiteDefinitionName": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Gets the suite definition name. This is a required parameter.
", "smithy.api#required": {} } }, "devices": { "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList", "traits": { "smithy.api#documentation": "Gets the devices configured.
" } }, "intendedForQualification": { "target": "com.amazonaws.iotdeviceadvisor#IntendedForQualificationBoolean", "traits": { "smithy.api#documentation": "Gets the tests intended for qualification in a suite.
" } }, "isLongDurationTest": { "target": "com.amazonaws.iotdeviceadvisor#IsLongDurationTestBoolean", "traits": { "smithy.api#documentation": "Verifies if the test suite is a long duration test.
" } }, "rootGroup": { "target": "com.amazonaws.iotdeviceadvisor#RootGroup", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Gets the test suite root group. This is a required parameter.\n For updating or creating the latest qualification suite, \n if intendedForQualification is set to true, \n rootGroup can be an empty string. If intendedForQualification is false, \n rootGroup cannot be an empty string.\n If rootGroup is empty, and \n intendedForQualification is set to true, \n all the qualification tests are included, and the configuration is default.
\n For a qualification suite, the minimum length is 0, and the maximum is 2048. For a \n non-qualification suite, the minimum length is 1, and the maximum is 2048.\n
", "smithy.api#required": {} } }, "devicePermissionRoleArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Gets the device permission ARN. This is a required parameter.
", "smithy.api#required": {} } }, "protocol": { "target": "com.amazonaws.iotdeviceadvisor#Protocol", "traits": { "smithy.api#documentation": "Sets the MQTT protocol that is configured in the suite definition.
" } } }, "traits": { "smithy.api#documentation": "Gets the suite definition configuration.
" } }, "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformation": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the test suite.
" } }, "suiteDefinitionName": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", "traits": { "smithy.api#documentation": "Suite name of the test suite.
" } }, "defaultDevices": { "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTestList", "traits": { "smithy.api#documentation": "Specifies the devices that are under test for the test suite.
" } }, "intendedForQualification": { "target": "com.amazonaws.iotdeviceadvisor#IntendedForQualificationBoolean", "traits": { "smithy.api#documentation": "Specifies if the test suite is intended for qualification.
" } }, "isLongDurationTest": { "target": "com.amazonaws.iotdeviceadvisor#IsLongDurationTestBoolean", "traits": { "smithy.api#documentation": "Verifies if the test suite is a long duration test.
" } }, "protocol": { "target": "com.amazonaws.iotdeviceadvisor#Protocol", "traits": { "smithy.api#documentation": "Gets the MQTT protocol that is configured in the suite definition.
" } }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the test suite was created.
" } } }, "traits": { "smithy.api#documentation": "Information about the suite definition.
" } }, "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformationList": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionInformation" } }, "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 255 } } }, "com.amazonaws.iotdeviceadvisor#SuiteRunConfiguration": { "type": "structure", "members": { "primaryDevice": { "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTest", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Sets the primary device for the test suite run. This requires a thing ARN or a\n certificate ARN.
", "smithy.api#required": {} } }, "selectedTestList": { "target": "com.amazonaws.iotdeviceadvisor#SelectedTestList", "traits": { "smithy.api#documentation": "Sets test case list.
" } }, "parallelRun": { "target": "com.amazonaws.iotdeviceadvisor#ParallelRun", "traits": { "smithy.api#documentation": "TRUE if multiple test suites run in parallel.
" } } }, "traits": { "smithy.api#documentation": "Gets suite run configuration.
" } }, "com.amazonaws.iotdeviceadvisor#SuiteRunInformation": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the suite run.
" } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Suite definition version of the suite run.
" } }, "suiteDefinitionName": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", "traits": { "smithy.api#documentation": "Suite definition name of the suite run.
" } }, "suiteRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite run ID of the suite run.
" } }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the suite run was created.
" } }, "startedAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the suite run was started.
" } }, "endAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Date (in Unix epoch time) when the suite run ended.
" } }, "status": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunStatus", "traits": { "smithy.api#documentation": "Status of the suite run.
" } }, "passed": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunResultCount", "traits": { "smithy.api#documentation": "Number of test cases that passed in the suite run.
" } }, "failed": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunResultCount", "traits": { "smithy.api#documentation": "Number of test cases that failed in the suite run.
" } } }, "traits": { "smithy.api#documentation": "Information about the suite run.
\nRequires permission to access the SuiteRunInformation action.
" } }, "com.amazonaws.iotdeviceadvisor#SuiteRunResultCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 500 } } }, "com.amazonaws.iotdeviceadvisor#SuiteRunStatus": { "type": "enum", "members": { "PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS" } }, "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } }, "PASS_WITH_WARNINGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS_WITH_WARNINGS" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } } }, "com.amazonaws.iotdeviceadvisor#SuiteRunsList": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#SuiteRunInformation" } }, "com.amazonaws.iotdeviceadvisor#SystemMessage": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#String128" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.iotdeviceadvisor#TagMap": { "type": "map", "key": { "target": "com.amazonaws.iotdeviceadvisor#String128" }, "value": { "target": "com.amazonaws.iotdeviceadvisor#String256" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.iotdeviceadvisor#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#TagResourceRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds to and modifies existing tags of an IoT Device Advisor resource.
\nRequires permission to access the TagResource action.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.iotdeviceadvisor#TagMap", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The tags to be attached to the IoT Device Advisor resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#TestCaseDefinitionName": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#TestCaseRun": { "type": "structure", "members": { "testCaseRunId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Provides the test case run ID.
" } }, "testCaseDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Provides the test case run definition ID.
" } }, "testCaseDefinitionName": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseDefinitionName", "traits": { "smithy.api#documentation": "Provides the test case run definition name.
" } }, "status": { "target": "com.amazonaws.iotdeviceadvisor#Status", "traits": { "smithy.api#documentation": "Provides the test case run status. Status is one of the following:
\n\n PASS: Test passed.
\n FAIL: Test failed.
\n PENDING: Test has not started running but is scheduled.
\n RUNNING: Test is running.
\n STOPPING: Test is performing cleanup steps. You will see this\n status only if you stop a suite run.
\n STOPPED Test is stopped. You will see this status only if you\n stop a suite run.
\n PASS_WITH_WARNINGS: Test passed with warnings.
\n ERORR: Test faced an error when running due to an internal\n issue.
Provides test case run start time.
" } }, "endTime": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Provides test case run end time.
" } }, "logUrl": { "target": "com.amazonaws.iotdeviceadvisor#LogUrl", "traits": { "smithy.api#documentation": "Provides test case run log URL.
" } }, "warnings": { "target": "com.amazonaws.iotdeviceadvisor#Warnings", "traits": { "smithy.api#documentation": "Provides test case run warnings.
" } }, "failure": { "target": "com.amazonaws.iotdeviceadvisor#Failure", "traits": { "smithy.api#documentation": "Provides test case run failure result.
" } }, "testScenarios": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenariosList", "traits": { "smithy.api#documentation": "Provides the test scenarios for the test case run.
" } } }, "traits": { "smithy.api#documentation": "Provides the test case run.
" } }, "com.amazonaws.iotdeviceadvisor#TestCaseRuns": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseRun" }, "traits": { "smithy.api#documentation": "Tests under each group result.
" } }, "com.amazonaws.iotdeviceadvisor#TestCaseScenario": { "type": "structure", "members": { "testCaseScenarioId": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenarioId", "traits": { "smithy.api#documentation": "Provides test case scenario ID.
" } }, "testCaseScenarioType": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenarioType", "traits": { "smithy.api#documentation": "Provides test case scenario type. Type is one of the following:
\nAdvanced
\nBasic
\nProvides the test case scenario status. Status is one of the following:
\n\n PASS: Test passed.
\n FAIL: Test failed.
\n PENDING: Test has not started running but is scheduled.
\n RUNNING: Test is running.
\n STOPPING: Test is performing cleanup steps. You will see this\n status only if you stop a suite run.
\n STOPPED Test is stopped. You will see this status only if you\n stop a suite run.
\n PASS_WITH_WARNINGS: Test passed with warnings.
\n ERORR: Test faced an error when running due to an internal\n issue.
Provides test case scenario failure result.
" } }, "systemMessage": { "target": "com.amazonaws.iotdeviceadvisor#SystemMessage", "traits": { "smithy.api#documentation": "Provides test case scenario system messages if any.
" } } }, "traits": { "smithy.api#documentation": "Provides test case scenario.
" } }, "com.amazonaws.iotdeviceadvisor#TestCaseScenarioId": { "type": "string" }, "com.amazonaws.iotdeviceadvisor#TestCaseScenarioStatus": { "type": "enum", "members": { "PASS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS" } }, "FAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAIL" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RUNNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RUNNING" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } }, "PASS_WITH_WARNINGS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASS_WITH_WARNINGS" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } } }, "com.amazonaws.iotdeviceadvisor#TestCaseScenarioType": { "type": "enum", "members": { "Advanced": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Advanced" } }, "Basic": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Basic" } } } }, "com.amazonaws.iotdeviceadvisor#TestCaseScenariosList": { "type": "list", "member": { "target": "com.amazonaws.iotdeviceadvisor#TestCaseScenario" } }, "com.amazonaws.iotdeviceadvisor#TestResult": { "type": "structure", "members": { "groups": { "target": "com.amazonaws.iotdeviceadvisor#GroupResultList", "traits": { "smithy.api#documentation": "Show each group of test results.
" } } }, "traits": { "smithy.api#documentation": "Show each group result.
" } }, "com.amazonaws.iotdeviceadvisor#Timestamp": { "type": "timestamp" }, "com.amazonaws.iotdeviceadvisor#Token": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2000 } } }, "com.amazonaws.iotdeviceadvisor#UUID": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 36 } } }, "com.amazonaws.iotdeviceadvisor#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#UntagResourceRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ResourceNotFoundException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes tags from an IoT Device Advisor resource.
\nRequires permission to access the UntagResource action.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.iotdeviceadvisor#TagKeyList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "List of tag keys to remove from the IoT Device Advisor resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinition": { "type": "operation", "input": { "target": "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionRequest" }, "output": { "target": "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionResponse" }, "errors": [ { "target": "com.amazonaws.iotdeviceadvisor#InternalServerException" }, { "target": "com.amazonaws.iotdeviceadvisor#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a Device Advisor test suite.
\nRequires permission to access the UpdateSuiteDefinition action.
", "smithy.api#http": { "method": "PATCH", "uri": "/suiteDefinitions/{suiteDefinitionId}", "code": 200 } } }, "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionRequest": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the test suite to be updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "suiteDefinitionConfiguration": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Updates a Device Advisor test suite with suite definition configuration.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.iotdeviceadvisor#UpdateSuiteDefinitionResponse": { "type": "structure", "members": { "suiteDefinitionId": { "target": "com.amazonaws.iotdeviceadvisor#UUID", "traits": { "smithy.api#documentation": "Suite definition ID of the updated test suite.
" } }, "suiteDefinitionArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { "smithy.api#documentation": "Amazon Resource Name (ARN) of the updated test suite.
" } }, "suiteDefinitionName": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionName", "traits": { "smithy.api#documentation": "Updates the suite definition name. This is a required parameter.
" } }, "suiteDefinitionVersion": { "target": "com.amazonaws.iotdeviceadvisor#SuiteDefinitionVersion", "traits": { "smithy.api#documentation": "Suite definition version of the updated test suite.
" } }, "createdAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Timestamp of when the test suite was created.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.iotdeviceadvisor#Timestamp", "traits": { "smithy.api#documentation": "Timestamp of when the test suite was updated.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.iotdeviceadvisor#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.iotdeviceadvisor#Message", "traits": { "smithy.api#documentation": "Sends a Validation Exception message.
" } } }, "traits": { "smithy.api#documentation": "Sends a validation exception.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.iotdeviceadvisor#Warnings": { "type": "string" } } }