{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:amazonaws-iotdeviceadvisor/list-suite-definitions":{"get":{"operationId":"cloud_amazonaws_iotdeviceadvisor_list_suite_definitions","summary":"Lists the Device Advisor test suites you have created. Requires permission to access the…","description":"GET /suiteDefinitions","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return at once.","schema":{"type":"integer","description":"The maximum number of results to return at once."}},{"name":"nextToken","in":"query","required":false,"description":"A token used to get the next set of results.","schema":{"type":"string","description":"A token used to get the next set of results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/create-suite-definition":{"post":{"operationId":"cloud_amazonaws_iotdeviceadvisor_create_suite_definition","summary":"Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.","description":"POST /suiteDefinitions","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/get-suite-definition":{"get":{"operationId":"cloud_amazonaws_iotdeviceadvisor_get_suite_definition","summary":"Gets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition…","description":"GET /suiteDefinitions/{suiteDefinitionId}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"suiteDefinitionId","in":"query","required":true,"description":"Suite definition ID of the test suite to get.","schema":{"type":"string","description":"Suite definition ID of the test suite to get."}},{"name":"suiteDefinitionVersion","in":"query","required":false,"description":"Suite definition version of the test suite to get.","schema":{"type":"string","description":"Suite definition version of the test suite to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/update-suite-definition":{"post":{"operationId":"cloud_amazonaws_iotdeviceadvisor_update_suite_definition","summary":"Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.","description":"PATCH /suiteDefinitions/{suiteDefinitionId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suiteDefinitionId","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"suiteDefinitionId":{"type":"string","description":"Suite definition ID of the test suite to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/delete-suite-definition":{"post":{"operationId":"cloud_amazonaws_iotdeviceadvisor_delete_suite_definition","summary":"Deletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.","description":"DELETE /suiteDefinitions/{suiteDefinitionId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suiteDefinitionId"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"suiteDefinitionId":{"type":"string","description":"Suite definition ID of the test suite to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/get-endpoint":{"get":{"operationId":"cloud_amazonaws_iotdeviceadvisor_get_endpoint","summary":"Gets information about an Device Advisor endpoint.","description":"GET /endpoint","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"thingArn","in":"query","required":false,"description":"The thing ARN of the device. This is an optional parameter.","schema":{"type":"string","description":"The thing ARN of the device. This is an optional parameter."}},{"name":"certificateArn","in":"query","required":false,"description":"The certificate ARN of the device. This is an optional parameter.","schema":{"type":"string","description":"The certificate ARN of the device. This is an optional parameter."}},{"name":"deviceRoleArn","in":"query","required":false,"description":"The device role ARN of the device. This is an optional parameter.","schema":{"type":"string","description":"The device role ARN of the device. This is an optional parameter."}},{"name":"authenticationMethod","in":"query","required":false,"description":"The authentication method used during the device connection.","schema":{"type":"string","enum":["X509ClientCertificate","SignatureVersion4"],"description":"The authentication method used during the device connection."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/get-suite-run":{"get":{"operationId":"cloud_amazonaws_iotdeviceadvisor_get_suite_run","summary":"Gets information about a Device Advisor test suite run. Requires permission to access the GetSuiteRun action.","description":"GET /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"suiteDefinitionId","in":"query","required":true,"description":"Suite definition ID for the test suite run.","schema":{"type":"string","description":"Suite definition ID for the test suite run."}},{"name":"suiteRunId","in":"query","required":true,"description":"Suite run ID for the test suite run.","schema":{"type":"string","description":"Suite run ID for the test suite run."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/get-suite-run-report":{"get":{"operationId":"cloud_amazonaws_iotdeviceadvisor_get_suite_run_report","summary":"Gets a report download link for a successful Device Advisor qualifying test suite run. Requires permission…","description":"GET /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/report","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"suiteDefinitionId","in":"query","required":true,"description":"Suite definition ID of the test suite.","schema":{"type":"string","description":"Suite definition ID of the test suite."}},{"name":"suiteRunId","in":"query","required":true,"description":"Suite run ID of the test suite run.","schema":{"type":"string","description":"Suite run ID of the test suite run."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/list-suite-runs":{"get":{"operationId":"cloud_amazonaws_iotdeviceadvisor_list_suite_runs","summary":"Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs…","description":"GET /suiteRuns","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"suiteDefinitionId","in":"query","required":false,"description":"Lists the test suite runs of the specified test suite based on suite definition ID.","schema":{"type":"string","description":"Lists the test suite runs of the specified test suite based on suite definition ID."}},{"name":"suiteDefinitionVersion","in":"query","required":false,"description":"Must be passed along with suiteDefinitionId . Lists the test suite runs of the specified test suite based on suite definition version.","schema":{"type":"string","description":"Must be passed along with suiteDefinitionId . Lists the test suite runs of the specified test suite based on suite definition version."}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of results to return at once.","schema":{"type":"integer","description":"The maximum number of results to return at once."}},{"name":"nextToken","in":"query","required":false,"description":"A token to retrieve the next set of results.","schema":{"type":"string","description":"A token to retrieve the next set of results."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/list-tags-for-resource":{"get":{"operationId":"cloud_amazonaws_iotdeviceadvisor_list_tags_for_resource","summary":"Lists the tags attached to an IoT Device Advisor resource. Requires permission to access the…","description":"GET /tags/{resourceArn}","tags":["cloud"],"parameters":[{"name":"region","in":"query","required":false,"description":"The AWS region","schema":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"}},{"name":"resourceArn","in":"query","required":true,"description":"The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN.","schema":{"type":"string","description":"The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/tag-resource":{"post":{"operationId":"cloud_amazonaws_iotdeviceadvisor_tag_resource","summary":"Adds to and modifies existing tags of an IoT Device Advisor resource. Requires permission to access the…","description":"POST /tags/{resourceArn}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceArn","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"resourceArn":{"type":"string","description":"The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/start-suite-run":{"post":{"operationId":"cloud_amazonaws_iotdeviceadvisor_start_suite_run","summary":"Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.","description":"POST /suiteDefinitions/{suiteDefinitionId}/suiteRuns","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suiteDefinitionId","body"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"suiteDefinitionId":{"type":"string","description":"Suite definition ID of the test suite."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/stop-suite-run":{"post":{"operationId":"cloud_amazonaws_iotdeviceadvisor_stop_suite_run","summary":"Stops a Device Advisor test suite run that is currently running. Requires permission to access the…","description":"POST /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suiteDefinitionId","suiteRunId"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"suiteDefinitionId":{"type":"string","description":"Suite definition ID of the test suite run to be stopped."},"suiteRunId":{"type":"string","description":"Suite run ID of the test suite run to be stopped."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:amazonaws-iotdeviceadvisor/untag-resource":{"post":{"operationId":"cloud_amazonaws_iotdeviceadvisor_untag_resource","summary":"Removes tags from an IoT Device Advisor resource. Requires permission to access the UntagResource action.","description":"DELETE /tags/{resourceArn}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["resourceArn","tagKeys"],"properties":{"region":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1","description":"The AWS region"},"resourceArn":{"type":"string","description":"The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or SuiteRun ARN."},"tagKeys":{"type":"array","description":"List of tag keys to remove from the IoT Device Advisor resource."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}