UpdateLibraryItem - Amazon Q Business

UpdateLibraryItem

Updates the library item for an Amazon Q App.

Request Syntax

POST /catalog.updateItem HTTP/1.1 instance-id: instanceId Content-type: application/json { "categories": [ "string" ], "libraryItemId": "string", "status": "string" }

URI Request Parameters

The request uses the following URI parameters.

instanceId

The unique identifier of the Amazon Q Business application environment instance.

Required: Yes

Request Body

The request accepts the following data in JSON format.

categories

The new categories to associate with the library item.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

Required: No

libraryItemId

The unique identifier of the library item to update.

Type: String

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

Required: Yes

status

The new status to set for the library item, such as "Published" or "Hidden".

Type: String

Valid Values: PUBLISHED | DISABLED

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "appId": "string", "appVersion": number, "categories": [ { "appCount": number, "color": "string", "id": "string", "title": "string" } ], "createdAt": "string", "createdBy": "string", "isRatedByUser": boolean, "isVerified": boolean, "libraryItemId": "string", "ratingCount": number, "status": "string", "updatedAt": "string", "updatedBy": "string", "userCount": number }

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.

appId

The unique identifier of the Q App associated with the library item.

Type: String

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

appVersion

The version of the Q App associated with the library item.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

categories

The categories associated with the updated library item.

Type: Array of Category objects

Array Members: Minimum number of 0 items. Maximum number of 3 items.

createdAt

The date and time the library item was originally created.

Type: Timestamp

createdBy

The user who originally created the library item.

Type: String

isRatedByUser

Whether the current user has rated the library item.

Type: Boolean

isVerified

Indicates whether the library item has been verified.

Type: Boolean

libraryItemId

The unique identifier of the updated library item.

Type: String

Pattern: [\da-f]{8}-[\da-f]{4}-[45][\da-f]{3}-[89ABab][\da-f]{3}-[\da-f]{12}

ratingCount

The number of ratings the library item has received.

Type: Integer

status

The new status of the updated library item.

Type: String

updatedAt

The date and time the library item was last updated.

Type: Timestamp

updatedBy

The user who last updated the library item.

Type: String

userCount

The number of users who have the associated Q App.

Type: Integer

Errors

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

AccessDeniedException

The client is not authorized to perform the requested operation.

HTTP Status Code: 403

ConflictException

The requested operation could not be completed due to a conflict with the current state of the resource.

HTTP Status Code: 409

InternalServerException

An internal service error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

ThrottlingException

The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.

HTTP Status Code: 429

UnauthorizedException

The client is not authenticated or authorized to perform the requested operation.

HTTP Status Code: 401

ValidationException

The input failed to satisfy the constraints specified by the 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: