UpdateFleet - AWS IoT FleetWise

UpdateFleet

Updates the description of an existing fleet.

Request Syntax

{ "description": "string", "fleetId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

description

An updated description of the fleet.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

Required: No

fleetId

The ID of the fleet to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9:_-]+

Required: Yes

Response Syntax

{ "arn": "string", "id": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The Amazon Resource Name (ARN) of the updated fleet.

Type: String

id

The ID of the updated fleet.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9:_-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

ConflictException

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

resource

The resource on which there are conflicting operations.

resourceType

The type of resource on which there are conflicting operations..

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

retryAfterSeconds

The number of seconds to wait before retrying the command.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

resourceId

The identifier of the resource that wasn't found.

resourceType

The type of resource that wasn't found.

HTTP Status Code: 400

ThrottlingException

The request couldn't be completed due to throttling.

quotaCode

The quota identifier of the applied throttling rules for this request.

retryAfterSeconds

The number of seconds to wait before retrying the command.

serviceCode

The code for the service that couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList

The list of fields that fail to satisfy the constraints specified by an AWS service.

reason

The reason the input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: