Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_suite_definition

get_suite_definition(**kwargs)

Gets information about a Device Advisor test suite.

Requires permission to access the GetSuiteDefinition action.

See also: AWS API Documentation

Request Syntax

response = client.get_suite_definition(
    suiteDefinitionId='string',
    suiteDefinitionVersion='string'
)
Parameters
  • suiteDefinitionId (string) --

    [REQUIRED]

    Suite definition ID of the test suite to get.

  • suiteDefinitionVersion (string) -- Suite definition version of the test suite to get.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • suiteDefinitionId (string) --

      Suite definition ID of the suite definition.

    • suiteDefinitionArn (string) --

      The ARN of the suite definition.

    • suiteDefinitionVersion (string) --

      Suite definition version of the suite definition.

    • latestVersion (string) --

      Latest suite definition version of the suite definition.

    • suiteDefinitionConfiguration (dict) --

      Suite configuration of the suite definition.

      • suiteDefinitionName (string) --

        Gets the suite definition name. This is a required parameter.

      • devices (list) --

        Gets the devices configured.

        • (dict) --

          Information of a test device. A thing ARN or a certificate ARN is required.

          • thingArn (string) --

            Lists devices thing ARN.

          • certificateArn (string) --

            Lists devices certificate ARN.

      • intendedForQualification (boolean) --

        Gets the tests intended for qualification in a suite.

      • isLongDurationTest (boolean) --

        Verifies if the test suite is a long duration test.

      • rootGroup (string) --

        Gets the test suite root group. This is a required parameter.

      • devicePermissionRoleArn (string) --

        Gets the device permission ARN. This is a required parameter.

      • protocol (string) --

        Sets the MQTT protocol that is configured in the suite definition.

    • createdAt (datetime) --

      Date (in Unix epoch time) when the suite definition was created.

    • lastModifiedAt (datetime) --

      Date (in Unix epoch time) when the suite definition was last modified.

    • tags (dict) --

      Tags attached to the suite definition.

      • (string) --
        • (string) --

Exceptions

  • IoTDeviceAdvisor.Client.exceptions.ValidationException
  • IoTDeviceAdvisor.Client.exceptions.InternalServerException
  • IoTDeviceAdvisor.Client.exceptions.ResourceNotFoundException