suite_definitions

Creates, updates, deletes, gets or lists a suite_definitions resource.

Overview

Name	suite_definitions
Type	Resource
Id	aws.iotdeviceadvisor.suite_definitions

Fields

The following fields are returned by SELECT queries:

get_suite_definition

Name	Datatype	Description
created_at	string (date-time)	Date (in Unix epoch time) when the suite definition was created.
last_modified_at	string (date-time)	Date (in Unix epoch time) when the suite definition was last modified.
latest_version	string	Latest suite definition version of the suite definition.
suite_definition_arn	string	The ARN of the suite definition.
suite_definition_configuration	object	Gets the suite definition configuration.
suite_definition_id	string	Suite definition ID of the suite definition.
suite_definition_version	string	Suite definition version of the suite definition.
tags	object	Tags attached to the suite definition.

list_suite_definitions

Name	Datatype	Description
next_token	string	A token used to get the next set of results.
suite_definition_information_list	array	An array of objects that provide summaries of information about the suite definitions in the list.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_suite_definition	select	suite_definition_id, region	suiteDefinitionVersion	Gets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action.
list_suite_definitions	select	region	maxResults, nextToken	Lists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.
create_suite_definition	insert	region, suiteDefinitionConfiguration		Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.
update_suite_definition	update	suite_definition_id, region, suiteDefinitionConfiguration		Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.
delete_suite_definition	delete	suite_definition_id, region		Deletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.
start_suite_run	exec	suite_definition_id, region, suiteRunConfiguration		Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.
stop_suite_run	exec	suite_definition_id, suite_run_id, region		Stops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
suite_definition_id	string	Suite definition ID of the test suite run to be stopped.
suite_run_id	string	Suite run ID of the test suite run to be stopped.
maxResults	integer	The maximum number of results to return at once.
nextToken	string	A token used to get the next set of results.
suiteDefinitionVersion	string	Suite definition version of the test suite to get.

SELECT examples

get_suite_definition

Gets information about a Device Advisor test suite. Requires permission to access the GetSuiteDefinition action.

SELECT
created_at,
last_modified_at,
latest_version,
suite_definition_arn,
suite_definition_configuration,
suite_definition_id,
suite_definition_version,
tags
FROM aws.iotdeviceadvisor.suite_definitions
WHERE suite_definition_id = '{{ suite_definition_id }}' -- required
AND region = '{{ region }}' -- required
AND suiteDefinitionVersion = '{{ suiteDefinitionVersion }}'
;

list_suite_definitions

Lists the Device Advisor test suites you have created. Requires permission to access the ListSuiteDefinitions action.

SELECT
next_token,
suite_definition_information_list
FROM aws.iotdeviceadvisor.suite_definitions
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_suite_definition

Creates a Device Advisor test suite. Requires permission to access the CreateSuiteDefinition action.

INSERT INTO aws.iotdeviceadvisor.suite_definitions (
suiteDefinitionConfiguration,
tags,
clientToken,
region
)
SELECT 
'{{ suiteDefinitionConfiguration }}' /* required */,
'{{ tags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
created_at,
suite_definition_arn,
suite_definition_id,
suite_definition_name
;

Manifest

# Description fields are for documentation purposes
- name: suite_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the suite_definitions resource.
  - name: suiteDefinitionConfiguration
    description: |
      Gets the suite definition configuration.
    value:
      suiteDefinitionName: "{{ suiteDefinitionName }}"
      devices:
        - thingArn: "{{ thingArn }}"
          certificateArn: "{{ certificateArn }}"
          deviceRoleArn: "{{ deviceRoleArn }}"
      intendedForQualification: {{ intendedForQualification }}
      isLongDurationTest: {{ isLongDurationTest }}
      rootGroup: "{{ rootGroup }}"
      devicePermissionRoleArn: "{{ devicePermissionRoleArn }}"
      protocol: "{{ protocol }}"
  - name: tags
    value: "{{ tags }}"
  - name: clientToken
    value: "{{ clientToken }}"

UPDATE examples

update_suite_definition

Updates a Device Advisor test suite. Requires permission to access the UpdateSuiteDefinition action.

UPDATE aws.iotdeviceadvisor.suite_definitions
SET 
suiteDefinitionConfiguration = '{{ suiteDefinitionConfiguration }}'
WHERE 
suite_definition_id = '{{ suite_definition_id }}' --required
AND region = '{{ region }}' --required
AND suiteDefinitionConfiguration = '{{ suiteDefinitionConfiguration }}' --required
RETURNING
created_at,
last_updated_at,
suite_definition_arn,
suite_definition_id,
suite_definition_name,
suite_definition_version;

DELETE examples

delete_suite_definition

Deletes a Device Advisor test suite. Requires permission to access the DeleteSuiteDefinition action.

DELETE FROM aws.iotdeviceadvisor.suite_definitions
WHERE suite_definition_id = '{{ suite_definition_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_suite_run

Starts a Device Advisor test suite run. Requires permission to access the StartSuiteRun action.

EXEC aws.iotdeviceadvisor.suite_definitions.start_suite_run 
@suite_definition_id='{{ suite_definition_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"suiteDefinitionVersion": "{{ suiteDefinitionVersion }}", 
"suiteRunConfiguration": "{{ suiteRunConfiguration }}", 
"tags": "{{ tags }}"
}'
;

stop_suite_run

Stops a Device Advisor test suite run that is currently running. Requires permission to access the StopSuiteRun action.

EXEC aws.iotdeviceadvisor.suite_definitions.stop_suite_run 
@suite_definition_id='{{ suite_definition_id }}' --required, 
@suite_run_id='{{ suite_run_id }}' --required, 
@region='{{ region }}' --required
;