Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListLibraryItems

Lists the library items for Amazon Q Apps that are published and available for users in your AWS account.

Request Syntax


GET /catalog.list?categoryId=categoryId&limit=limit&nextToken=nextToken HTTP/1.1
instance-id: instanceId

URI Request Parameters

The request uses the following URI parameters.

categoryId

Optional category to filter the library items by.

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

instanceId

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

Required: Yes

limit

The maximum number of library items to return in the response.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token to request the next page of results.

Length Constraints: Minimum length of 0. Maximum length of 300.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "libraryItems": [ 
      { 
         "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
      }
   ],
   "nextToken": "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.

libraryItems

The list of library items meeting the request criteria.

Type: Array of LibraryItemMember objects

nextToken

The token to use to request the next page of results.

Type: String

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

InternalServerException

An internal service error occurred while processing the request.

retryAfterSeconds: The number of seconds to wait before retrying the operation

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

resourceId: The unique identifier of the resource
resourceType: The type of the resource

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.

quotaCode: The code of the quota that was exceeded
retryAfterSeconds: The number of seconds to wait before retrying the operation
serviceCode: The code for the service where the quota was exceeded

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