AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotdeviceadvisor ]

update-suite-definition

Description

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition action.

See also: AWS API Documentation

Synopsis

  update-suite-definition
--suite-definition-id <value>
--suite-definition-configuration <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--suite-definition-id (string)

Suite definition ID of the test suite to be updated.

--suite-definition-configuration (structure)

Updates a Device Advisor test suite with suite definition configuration.

suiteDefinitionName -> (string)

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

devices -> (list)

Gets the devices configured.

(structure)

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

thingArn -> (string)

Lists device's thing ARN.

certificateArn -> (string)

Lists device's certificate ARN.

deviceRoleArn -> (string)

Lists device's role 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. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

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.

Shorthand Syntax:

suiteDefinitionName=string,devices=[{thingArn=string,certificateArn=string,deviceRoleArn=string},{thingArn=string,certificateArn=string,deviceRoleArn=string}],intendedForQualification=boolean,isLongDurationTest=boolean,rootGroup=string,devicePermissionRoleArn=string,protocol=string

JSON Syntax:

{
  "suiteDefinitionName": "string",
  "devices": [
    {
      "thingArn": "string",
      "certificateArn": "string",
      "deviceRoleArn": "string"
    }
    ...
  ],
  "intendedForQualification": true|false,
  "isLongDurationTest": true|false,
  "rootGroup": "string",
  "devicePermissionRoleArn": "string",
  "protocol": "MqttV3_1_1"|"MqttV5"|"MqttV3_1_1_OverWebSocket"|"MqttV5_OverWebSocket"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To update an IoT Device Advisor test suite

The following update-suite-definition example updates a device advisor test suite in the AWS IoT with the specified suite definition ID and suite definition configuration.

aws iotdeviceadvisor update-suite-definition \
    --suite-definition-id 3hsn88h4p2g5 \
    --suite-definition-configuration '{ \
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": false, \
        "rootGroup": "{\"configuration\":{},\"tests\":[{\"name\":\"MQTT Connect\",\"configuration\":{\"EXECUTION_TIMEOUT\":120},\"tests\":[{\"name\":\"MQTT_Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

Output:

{
    "suiteDefinitionId": "3hsn88h4p2g5",
    "suiteDefinitionName": "TestSuiteName",
    "suiteDefinitionVersion": "v3",
    "createdAt": "2022-11-17T14:15:56.830000-05:00",
    "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00"
}

Example 2: To update an IoT Device Advisor Qualification test suite

The following update-suite-definition example updates a device advisor qualification test suite in the AWS IoT with the specified suite definition ID and suite definition configuration.

aws iotdeviceadvisor update-suite-definition \
    --suite-definition-id txgsuolk2myj \
    --suite-definition-configuration '{
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": true, \
        "rootGroup": "", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

Output:

{
    "suiteDefinitionId": "txgsuolk2myj",
    "suiteDefinitionName": "TestSuiteName",
    "suiteDefinitionVersion": "v3",
    "createdAt": "2022-11-17T14:15:56.830000-05:00",
    "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00"
}

For more information, see UpdateSuiteDefinition in the AWS IoT API Reference.

Output

suiteDefinitionId -> (string)

Suite definition ID of the updated test suite.

suiteDefinitionArn -> (string)

Amazon Resource Name (ARN) of the updated test suite.

suiteDefinitionName -> (string)

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

suiteDefinitionVersion -> (string)

Suite definition version of the updated test suite.

createdAt -> (timestamp)

Timestamp of when the test suite was created.

lastUpdatedAt -> (timestamp)

Timestamp of when the test suite was updated.