Own AWS? Customize your docs with AI search, analytics, and more.

GET

/suiteRuns

http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns

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 <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteRuns</a> action.

Access Token Required: API Key

Query Params

suiteDefinitionIdstring

Lists the test suite runs of the specified test suite based on suite definition ID.

suiteDefinitionVersionstring

Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of the specified test suite based on suite definition version.

maxResultsinteger

The maximum number of results to return at once.

nextTokenstring

A token to retrieve the next set of results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/suiteRuns

http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns

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 <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteRuns</a> action.

Access Token Required: API Key

Query Params

suiteDefinitionIdstring

Lists the test suite runs of the specified test suite based on suite definition ID.

suiteDefinitionVersionstring

Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of the specified test suite based on suite definition version.

maxResultsinteger

The maximum number of results to return at once.

nextTokenstring

A token to retrieve the next set of results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/suiteRuns

http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns

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 <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteRuns</a> action.

Access Token Required: API Key

Query Params

suiteDefinitionIdstring

Lists the test suite runs of the specified test suite based on suite definition ID.

suiteDefinitionVersionstring

Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of the specified test suite based on suite definition version.

maxResultsinteger

The maximum number of results to return at once.

nextTokenstring

A token to retrieve the next set of results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/suiteRuns

http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns

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 <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSuiteRuns</a> action.

Access Token Required: API Key

Query Params

suiteDefinitionIdstring

Lists the test suite runs of the specified test suite based on suite definition ID.

suiteDefinitionVersionstring

Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of the specified test suite based on suite definition version.

maxResultsinteger

The maximum number of results to return at once.

nextTokenstring

A token to retrieve the next set of results.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://api.iotdeviceadvisor.{region}.amazonaws.com/suiteRuns' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}