---
title: "PATCH /suiteDefinitions/{suiteDefinitionId}"
method: PATCH
path: "/suiteDefinitions/{suiteDefinitionId}"
---

# PATCH /suiteDefinitions/{suiteDefinitionId}

`PATCH /suiteDefinitions/{suiteDefinitionId}`

Updates a Device Advisor test suite.

Requires permission to access the [UpdateSuiteDefinition](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

## Path parameters

- `suiteDefinitionId` string, required

## Request body

- object
  - `suiteDefinitionConfiguration` object, required — Gets the suite definition configuration.
    - `suiteDefinitionName` string — Gets the suite definition name. This is a required parameter.
    - `devices` DeviceUnderTest[] — Gets the devices configured.
      - `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` 'MqttV3_1_1' | 'MqttV5' — Sets the MQTT protocol that is configured in the suite definition.

## Response `200`

Success

- UpdateSuiteDefinitionResponse
  - `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` string, date-time — Timestamp of when the test suite was created.
  - `lastUpdatedAt` string, date-time — Timestamp of when the test suite was updated.

## Other responses

- `480` — ValidationException
- `481` — InternalServerException

---

[API](https://skmtc.net/aws/apis/iotdeviceadvisor.md) · [All operations](https://skmtc.net/aws/apis/iotdeviceadvisor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotdeviceadvisor/versions/9a6cea03b52e/schema)