AWS API Changes

2020/12/15 - AWS IoT Core Device Advisor - 13 new api methods

Changes AWS IoT Core Device Advisor is fully managed test capability for IoT devices. Device manufacturers can use Device Advisor to test their IoT devices for reliable and secure connectivity with AWS IoT.

GetSuiteRun (new)

Link ¶

Gets information about a Device Advisor test suite run.

See also: AWS API Documentation

Request Syntax

client.get_suite_run(
    suiteDefinitionId='string',
    suiteRunId='string'
)

type suiteDefinitionId

string

param suiteDefinitionId

[REQUIRED]

Requests the information about Device Advisor test suite run based on suite definition Id.

type suiteRunId

string

param suiteRunId

[REQUIRED]

Requests the information about Device Advisor test suite run based on suite run Id.

rtype

dict

returns

Response Syntax

{
    'suiteDefinitionId': 'string',
    'suiteDefinitionVersion': 'string',
    'suiteRunId': 'string',
    'suiteRunArn': 'string',
    'suiteRunConfiguration': {
        'primaryDevice': {
            'thingArn': 'string',
            'certificateArn': 'string'
        },
        'secondaryDevice': {
            'thingArn': 'string',
            'certificateArn': 'string'
        },
        'selectedTestList': [
            'string',
        ]
    },
    'testResult': {
        'groups': [
            {
                'groupId': 'string',
                'groupName': 'string',
                'tests': [
                    {
                        'testCaseRunId': 'string',
                        'testCaseDefinitionId': 'string',
                        'testCaseDefinitionName': 'string',
                        'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'PASS_WITH_WARNINGS'|'ERROR',
                        'startTime': datetime(2015, 1, 1),
                        'endTime': datetime(2015, 1, 1),
                        'logUrl': 'string',
                        'warnings': 'string',
                        'failure': 'string'
                    },
                ]
            },
        ]
    },
    'startTime': datetime(2015, 1, 1),
    'endTime': datetime(2015, 1, 1),
    'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'PASS_WITH_WARNINGS'|'ERROR',
    'errorReason': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- suiteDefinitionId (string) --
  
  Gets the information about Device Advisor test suite run based on suite definition Id.
- suiteDefinitionVersion (string) --
  
  Gets the information about Device Advisor test suite run based on suite definition version.
- suiteRunId (string) --
  
  Gets the information about Device Advisor test suite run based on suite run Id.
- suiteRunArn (string) --
  
  The ARN of the suite run.
- suiteRunConfiguration (dict) --
  
  Gets the information about Device Advisor test suite run based on suite configuration.
  - primaryDevice (dict) --
    
    Gets the primary device for suite run.
    - thingArn (string) --
      
      Lists devices thing arn
    - certificateArn (string) --
      
      Lists devices certificate arn
  - secondaryDevice (dict) --
    
    Gets the secondary device for suite run.
    - thingArn (string) --
      
      Lists devices thing arn
    - certificateArn (string) --
      
      Lists devices certificate arn
  - selectedTestList (list) --
    
    Gets test case list.
    - (string) --
- testResult (dict) --
  
  Gets the information about Device Advisor test suite run based on test case runs.
  - groups (list) --
    
    Show each group of test results.
    - (dict) --
      
      Show Group Result.
      - groupId (string) --
        
        Show Group Result Id.
      - groupName (string) --
        
        Show Group Result Name.
      - tests (list) --
        
        Show Group Result.
        
        (dict) --
        
        Provides test case run.
        
        testCaseRunId (string) --
        
        Provides test case run Id.
        
        testCaseDefinitionId (string) --
        
        Provides test case run definition Id.
        
        testCaseDefinitionName (string) --
        
        Provides test case run definition Name.
        
        status (string) --
        
        Provides test case run status.
        
        startTime (datetime) --
        
        Provides test case run start time.
        
        endTime (datetime) --
        
        Provides test case run end time.
        
        logUrl (string) --
        
        Provides test case run log Url.
        
        warnings (string) --
        
        Provides test case run warnings.
        
        failure (string) --
        
        Provides test case run failure result.
- startTime (datetime) --
  
  Gets the information about Device Advisor test suite run based on start time.
- endTime (datetime) --
  
  Gets the information about Device Advisor test suite run based on end time.
- status (string) --
  
  Gets the information about Device Advisor test suite run based on its status.
- errorReason (string) --
  
  Gets the information about Device Advisor test suite run based on error.
- tags (dict) --
  
  The tags attached to the suite run.
  - (string) --
    - (string) --

ListSuiteRuns (new)

Link ¶

Lists the runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

See also: AWS API Documentation

Request Syntax

client.list_suite_runs(
    suiteDefinitionId='string',
    suiteDefinitionVersion='string',
    maxResults=123,
    nextToken='string'
)

type suiteDefinitionId

string

param suiteDefinitionId

Lists the runs of the specified Device Advisor test suite based on suite definition Id.

type suiteDefinitionVersion

string

param suiteDefinitionVersion

Lists the runs of the specified Device Advisor test suite based on suite definition version.

type maxResults

integer

param maxResults

MaxResults for list suite run API request.

type nextToken

string

param nextToken

Next pagination token for list suite run request.

rtype

dict

returns

Response Syntax

{
    'suiteRunsList': [
        {
            'suiteDefinitionId': 'string',
            'suiteDefinitionVersion': 'string',
            'suiteDefinitionName': 'string',
            'suiteRunId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'endAt': datetime(2015, 1, 1),
            'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'PASS_WITH_WARNINGS'|'ERROR',
            'passed': 123,
            'failed': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- suiteRunsList (list) --
  
  Lists the runs of the specified Device Advisor test suite.
  - (dict) --
    
    Get suite run information.
    - suiteDefinitionId (string) --
      
      Get suite run information based on suite definition Id.
    - suiteDefinitionVersion (string) --
      
      Get suite run information based on suite definition version.
    - suiteDefinitionName (string) --
      
      Get suite run information based on suite definition name.
    - suiteRunId (string) --
      
      Get suite run information based on suite run Id.
    - createdAt (datetime) --
      
      Get suite run information based on time suite was created.
    - startedAt (datetime) --
      
      Get suite run information based on start time of the run.
    - endAt (datetime) --
      
      Get suite run information based on end time of the run.
    - status (string) --
      
      Get suite run information based on test run status.
    - passed (integer) --
      
      Get suite run information based on result of the test suite run.
    - failed (integer) --
      
      Get suite run information based on result of the test suite run.
- nextToken (string) --
  
  Next pagination token for list suite run response.

StartSuiteRun (new)

Link ¶

Starts a Device Advisor test suite run.

See also: AWS API Documentation

Request Syntax

client.start_suite_run(
    suiteDefinitionId='string',
    suiteDefinitionVersion='string',
    suiteRunConfiguration={
        'primaryDevice': {
            'thingArn': 'string',
            'certificateArn': 'string'
        },
        'secondaryDevice': {
            'thingArn': 'string',
            'certificateArn': 'string'
        },
        'selectedTestList': [
            'string',
        ]
    },
    tags={
        'string': 'string'
    }
)

type suiteDefinitionId

string

param suiteDefinitionId

[REQUIRED]

Request to start suite run based on suite definition Id.

type suiteDefinitionVersion

string

param suiteDefinitionVersion

Request to start suite run based on suite definition version.

type suiteRunConfiguration

dict

param suiteRunConfiguration

Request to start suite run based on suite configuration.

primaryDevice (dict) --

Gets the primary device for suite run.
- thingArn (string) --
  
  Lists devices thing arn
- certificateArn (string) --
  
  Lists devices certificate arn
secondaryDevice (dict) --

Gets the secondary device for suite run.
- thingArn (string) --
  
  Lists devices thing arn
- certificateArn (string) --
  
  Lists devices certificate arn
selectedTestList (list) --

Gets test case list.
- (string) --

type tags

dict

param tags

The tags to be attached to the suite run.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'suiteRunId': 'string',
    'suiteRunArn': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- suiteRunId (string) --
  
  Starts a Device Advisor test suite run based on suite Run Id.
- suiteRunArn (string) --
  
  Starts a Device Advisor test suite run based on suite run arn.
- createdAt (datetime) --
  
  Starts a Device Advisor test suite run based on suite create time.

CreateSuiteDefinition (new)

Link ¶

Creates a Device Advisor test suite.

See also: AWS API Documentation

Request Syntax

client.create_suite_definition(
    suiteDefinitionConfiguration={
        'suiteDefinitionName': 'string',
        'devices': [
            {
                'thingArn': 'string',
                'certificateArn': 'string'
            },
        ],
        'intendedForQualification': True|False,
        'rootGroup': 'string',
        'devicePermissionRoleArn': 'string'
    },
    tags={
        'string': 'string'
    }
)

type suiteDefinitionConfiguration

dict

param suiteDefinitionConfiguration

Creates a Device Advisor test suite with suite definition configuration.

suiteDefinitionName (string) --

Gets Suite Definition Configuration name.
devices (list) --

Gets the devices configured.
- (dict) --
  
  Lists all the devices under test
  - thingArn (string) --
    
    Lists devices thing arn
  - certificateArn (string) --
    
    Lists devices certificate arn
intendedForQualification (boolean) --

Gets the tests intended for qualification in a suite.
rootGroup (string) --

Gets test suite root group.
devicePermissionRoleArn (string) --

Gets device permission arn.

type tags

dict

param tags

The tags to be attached to the suite definition.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'suiteDefinitionId': 'string',
    'suiteDefinitionArn': 'string',
    'suiteDefinitionName': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- suiteDefinitionId (string) --
  
  Creates a Device Advisor test suite with suite UUID.
- suiteDefinitionArn (string) --
  
  Creates a Device Advisor test suite with Amazon Resource name.
- suiteDefinitionName (string) --
  
  Creates a Device Advisor test suite with suite definition name.
- createdAt (datetime) --
  
  Creates a Device Advisor test suite with TimeStamp of when it was created.

TagResource (new)

Link ¶

Adds to and modifies existing tags of an IoT Device Advisor resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn

string

param resourceArn

[REQUIRED]

The resource ARN of an IoT Device Advisor resource.

type tags

dict

param tags

[REQUIRED]

The tags to be attached to the IoT Device Advisor resource.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetSuiteRunReport (new)

Link ¶

Gets a report download link for a successful Device Advisor qualifying test suite run.

See also: AWS API Documentation

Request Syntax

client.get_suite_run_report(
    suiteDefinitionId='string',
    suiteRunId='string'
)

type suiteDefinitionId

string

param suiteDefinitionId

[REQUIRED]

Device Advisor suite definition Id.

type suiteRunId

string

param suiteRunId

[REQUIRED]

Device Advisor suite run Id.

rtype

dict

returns

Response Syntax

{
    'qualificationReportDownloadUrl': 'string'
}

Response Structure

(dict) --
- qualificationReportDownloadUrl (string) --
  
  Gets the download URL of the qualification report.

ListSuiteDefinitions (new)

Link ¶

Lists the Device Advisor test suites you have created.

See also: AWS API Documentation

Request Syntax

client.list_suite_definitions(
    maxResults=123,
    nextToken='string'
)

type maxResults

integer

param maxResults

Request the list of all the Device Advisor test suites.

type nextToken

string

param nextToken

Requests the Device Advisor test suites next token.

rtype

dict

returns

Response Syntax

{
    'suiteDefinitionInformationList': [
        {
            'suiteDefinitionId': 'string',
            'suiteDefinitionName': 'string',
            'defaultDevices': [
                {
                    'thingArn': 'string',
                    'certificateArn': 'string'
                },
            ],
            'intendedForQualification': True|False,
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- suiteDefinitionInformationList (list) --
  
  Lists test suite information using List suite definition.
  - (dict) --
    
    Get suite definition information.
    - suiteDefinitionId (string) --
      
      Get suite definition Id.
    - suiteDefinitionName (string) --
      
      Get test suite name.
    - defaultDevices (list) --
      
      Specifies the devices under test.
      - (dict) --
        
        Lists all the devices under test
        
        thingArn (string) --
        
        Lists devices thing arn
        
        certificateArn (string) --
        
        Lists devices certificate arn
    - intendedForQualification (boolean) --
      
      Gets the test suites which will be used for qualification.
    - createdAt (datetime) --
      
      Gets the information of when the test suite was created.
- nextToken (string) --
  
  Creates a Device Advisor test suite.

UpdateSuiteDefinition (new)

Link ¶

Updates a Device Advisor test suite.

See also: AWS API Documentation

Request Syntax

client.update_suite_definition(
    suiteDefinitionId='string',
    suiteDefinitionConfiguration={
        'suiteDefinitionName': 'string',
        'devices': [
            {
                'thingArn': 'string',
                'certificateArn': 'string'
            },
        ],
        'intendedForQualification': True|False,
        'rootGroup': 'string',
        'devicePermissionRoleArn': 'string'
    }
)

type suiteDefinitionId

string

param suiteDefinitionId

[REQUIRED]

Updates a Device Advisor test suite with suite definition id.

type suiteDefinitionConfiguration

dict

param suiteDefinitionConfiguration

Updates a Device Advisor test suite with suite definition configuration.

suiteDefinitionName (string) --

Gets Suite Definition Configuration name.
devices (list) --

Gets the devices configured.
- (dict) --
  
  Lists all the devices under test
  - thingArn (string) --
    
    Lists devices thing arn
  - certificateArn (string) --
    
    Lists devices certificate arn
intendedForQualification (boolean) --

Gets the tests intended for qualification in a suite.
rootGroup (string) --

Gets test suite root group.
devicePermissionRoleArn (string) --

Gets device permission arn.

rtype

dict

returns

Response Syntax

{
    'suiteDefinitionId': 'string',
    'suiteDefinitionArn': 'string',
    'suiteDefinitionName': 'string',
    'suiteDefinitionVersion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- suiteDefinitionId (string) --
  
  Updates a Device Advisor test suite with suite UUID.
- suiteDefinitionArn (string) --
  
  Updates a Device Advisor test suite with Amazon Resource name.
- suiteDefinitionName (string) --
  
  Updates a Device Advisor test suite with suite definition name.
- suiteDefinitionVersion (string) --
  
  Updates a Device Advisor test suite with suite definition version.
- createdAt (datetime) --
  
  Updates a Device Advisor test suite with TimeStamp of when it was created.
- lastUpdatedAt (datetime) --
  
  Updates a Device Advisor test suite with TimeStamp of when it was updated.

UntagResource (new)

Link ¶

Removes tags from an IoT Device Advisor resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn

string

param resourceArn

[REQUIRED]

The resource ARN of an IoT Device Advisor resource.

type tagKeys

list

param tagKeys

[REQUIRED]

List of tag keys to remove from the IoT Device Advisor resource.

(string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

GetSuiteDefinition (new)

Link ¶

Gets information about a Device Advisor test suite.

See also: AWS API Documentation

Request Syntax

client.get_suite_definition(
    suiteDefinitionId='string',
    suiteDefinitionVersion='string'
)

type suiteDefinitionId

string

param suiteDefinitionId

[REQUIRED]

Requests suite definition Id with GetSuiteDefinition API call.

type suiteDefinitionVersion

string

param suiteDefinitionVersion

Requests the suite definition version of a test suite.

rtype

dict

returns

Response Syntax

{
    'suiteDefinitionId': 'string',
    'suiteDefinitionArn': 'string',
    'suiteDefinitionVersion': 'string',
    'latestVersion': 'string',
    'suiteDefinitionConfiguration': {
        'suiteDefinitionName': 'string',
        'devices': [
            {
                'thingArn': 'string',
                'certificateArn': 'string'
            },
        ],
        'intendedForQualification': True|False,
        'rootGroup': 'string',
        'devicePermissionRoleArn': 'string'
    },
    'createdAt': datetime(2015, 1, 1),
    'lastModifiedAt': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- suiteDefinitionId (string) --
  
  Gets suite definition Id with GetSuiteDefinition API call.
- suiteDefinitionArn (string) --
  
  The ARN of the suite definition.
- suiteDefinitionVersion (string) --
  
  Gets suite definition version with GetSuiteDefinition API call.
- latestVersion (string) --
  
  Gets latest suite definition version with GetSuiteDefinition API call.
- suiteDefinitionConfiguration (dict) --
  
  Gets the suite configuration with GetSuiteDefinition API call.
  - suiteDefinitionName (string) --
    
    Gets Suite Definition Configuration name.
  - devices (list) --
    
    Gets the devices configured.
    - (dict) --
      
      Lists all the devices under test
      - thingArn (string) --
        
        Lists devices thing arn
      - certificateArn (string) --
        
        Lists devices certificate arn
  - intendedForQualification (boolean) --
    
    Gets the tests intended for qualification in a suite.
  - rootGroup (string) --
    
    Gets test suite root group.
  - devicePermissionRoleArn (string) --
    
    Gets device permission arn.
- createdAt (datetime) --
  
  Gets the timestamp of the time suite was created with GetSuiteDefinition API call.
- lastModifiedAt (datetime) --
  
  Gets the timestamp of the time suite was modified with GetSuiteDefinition API call.
- tags (dict) --
  
  Tags attached to the suite definition.
  - (string) --
    - (string) --

DeleteSuiteDefinition (new)

Link ¶

Deletes a Device Advisor test suite.

See also: AWS API Documentation

Request Syntax

client.delete_suite_definition(
    suiteDefinitionId='string'
)

type suiteDefinitionId

string

param suiteDefinitionId

[REQUIRED]

Deletes a Device Advisor test suite with defined suite Id.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListTagsForResource (new)

Link ¶

Lists the tags attached to an IoT Device Advisor resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn

string

param resourceArn

[REQUIRED]

The ARN of the IoT Device Advisor resource.

rtype

dict

returns

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  The tags attached to the IoT Device Advisor resource.
  - (string) --
    - (string) --

ListTestCases (new)

Link ¶

Lists all the test cases in the test suite.

See also: AWS API Documentation

Request Syntax

client.list_test_cases(
    intendedForQualification=True|False,
    maxResults=123,
    nextToken='string'
)

type intendedForQualification

boolean

param intendedForQualification

Lists all the qualification test cases in the test suite.

type maxResults

integer

param maxResults

Requests the test cases max results.

type nextToken

string

param nextToken

Requests the test cases next token.

rtype

dict

returns

Response Syntax

{
    'categories': [
        {
            'name': 'string',
            'tests': [
                {
                    'name': 'string',
                    'configuration': {
                        'string': 'string'
                    },
                    'test': {
                        'id': 'string',
                        'testCaseVersion': 'string'
                    }
                },
            ]
        },
    ],
    'rootGroupConfiguration': {
        'string': 'string'
    },
    'groupConfiguration': {
        'string': 'string'
    },
    'nextToken': 'string'
}

Response Structure

(dict) --
- categories (list) --
  
  Gets the category of test case.
  - (dict) --
    
    Gets the test case category.
    - name (string) --
      
      Lists all the tests name in the specified category.
    - tests (list) --
      
      Lists all the tests in the specified category.
      - (dict) --
        
        Shows tests in a test group.
        
        name (string) --
        
        Shows test case name.
        
        configuration (dict) --
        
        Shows test case configuration.
        
        (string) --
        
        (string) --
        
        test (dict) --
        
        Specifies a test.
        
        id (string) --
        
        Provides test case definition Id.
        
        testCaseVersion (string) --
        
        Provides test case definition version.
- rootGroupConfiguration (dict) --
  
  Gets the configuration of root test group.
  - (string) --
    - (string) --
- groupConfiguration (dict) --
  
  Gets the configuration of test group.
  - (string) --
    - (string) --
- nextToken (string) --
  
  Test cases next token response.