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

CreateLibraryItem

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

Request Syntax


POST /catalog.createItem HTTP/1.1
instance-id: instanceId
Content-type: application/json

{
   "appId": "string",
   "appVersion": number,
   "categories": [ "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.

appId

The unique identifier of the Amazon Q App to publish to the library.

Type: String

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

Required: Yes

appVersion

The version of the Amazon Q App to publish to the library.

Type: Integer

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

Required: Yes

categories

The categories to associate with the library item for easier discovery.

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: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "isVerified": boolean,
   "libraryItemId": "string",
   "ratingCount": number,
   "status": "string",
   "updatedAt": "string",
   "updatedBy": "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.

createdAt

The date and time the library item was created.

Type: Timestamp

createdBy

The user who created the library item.

Type: String

isVerified

Indicates whether the library item has been verified.

Type: Boolean

libraryItemId

The unique identifier of the new 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 from users.

Type: Integer

status

The status of the new library item, such as "Published".

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

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

ServiceQuotaExceededException

The requested operation could not be completed because it would exceed the service's quota or limit.

quotaCode: The code of the quota that was exceeded
resourceId: The unique identifier of the resource
resourceType: The type of the resource
serviceCode: The code for the service where the quota was exceeded

HTTP Status Code: 402

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