AssociateLibraryItemReview

$result = $client->associateLibraryItemReview([/* ... */]);
$promise = $client->associateLibraryItemReviewAsync([/* ... */]);

Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.

Parameter Syntax

$result = $client->associateLibraryItemReview([
    'instanceId' => '<string>', // REQUIRED
    'libraryItemId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Increase the rating counter by 1 for the related app for this user

$result = $client->associateLibraryItemReview([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'libraryItemId' => 'cb9ecf72-8563-450d-9db9-994f98297316',
]);

AssociateQAppWithUser

$result = $client->associateQAppWithUser([/* ... */]);
$promise = $client->associateQAppWithUserAsync([/* ... */]);

This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.

Parameter Syntax

$result = $client->associateQAppWithUser([
    'appId' => '<string>', // REQUIRED
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Links an Amazon Q App to the invoker's list of apps

$result = $client->associateQAppWithUser([
    'appId' => '393e77fb-0a30-4f47-ad30-75d71aeaed8a',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

BatchCreateCategory

$result = $client->batchCreateCategory([/* ... */]);
$promise = $client->batchCreateCategoryAsync([/* ... */]);

Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

Parameter Syntax

$result = $client->batchCreateCategory([
    'categories' => [ // REQUIRED
        [
            'color' => '<string>',
            'id' => '<string>',
            'title' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Creates the categories for the library

$result = $client->batchCreateCategory([
    'categories' => [
        [
            'id' => '549abfe0-f5c4-45a2-bb9b-c05987a49c6d',
            'title' => 'HR',
        ],
        [
            'id' => '18cbebaa-196a-4aa5-a840-88d548e07f8f',
            'title' => 'Marketing',
        ],
    ],
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

BatchDeleteCategory

$result = $client->batchDeleteCategory([/* ... */]);
$promise = $client->batchDeleteCategoryAsync([/* ... */]);

Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

Parameter Syntax

$result = $client->batchDeleteCategory([
    'categories' => ['<string>', ...], // REQUIRED
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Deletes the categories in the library

$result = $client->batchDeleteCategory([
    'categories' => [
        '9c871ed4-1c41-4065-aefe-321cd4b61cf8',
    ],
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

BatchUpdateCategory

$result = $client->batchUpdateCategory([/* ... */]);
$promise = $client->batchUpdateCategoryAsync([/* ... */]);

Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see Custom labels for Amazon Q Apps.

Parameter Syntax

$result = $client->batchUpdateCategory([
    'categories' => [ // REQUIRED
        [
            'color' => '<string>',
            'id' => '<string>', // REQUIRED
            'title' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Updates the categories in the library

$result = $client->batchUpdateCategory([
    'categories' => [
        [
            'id' => '549abfe0-f5c4-45a2-bb9b-c05987a49c6d',
            'title' => 'HR Management',
        ],
        [
            'id' => '18cbebaa-196a-4aa5-a840-88d548e07f8f',
            'title' => 'Sales',
        ],
    ],
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

CreateLibraryItem

$result = $client->createLibraryItem([/* ... */]);
$promise = $client->createLibraryItemAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createLibraryItem([
    'appId' => '<string>', // REQUIRED
    'appVersion' => <integer>, // REQUIRED
    'categories' => ['<string>', ...], // REQUIRED
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'isVerified' => true || false,
    'libraryItemId' => '<string>',
    'ratingCount' => <integer>,
    'status' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Create a Library Item

$result = $client->createLibraryItem([
    'appId' => '7a11f34b-42d4-4bc8-b668-ae4a788dae1e',
    'appVersion' => 6,
    'categories' => [
        '9c871ed4-1c41-4065-aefe-321cd4b61cf8',
    ],
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

Result syntax:

[
    'createdAt' => ,
    'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'isVerified' => ,
    'libraryItemId' => 'cb9ecf72-8563-450d-9db9-994f98297316',
    'ratingCount' => 0,
    'status' => 'PUBLISHED',
    'updatedAt' => ,
    'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
]

CreatePresignedUrl

$result = $client->createPresignedUrl([/* ... */]);
$promise = $client->createPresignedUrlAsync([/* ... */]);

Creates a presigned URL for an S3 POST operation to upload a file. You can use this URL to set a default file for a FileUploadCard in a Q App definition or to provide a file for a single Q App run. The scope parameter determines how the file will be used, either at the app definition level or the app session level.

Parameter Syntax

$result = $client->createPresignedUrl([
    'appId' => '<string>', // REQUIRED
    'cardId' => '<string>', // REQUIRED
    'fileContentsSha256' => '<string>', // REQUIRED
    'fileName' => '<string>', // REQUIRED
    'instanceId' => '<string>', // REQUIRED
    'scope' => 'APPLICATION|SESSION', // REQUIRED
    'sessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'fileId' => '<string>',
    'presignedUrl' => '<string>',
    'presignedUrlExpiration' => <DateTime>,
    'presignedUrlFields' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Upload a file to a specific session

$result = $client->createPresignedUrl([
    'appId' => '4263767c-d889-4cb2-a8f6-8b649bc66af0',
    'cardId' => '82f69028-22a9-4bea-8727-0eabf58e9fed',
    'fileContentsSha256' => 'wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=',
    'fileName' => 'myFile.txt',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'scope' => 'SESSION',
    'sessionId' => '4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc',
]);

Result syntax:

[
    'fileId' => '412aa1b4-341c-45af-936d-da52f8a1a3b4',
    'presignedUrl' => 'https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/',
    'presignedUrlExpiration' => ,
    'presignedUrlFields' => [
        'x-amz-checksum-sha256' => 'wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=',
        'x-amz-server-side-encryption' => 'aws:kms',
        'x-amz-server-side-encryption-aws-kms-key-id' => '0a6a474b-f2ca-46ea-9e72-deea9077d92f',
        'x-amz-server-side-encryption-context' => 'eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9',
    ],
]

Example 2: Upload a file into a application

$result = $client->createPresignedUrl([
    'appId' => '4263767c-d889-4cb2-a8f6-8b649bc66af0',
    'cardId' => '7a11f34b-42d4-4bc8-b668-ae4a788dae1e',
    'fileContentsSha256' => 'wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=',
    'fileName' => 'anApplicationFile.txt',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'scope' => 'APPLICATION',
]);

Result syntax:

[
    'fileId' => '412aa1b4-341c-45af-936d-da52f8a1a3b4',
    'presignedUrl' => 'https://qapps-uploaded-files-us-east-1-c819fab7cf78c9205158297913deb9e0.s3.us-east-1.amazonaws.com/',
    'presignedUrlExpiration' => ,
    'presignedUrlFields' => [
        'x-amz-checksum-sha256' => 'wXY7GD8m4fmHhdtuQyBdXzNQpdCseVwBcOBIlzfm+kg=',
        'x-amz-server-side-encryption' => 'aws:kms',
        'x-amz-server-side-encryption-aws-kms-key-id' => '0a6a474b-f2ca-46ea-9e72-deea9077d92f',
        'x-amz-server-side-encryption-context' => 'eyJBUFBMSUNBVElPTl9JRCI6IjAxMjM0NTY3ODkwMSJ9',
    ],
]

CreateQApp

$result = $client->createQApp([/* ... */]);
$promise = $client->createQAppAsync([/* ... */]);

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.

Parameter Syntax

$result = $client->createQApp([
    'appDefinition' => [ // REQUIRED
        'cards' => [ // REQUIRED
            [
                'fileUpload' => [
                    'allowOverride' => true || false,
                    'fileId' => '<string>',
                    'filename' => '<string>',
                    'id' => '<string>', // REQUIRED
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'formInput' => [
                    'computeMode' => 'append|replace',
                    'id' => '<string>', // REQUIRED
                    'metadata' => [ // REQUIRED
                        'schema' => [ // REQUIRED
                        ],
                    ],
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'qPlugin' => [
                    'actionIdentifier' => '<string>',
                    'id' => '<string>', // REQUIRED
                    'pluginId' => '<string>', // REQUIRED
                    'prompt' => '<string>', // REQUIRED
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'qQuery' => [
                    'attributeFilter' => [
                        'andAllFilters' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'containsAll' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'containsAny' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'equalsTo' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'greaterThan' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'greaterThanOrEquals' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'lessThan' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'lessThanOrEquals' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'notFilter' => [...], // RECURSIVE
                        'orAllFilters' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'id' => '<string>', // REQUIRED
                    'outputSource' => 'approved-sources|llm',
                    'prompt' => '<string>', // REQUIRED
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'textInput' => [
                    'defaultValue' => '<string>',
                    'id' => '<string>', // REQUIRED
                    'placeholder' => '<string>',
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
            ],
            // ...
        ],
        'initialPrompt' => '<string>',
    ],
    'description' => '<string>',
    'instanceId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'title' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appId' => '<string>',
    'appVersion' => <integer>,
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'initialPrompt' => '<string>',
    'requiredCapabilities' => ['<string>', ...],
    'status' => 'PUBLISHED|DRAFT|DELETED',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ContentTooLargeException:

The requested operation could not be completed because the content exceeds the maximum allowed size.

ThrottlingException:

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

Examples

Example 1: A basic application with 1 text input card and 1 output card

$result = $client->createQApp([
    'appDefinition' => [
        'cards' => [
            [
                'textInput' => [
                    'type' => 'text-input',
                    'id' => '4cf94d96-8819-45c2-98cc-58c56b35c72f',
                    'title' => 'Color Base',
                ],
            ],
            [
                'qQuery' => [
                    'type' => 'q-query',
                    'id' => '18870b94-1e63-40e0-8c12-669c90ac5acc',
                    'prompt' => 'Recommend me a list of colors that go well with @4cf94d96-8819-45c2-98cc-58c56b35c72f',
                    'title' => 'Recommended Palette',
                ],
            ],
        ],
        'initialPrompt' => 'Create an app that recommend a list of colors based on input.',
    ],
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'title' => 'Color Palette Generator',
]);

Result syntax:

[
    'appArn' => 'arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appId' => '7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appVersion' => 1,
    'createdAt' => ,
    'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'initialPrompt' => 'Create an app that recommend a list of colors based on input.',
    'requiredCapabilities' => [
        'CreatorMode',
    ],
    'status' => 'DRAFT',
    'title' => 'Color Palette Generator',
    'updatedAt' => ,
    'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
]

DeleteLibraryItem

$result = $client->deleteLibraryItem([/* ... */]);
$promise = $client->deleteLibraryItemAsync([/* ... */]);

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.

Parameter Syntax

$result = $client->deleteLibraryItem([
    'instanceId' => '<string>', // REQUIRED
    'libraryItemId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Delete a library item

$result = $client->deleteLibraryItem([
    'instanceId' => '3642ba81-344c-42fd-a480-9119a5a5f26b',
    'libraryItemId' => '72088fd4-78b6-43da-bfb8-8621323c3cfb',
]);

DeleteQApp

$result = $client->deleteQApp([/* ... */]);
$promise = $client->deleteQAppAsync([/* ... */]);

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

Parameter Syntax

$result = $client->deleteQApp([
    'appId' => '<string>', // REQUIRED
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Delete an Amazon Q App

$result = $client->deleteQApp([
    'appId' => '393e77fb-0a30-4f47-ad30-75d71aeaed8a',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

DescribeQAppPermissions

$result = $client->describeQAppPermissions([/* ... */]);
$promise = $client->describeQAppPermissionsAsync([/* ... */]);

Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.

Parameter Syntax

$result = $client->describeQAppPermissions([
    'appId' => '<string>', // REQUIRED
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appId' => '<string>',
    'permissions' => [
        [
            'action' => 'read|write',
            'principal' => [
                'email' => '<string>',
                'userId' => '<string>',
                'userType' => 'owner|user',
            ],
        ],
        // ...
    ],
    'resourceArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Describe permissions for the app

$result = $client->describeQAppPermissions([
    'appId' => 'fe0acf86-49e5-4def-a0c2-40ce0cafee14',
    'instanceId' => '01793661-ad73-4c7d-8eaa-1c95a10151c2',
]);

Result syntax:

[
    'appId' => 'fe0acf86-49e5-4def-a0c2-40ce0cafee14',
    'permissions' => [
        [
            'action' => 'write',
            'principal' => [
                'email' => 'user1@example.com',
                'userId' => 'f8f15330-b091-708b-d46e-adb0d914b699',
            ],
        ],
        [
            'action' => 'read',
            'principal' => [
                'email' => 'user2@example.com',
                'userId' => 'c81133d0-10d1-70eb-aaa3-d427ea6fc0f3',
            ],
        ],
    ],
    'resourceArn' => 'arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14',
]

DisassociateLibraryItemReview

$result = $client->disassociateLibraryItemReview([/* ... */]);
$promise = $client->disassociateLibraryItemReviewAsync([/* ... */]);

Removes a rating or review previously submitted by the user for a library item.

Parameter Syntax

$result = $client->disassociateLibraryItemReview([
    'instanceId' => '<string>', // REQUIRED
    'libraryItemId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Decrease the rating counter by 1 for the related app for this user

$result = $client->disassociateLibraryItemReview([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'libraryItemId' => 'cb9ecf72-8563-450d-9db9-994f98297316',
]);

DisassociateQAppFromUser

$result = $client->disassociateQAppFromUser([/* ... */]);
$promise = $client->disassociateQAppFromUserAsync([/* ... */]);

Disassociates a Q App from a user removing the user's access to run the Q App.

Parameter Syntax

$result = $client->disassociateQAppFromUser([
    'appId' => '<string>', // REQUIRED
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Unlinks an Amazon Q App from the invoker's list of apps

$result = $client->disassociateQAppFromUser([
    'appId' => '393e77fb-0a30-4f47-ad30-75d71aeaed8a',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

ExportQAppSessionData

$result = $client->exportQAppSessionData([/* ... */]);
$promise = $client->exportQAppSessionDataAsync([/* ... */]);

Exports the collected data of a Q App data collection session.

Parameter Syntax

$result = $client->exportQAppSessionData([
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'csvFileLink' => '<string>',
    'expiresAt' => <DateTime>,
    'sessionArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

GetLibraryItem

$result = $client->getLibraryItem([/* ... */]);
$promise = $client->getLibraryItemAsync([/* ... */]);

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

Parameter Syntax

$result = $client->getLibraryItem([
    'appId' => '<string>',
    'instanceId' => '<string>', // REQUIRED
    'libraryItemId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appId' => '<string>',
    'appVersion' => <integer>,
    'categories' => [
        [
            'appCount' => <integer>,
            'color' => '<string>',
            'id' => '<string>',
            'title' => '<string>',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'isRatedByUser' => true || false,
    'isVerified' => true || false,
    'libraryItemId' => '<string>',
    'ratingCount' => <integer>,
    'status' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'userCount' => <integer>,
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Retrieve a library item

$result = $client->getLibraryItem([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'libraryItemId' => '18cbebaa-196a-4aa5-a840-88d548e07f8f',
]);

Result syntax:

[
    'appId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'appVersion' => 1,
    'categories' => [
        [
            'id' => '9c871ed4-1c41-4065-aefe-321cd4b61cf8',
            'title' => 'HR',
        ],
        [
            'id' => 'fdc4b483-c4e2-44c9-b4b2-6c850bbdb579',
            'title' => 'General',
        ],
        [
            'id' => 'c1c4e374-118c-446f-81fb-cba6225d88da',
            'title' => 'IT',
        ],
    ],
    'createdAt' => ,
    'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'isRatedByUser' => ,
    'isVerified' => ,
    'libraryItemId' => '18cbebaa-196a-4aa5-a840-88d548e07f8f',
    'ratingCount' => 0,
    'status' => 'PUBLISHED',
    'updatedAt' => ,
    'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'userCount' => 1,
]

GetQApp

$result = $client->getQApp([/* ... */]);
$promise = $client->getQAppAsync([/* ... */]);

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

Parameter Syntax

$result = $client->getQApp([
    'appId' => '<string>', // REQUIRED
    'appVersion' => <integer>,
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appDefinition' => [
        'appDefinitionVersion' => '<string>',
        'canEdit' => true || false,
        'cards' => [
            [
                'fileUpload' => [
                    'allowOverride' => true || false,
                    'dependencies' => ['<string>', ...],
                    'fileId' => '<string>',
                    'filename' => '<string>',
                    'id' => '<string>',
                    'title' => '<string>',
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                ],
                'formInput' => [
                    'computeMode' => 'append|replace',
                    'dependencies' => ['<string>', ...],
                    'id' => '<string>',
                    'metadata' => [
                        'schema' => [
                        ],
                    ],
                    'title' => '<string>',
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                ],
                'qPlugin' => [
                    'actionIdentifier' => '<string>',
                    'dependencies' => ['<string>', ...],
                    'id' => '<string>',
                    'pluginId' => '<string>',
                    'pluginType' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM|ASANA|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|JIRA_CLOUD|MICROSOFT_EXCHANGE|MICROSOFT_TEAMS|PAGERDUTY_ADVANCE|SALESFORCE_CRM|SERVICENOW_NOW_PLATFORM|SMARTSHEET|ZENDESK_SUITE',
                    'prompt' => '<string>',
                    'title' => '<string>',
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                ],
                'qQuery' => [
                    'attributeFilter' => [
                        'andAllFilters' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'containsAll' => [
                            'name' => '<string>',
                            'value' => [
                                'dateValue' => <DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'containsAny' => [
                            'name' => '<string>',
                            'value' => [
                                'dateValue' => <DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'equalsTo' => [
                            'name' => '<string>',
                            'value' => [
                                'dateValue' => <DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'greaterThan' => [
                            'name' => '<string>',
                            'value' => [
                                'dateValue' => <DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'greaterThanOrEquals' => [
                            'name' => '<string>',
                            'value' => [
                                'dateValue' => <DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'lessThan' => [
                            'name' => '<string>',
                            'value' => [
                                'dateValue' => <DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'lessThanOrEquals' => [
                            'name' => '<string>',
                            'value' => [
                                'dateValue' => <DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'notFilter' => [...], // RECURSIVE
                        'orAllFilters' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'dependencies' => ['<string>', ...],
                    'id' => '<string>',
                    'memoryReferences' => ['<string>', ...],
                    'outputSource' => 'approved-sources|llm',
                    'prompt' => '<string>',
                    'title' => '<string>',
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                ],
                'textInput' => [
                    'defaultValue' => '<string>',
                    'dependencies' => ['<string>', ...],
                    'id' => '<string>',
                    'placeholder' => '<string>',
                    'title' => '<string>',
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                ],
            ],
            // ...
        ],
    ],
    'appId' => '<string>',
    'appVersion' => <integer>,
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'initialPrompt' => '<string>',
    'requiredCapabilities' => ['<string>', ...],
    'status' => 'PUBLISHED|DRAFT|DELETED',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: A basic application with 1 text input card and 1 output card

$result = $client->getQApp([
    'appId' => '3d110749-efc3-427c-87e8-15e966e5c168',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

Result syntax:

[
    'appArn' => 'arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appDefinition' => [
        'appDefinitionVersion' => '1',
        'cards' => [
            [
                'textInput' => [
                    'type' => 'text-input',
                    'dependencies' => [
                    ],
                    'id' => '4cf94d96-8819-45c2-98cc-58c56b35c72f',
                    'title' => 'Color Base',
                ],
            ],
            [
                'qQuery' => [
                    'type' => 'q-query',
                    'dependencies' => [
                        '91e4513d-6981-454a-9329-329c9302eef4',
                    ],
                    'id' => '18870b94-1e63-40e0-8c12-669c90ac5acc',
                    'outputSource' => 'llm',
                    'prompt' => 'Recommend me a list of colors that go well with @91e4513d-6981-454a-9329-329c9302eef4 ',
                    'title' => 'Recommended Palette',
                ],
            ],
        ],
    ],
    'appId' => '7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appVersion' => 1,
    'createdAt' => ,
    'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'status' => 'DRAFT',
    'title' => 'Color Palette Generator',
    'updatedAt' => ,
    'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
]

GetQAppSession

$result = $client->getQAppSession([/* ... */]);
$promise = $client->getQAppSessionAsync([/* ... */]);

Retrieves the current state and results for an active session of an Amazon Q App.

Parameter Syntax

$result = $client->getQAppSession([
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'appVersion' => <integer>,
    'cardStatus' => [
        '<UUID>' => [
            'currentState' => 'IN_PROGRESS|WAITING|COMPLETED|ERROR',
            'currentValue' => '<string>',
            'submissions' => [
                [
                    'submissionId' => '<string>',
                    'timestamp' => <DateTime>,
                    'value' => [
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
    'latestPublishedAppVersion' => <integer>,
    'sessionArn' => '<string>',
    'sessionId' => '<string>',
    'sessionName' => '<string>',
    'status' => 'IN_PROGRESS|WAITING|COMPLETED|ERROR',
    'userIsHost' => true || false,
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Retrieves an existing session for an Amazon Q App

$result = $client->getQAppSession([
    'instanceId' => '288ae830-1df2-4871-b6c0-4314d74dadef',
    'sessionId' => '1fca878e-64c5-4dc4-b1d9-c93effed4e82',
]);

Result syntax:

[
    'cardStatus' => [
        '1e6caeac-b481-45ff-a082-8b9a4a0b72e8' => [
            'currentState' => 'COMPLETED',
            'currentValue' => 'Based on the responses, the most popular color is red, with 1 vote from the user "user1".',
        ],
        '6fb5b404-3b7b-48a4-8a8b-56406922a606' => [
            'currentState' => 'COMPLETED',
            'currentValue' => '',
            'submissions' => [
                [
                    'value' => [
                    ],
                    'submissionId' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479',
                    'timestamp' => ,
                ],
            ],
        ],
    ],
    'sessionArn' => 'arn:aws:qapps:us-west-2:0123456789012:application/a929ecd6-5765-4ec7-bd3e-2ca90098b18e/qapp/65e7dce7-226a-47f9-b689-22850becef89/session/1fca878e-64c5-4dc4-b1d9-c93effed4e82',
    'sessionId' => '1fca878e-64c5-4dc4-b1d9-c93effed4e82',
    'status' => 'COMPLETED',
]

GetQAppSessionMetadata

$result = $client->getQAppSessionMetadata([/* ... */]);
$promise = $client->getQAppSessionMetadataAsync([/* ... */]);

Retrieves the current configuration of a Q App session.

Parameter Syntax

$result = $client->getQAppSessionMetadata([
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'sessionArn' => '<string>',
    'sessionId' => '<string>',
    'sessionName' => '<string>',
    'sessionOwner' => true || false,
    'sharingConfiguration' => [
        'acceptResponses' => true || false,
        'enabled' => true || false,
        'revealCards' => true || false,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Retrieves an existing session metadata for an Amazon Q App

$result = $client->getQAppSessionMetadata([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'sessionId' => '56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb',
]);

Result syntax:

[
    'sessionArn' => 'arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb',
    'sessionId' => '56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb',
    'sessionName' => 'Trip itinerary collection session',
    'sessionOwner' => 1,
    'sharingConfiguration' => [
        'acceptResponses' => 1,
        'enabled' => 1,
        'revealCards' => ,
    ],
]

ImportDocument

$result = $client->importDocument([/* ... */]);
$promise = $client->importDocumentAsync([/* ... */]);

Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.

Parameter Syntax

$result = $client->importDocument([
    'appId' => '<string>', // REQUIRED
    'cardId' => '<string>', // REQUIRED
    'fileContentsBase64' => '<string>', // REQUIRED
    'fileName' => '<string>', // REQUIRED
    'instanceId' => '<string>', // REQUIRED
    'scope' => 'APPLICATION|SESSION', // REQUIRED
    'sessionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'fileId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ContentTooLargeException:

The requested operation could not be completed because the content exceeds the maximum allowed size.

ThrottlingException:

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

Examples

Example 1: Upload a file to a specific session

$result = $client->importDocument([
    'appId' => '4263767c-d889-4cb2-a8f6-8b649bc66af0',
    'cardId' => '82f69028-22a9-4bea-8727-0eabf58e9fed',
    'fileContentsBase64' => 'data:text/plain;base64,SomeFileEncodedInBase64',
    'fileName' => 'myFile.txt',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'scope' => 'SESSION',
    'sessionId' => '4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc',
]);

Result syntax:

[
    'fileId' => '412aa1b4-341c-45af-936d-da52f8a1a3b4',
]

Example 2: Upload a file into a application

$result = $client->importDocument([
    'appId' => '4263767c-d889-4cb2-a8f6-8b649bc66af0',
    'cardId' => '7a11f34b-42d4-4bc8-b668-ae4a788dae1e',
    'fileContentsBase64' => 'data:text/plain;base64,SomeFileEncodedInBase64',
    'fileName' => 'anApplicationFile.txt',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'scope' => 'APPLICATION',
]);

Result syntax:

[
    'fileId' => 'bc1a0cc9-076a-4e82-9a6c-f4d2d8a22489',
]

ListCategories

$result = $client->listCategories([/* ... */]);
$promise = $client->listCategoriesAsync([/* ... */]);

Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps.

Parameter Syntax

$result = $client->listCategories([
    'instanceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'categories' => [
        [
            'appCount' => <integer>,
            'color' => '<string>',
            'id' => '<string>',
            'title' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: List categories available for the library items in this instance

$result = $client->listCategories([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

Result syntax:

[
    'categories' => [
        [
            'appCount' => 10,
            'color' => '#FF6600',
            'id' => '549abfe0-f5c4-45a2-bb9b-c05987a49c6d',
            'title' => 'HR',
        ],
        [
            'appCount' => 11,
            'color' => '#FFFF00',
            'id' => '18cbebaa-196a-4aa5-a840-88d548e07f8f',
            'title' => 'Marketing',
        ],
    ],
]

ListLibraryItems

$result = $client->listLibraryItems([/* ... */]);
$promise = $client->listLibraryItemsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listLibraryItems([
    'categoryId' => '<string>',
    'instanceId' => '<string>', // REQUIRED
    'limit' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'libraryItems' => [
        [
            'appId' => '<string>',
            'appVersion' => <integer>,
            'categories' => [
                [
                    'appCount' => <integer>,
                    'color' => '<string>',
                    'id' => '<string>',
                    'title' => '<string>',
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'isRatedByUser' => true || false,
            'isVerified' => true || false,
            'libraryItemId' => '<string>',
            'ratingCount' => <integer>,
            'status' => '<string>',
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
            'userCount' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: List at most 3 library items for this instance

$result = $client->listLibraryItems([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'limit' => 3,
]);

Result syntax:

[
    'libraryItems' => [
        [
            'appId' => '7a11f34b-42d4-4bc8-b668-ae4a788dae1e',
            'appVersion' => 6,
            'categories' => [
                [
                    'id' => '9c871ed4-1c41-4065-aefe-321cd4b61cf8',
                    'title' => 'HR',
                ],
                [
                    'id' => 'c1c4e374-118c-446f-81fb-cba6225d88da',
                    'title' => 'IT',
                ],
            ],
            'createdAt' => ,
            'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
            'isRatedByUser' => 1,
            'isVerified' => ,
            'libraryItemId' => 'cb9ecf72-8563-450d-9db9-994f98297316',
            'ratingCount' => 3,
            'status' => 'PUBLISHED',
            'updatedAt' => ,
            'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
            'userCount' => 5,
        ],
        [
            'appId' => '201272ac-d474-4a97-991c-5520dae04026',
            'appVersion' => 1,
            'categories' => [
                [
                    'id' => 'fdc4b483-c4e2-44c9-b4b2-6c850bbdb579',
                    'title' => 'General',
                ],
            ],
            'createdAt' => ,
            'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
            'isRatedByUser' => ,
            'isVerified' => ,
            'libraryItemId' => '18cbebaa-196a-4aa5-a840-88d548e07f8f',
            'ratingCount' => 5,
            'status' => 'PUBLISHED',
            'updatedAt' => ,
            'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
            'userCount' => 8,
        ],
        [
            'appId' => '1802f57f-079a-4b5b-839a-79bbe2e21b3c',
            'appVersion' => 1,
            'categories' => [
                [
                    'id' => 'fdc4b483-c4e2-44c9-b4b2-6c850bbdb579',
                    'title' => 'General',
                ],
            ],
            'createdAt' => ,
            'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
            'isRatedByUser' => ,
            'isVerified' => ,
            'libraryItemId' => '549abfe0-f5c4-45a2-bb9b-c05987a49c6d',
            'ratingCount' => 8,
            'status' => 'PUBLISHED',
            'updatedAt' => ,
            'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
            'userCount' => 12,
        ],
    ],
    'nextToken' => 'YW5vdGhlclRva2VuIQ==',
]

ListQAppSessionData

$result = $client->listQAppSessionData([/* ... */]);
$promise = $client->listQAppSessionDataAsync([/* ... */]);

Lists the collected data of a Q App data collection session.

Parameter Syntax

$result = $client->listQAppSessionData([
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sessionArn' => '<string>',
    'sessionData' => [
        [
            'cardId' => '<string>',
            'submissionId' => '<string>',
            'timestamp' => <DateTime>,
            'user' => [
                'userId' => '<string>',
            ],
            'value' => [
            ],
        ],
        // ...
    ],
    'sessionId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

ListQApps

$result = $client->listQApps([/* ... */]);
$promise = $client->listQAppsAsync([/* ... */]);

Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

Parameter Syntax

$result = $client->listQApps([
    'instanceId' => '<string>', // REQUIRED
    'limit' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'apps' => [
        [
            'appArn' => '<string>',
            'appId' => '<string>',
            'canEdit' => true || false,
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'isVerified' => true || false,
            'status' => '<string>',
            'title' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: List at most 3 Amazon Q Apps in an Q Business application

$result = $client->listQApps([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'limit' => 3,
]);

Result syntax:

[
    'apps' => [
        [
            'appArn' => 'arn:aws:qapps:us-west-2:..../7b9fe303-18bb-4643-952c-bfcf9f4c427f',
            'appId' => '7b9fe303-18bb-4643-952c-bfcf9f4c427f',
            'createdAt' => ,
            'description' => 'Description 1',
            'isVerified' => ,
            'status' => 'DRAFT',
            'title' => 'App 1',
        ],
        [
            'appArn' => 'arn:aws:qapps:us-west-2:..../dd178fd6-ad3d-49b3-a32d-e915cf423e37',
            'appId' => 'dd178fd6-ad3d-49b3-a32d-e915cf423e37',
            'createdAt' => ,
            'description' => 'Description 2',
            'isVerified' => 1,
            'status' => 'PUBLISHED',
            'title' => 'App 2',
        ],
        [
            'appArn' => 'arn:aws:qapps:us-west-2:..../3274b744-1a13-4aad-953f-eda2e4149e6e',
            'appId' => '3274b744-1a13-4aad-953f-eda2e4149e6e',
            'createdAt' => ,
            'description' => 'Description 3',
            'isVerified' => ,
            'status' => 'DRAFT',
            'title' => 'App 3',
        ],
    ],
    'nextToken' => 'bXlzdGVyaW91c1BhZ2luYXRpb25Ub2tlbg==',
]

Example 2: Retrieve the next page of Amazon Q Apps

$result = $client->listQApps([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'limit' => 3,
    'nextToken' => 'bXlzdGVyaW91c1BhZ2luYXRpb25Ub2tlbg==',
]);

Result syntax:

[
    'apps' => [
        [
            'appArn' => 'arn:aws:qapps:us-west-2:..../bec8ee64-2635-41e8-aace-e1e418f4f295',
            'appId' => 'bec8ee64-2635-41e8-aace-e1e418f4f295',
            'createdAt' => ,
            'description' => 'Description 4',
            'isVerified' => 1,
            'status' => 'PUBLISHED',
            'title' => 'App 4',
        ],
        [
            'appArn' => 'arn:aws:qapps:us-west-2:..../c380a45d-bd77-45b0-a0e5-8a266c1d8bc4',
            'appId' => 'c380a45d-bd77-45b0-a0e5-8a266c1d8bc4',
            'createdAt' => ,
            'description' => 'Description 5',
            'isVerified' => ,
            'status' => 'PUBLISHED',
            'title' => 'App 5',
        ],
        [
            'appArn' => 'arn:aws:qapps:us-west-2:..../afc4ee80-9722-4396-85a6-7aeaff52c177',
            'appId' => 'afc4ee80-9722-4396-85a6-7aeaff52c177',
            'createdAt' => ,
            'description' => 'Description 6',
            'isVerified' => ,
            'status' => 'PUBLISHED',
            'title' => 'App 6',
        ],
    ],
    'nextToken' => 'YW5vdGhlclRva2VuIQ==',
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags associated with an Amazon Q Apps resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

ThrottlingException:

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

Examples

Example 1: A call to list tags for a resource

$result = $client->listTagsForResource([
    'resourceARN' => 'arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0',
]);

Result syntax:

[
    'tags' => [
        'department' => 'HR',
    ],
]

PredictQApp

$result = $client->predictQApp([/* ... */]);
$promise = $client->predictQAppAsync([/* ... */]);

Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp. This API doesn't create Amazon Q Apps directly.

Parameter Syntax

$result = $client->predictQApp([
    'instanceId' => '<string>', // REQUIRED
    'options' => [
        'conversation' => [
            [
                'body' => '<string>', // REQUIRED
                'type' => 'USER|SYSTEM', // REQUIRED
            ],
            // ...
        ],
        'problemStatement' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'app' => [
        'appDefinition' => [
            'cards' => [
                [
                    'fileUpload' => [
                        'allowOverride' => true || false,
                        'fileId' => '<string>',
                        'filename' => '<string>',
                        'id' => '<string>',
                        'title' => '<string>',
                        'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                    ],
                    'formInput' => [
                        'computeMode' => 'append|replace',
                        'id' => '<string>',
                        'metadata' => [
                            'schema' => [
                            ],
                        ],
                        'title' => '<string>',
                        'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                    ],
                    'qPlugin' => [
                        'actionIdentifier' => '<string>',
                        'id' => '<string>',
                        'pluginId' => '<string>',
                        'prompt' => '<string>',
                        'title' => '<string>',
                        'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                    ],
                    'qQuery' => [
                        'attributeFilter' => [
                            'andAllFilters' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'containsAll' => [
                                'name' => '<string>',
                                'value' => [
                                    'dateValue' => <DateTime>,
                                    'longValue' => <integer>,
                                    'stringListValue' => ['<string>', ...],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            'containsAny' => [
                                'name' => '<string>',
                                'value' => [
                                    'dateValue' => <DateTime>,
                                    'longValue' => <integer>,
                                    'stringListValue' => ['<string>', ...],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            'equalsTo' => [
                                'name' => '<string>',
                                'value' => [
                                    'dateValue' => <DateTime>,
                                    'longValue' => <integer>,
                                    'stringListValue' => ['<string>', ...],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            'greaterThan' => [
                                'name' => '<string>',
                                'value' => [
                                    'dateValue' => <DateTime>,
                                    'longValue' => <integer>,
                                    'stringListValue' => ['<string>', ...],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            'greaterThanOrEquals' => [
                                'name' => '<string>',
                                'value' => [
                                    'dateValue' => <DateTime>,
                                    'longValue' => <integer>,
                                    'stringListValue' => ['<string>', ...],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            'lessThan' => [
                                'name' => '<string>',
                                'value' => [
                                    'dateValue' => <DateTime>,
                                    'longValue' => <integer>,
                                    'stringListValue' => ['<string>', ...],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            'lessThanOrEquals' => [
                                'name' => '<string>',
                                'value' => [
                                    'dateValue' => <DateTime>,
                                    'longValue' => <integer>,
                                    'stringListValue' => ['<string>', ...],
                                    'stringValue' => '<string>',
                                ],
                            ],
                            'notFilter' => [...], // RECURSIVE
                            'orAllFilters' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                        ],
                        'id' => '<string>',
                        'outputSource' => 'approved-sources|llm',
                        'prompt' => '<string>',
                        'title' => '<string>',
                        'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                    ],
                    'textInput' => [
                        'defaultValue' => '<string>',
                        'id' => '<string>',
                        'placeholder' => '<string>',
                        'title' => '<string>',
                        'type' => 'text-input|q-query|file-upload|q-plugin|form-input',
                    ],
                ],
                // ...
            ],
            'initialPrompt' => '<string>',
        ],
        'description' => '<string>',
        'title' => '<string>',
    ],
    'problemStatement' => '<string>',
]

Result Details

Errors

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

StartQAppSession

$result = $client->startQAppSession([/* ... */]);
$promise = $client->startQAppSessionAsync([/* ... */]);

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

Parameter Syntax

$result = $client->startQAppSession([
    'appId' => '<string>', // REQUIRED
    'appVersion' => <integer>, // REQUIRED
    'initialValues' => [
        [
            'cardId' => '<string>', // REQUIRED
            'submissionMutation' => [
                'mutationType' => 'edit|delete|add', // REQUIRED
                'submissionId' => '<string>', // REQUIRED
            ],
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'sessionArn' => '<string>',
    'sessionId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Start a session for an Amazon Q App using version 1, passing in initial values for one card

$result = $client->startQAppSession([
    'appId' => '65e7dce7-226a-47f9-b689-22850becef89',
    'appVersion' => 1,
    'initialValues' => [
        [
            'value' => 'What is the circumference of Earth?',
            'cardId' => '6fb5b404-3b7b-48a4-8a8b-56406922a606',
        ],
    ],
    'instanceId' => '4cc5e4c2-d2a2-4188-a114-9ca125b4aedc',
]);

Result syntax:

[
    'sessionArn' => 'arn:aws:qapps:us-west-2:0123456789012:application/a929ecd6-5765-4ec7-bd3e-2ca90098b18e/qapp/65e7dce7-226a-47f9-b689-22850becef89/session/1fca878e-64c5-4dc4-b1d9-c93effed4e82',
    'sessionId' => '1fca878e-64c5-4dc4-b1d9-c93effed4e82',
]

StopQAppSession

$result = $client->stopQAppSession([/* ... */]);
$promise = $client->stopQAppSessionAsync([/* ... */]);

Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.

Parameter Syntax

$result = $client->stopQAppSession([
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates tags with an Amazon Q Apps resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

ThrottlingException:

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

Examples

Example 1: A call to tag a resource

$result = $client->tagResource([
    'resourceARN' => 'arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'tags' => [
        'department' => 'HR',
    ],
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Disassociates tags from an Amazon Q Apps resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

ThrottlingException:

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

Examples

Example 1: A call to untag a resource

$result = $client->untagResource([
    'resourceARN' => 'arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'tagKeys' => [
        'department',
    ],
]);

UpdateLibraryItem

$result = $client->updateLibraryItem([/* ... */]);
$promise = $client->updateLibraryItemAsync([/* ... */]);

Updates the library item for an Amazon Q App.

Parameter Syntax

$result = $client->updateLibraryItem([
    'categories' => ['<string>', ...],
    'instanceId' => '<string>', // REQUIRED
    'libraryItemId' => '<string>', // REQUIRED
    'status' => 'PUBLISHED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'appId' => '<string>',
    'appVersion' => <integer>,
    'categories' => [
        [
            'appCount' => <integer>,
            'color' => '<string>',
            'id' => '<string>',
            'title' => '<string>',
        ],
        // ...
    ],
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'isRatedByUser' => true || false,
    'isVerified' => true || false,
    'libraryItemId' => '<string>',
    'ratingCount' => <integer>,
    'status' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
    'userCount' => <integer>,
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Sets the status of a library item to DISABLED

$result = $client->updateLibraryItem([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'libraryItemId' => 'cb9ecf72-8563-450d-9db9-994f98297316',
    'status' => 'DISABLED',
]);

Result syntax:

[
    'appId' => '7a11f34b-42d4-4bc8-b668-ae4a788dae1e',
    'appVersion' => 6,
    'categories' => [
        [
            'id' => '9c871ed4-1c41-4065-aefe-321cd4b61cf8',
            'title' => 'HR',
        ],
        [
            'id' => 'fdc4b483-c4e2-44c9-b4b2-6c850bbdb579',
            'title' => 'General',
        ],
        [
            'id' => 'c1c4e374-118c-446f-81fb-cba6225d88da',
            'title' => 'IT',
        ],
    ],
    'createdAt' => ,
    'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'isVerified' => ,
    'libraryItemId' => 'cb9ecf72-8563-450d-9db9-994f98297316',
    'ratingCount' => 24,
    'status' => 'DISABLED',
    'updatedAt' => ,
    'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
]

UpdateLibraryItemMetadata

$result = $client->updateLibraryItemMetadata([/* ... */]);
$promise = $client->updateLibraryItemMetadataAsync([/* ... */]);

Updates the verification status of a library item for an Amazon Q App.

Parameter Syntax

$result = $client->updateLibraryItemMetadata([
    'instanceId' => '<string>', // REQUIRED
    'isVerified' => true || false,
    'libraryItemId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ConflictException:

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

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Update a library item to be verified

$result = $client->updateLibraryItemMetadata([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'isVerified' => 1,
    'libraryItemId' => 'cb9ecf72-8563-450d-9db9-994f98297316',
]);

UpdateQApp

$result = $client->updateQApp([/* ... */]);
$promise = $client->updateQAppAsync([/* ... */]);

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

Parameter Syntax

$result = $client->updateQApp([
    'appDefinition' => [
        'cards' => [ // REQUIRED
            [
                'fileUpload' => [
                    'allowOverride' => true || false,
                    'fileId' => '<string>',
                    'filename' => '<string>',
                    'id' => '<string>', // REQUIRED
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'formInput' => [
                    'computeMode' => 'append|replace',
                    'id' => '<string>', // REQUIRED
                    'metadata' => [ // REQUIRED
                        'schema' => [ // REQUIRED
                        ],
                    ],
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'qPlugin' => [
                    'actionIdentifier' => '<string>',
                    'id' => '<string>', // REQUIRED
                    'pluginId' => '<string>', // REQUIRED
                    'prompt' => '<string>', // REQUIRED
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'qQuery' => [
                    'attributeFilter' => [
                        'andAllFilters' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'containsAll' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'containsAny' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'equalsTo' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'greaterThan' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'greaterThanOrEquals' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'lessThan' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'lessThanOrEquals' => [
                            'name' => '<string>', // REQUIRED
                            'value' => [ // REQUIRED
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'notFilter' => [...], // RECURSIVE
                        'orAllFilters' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'id' => '<string>', // REQUIRED
                    'outputSource' => 'approved-sources|llm',
                    'prompt' => '<string>', // REQUIRED
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
                'textInput' => [
                    'defaultValue' => '<string>',
                    'id' => '<string>', // REQUIRED
                    'placeholder' => '<string>',
                    'title' => '<string>', // REQUIRED
                    'type' => 'text-input|q-query|file-upload|q-plugin|form-input', // REQUIRED
                ],
            ],
            // ...
        ],
        'initialPrompt' => '<string>',
    ],
    'appId' => '<string>', // REQUIRED
    'description' => '<string>',
    'instanceId' => '<string>', // REQUIRED
    'title' => '<string>',
]);

Parameter Details

Result Syntax

[
    'appArn' => '<string>',
    'appId' => '<string>',
    'appVersion' => <integer>,
    'createdAt' => <DateTime>,
    'createdBy' => '<string>',
    'description' => '<string>',
    'initialPrompt' => '<string>',
    'requiredCapabilities' => ['<string>', ...],
    'status' => 'PUBLISHED|DRAFT|DELETED',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ContentTooLargeException:

The requested operation could not be completed because the content exceeds the maximum allowed size.

ThrottlingException:

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

Examples

Example 1: Updating the title of an app

$result = $client->updateQApp([
    'appId' => '7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'title' => 'This is the new title',
]);

Result syntax:

[
    'appArn' => 'arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appId' => '7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appVersion' => 2,
    'createdAt' => ,
    'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'requiredCapabilities' => [
        'CreatorMode',
    ],
    'status' => 'DRAFT',
    'title' => 'This is the new title',
    'updatedAt' => ,
    'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
]

Example 2: Updating the app so it has a single q-query card

$result = $client->updateQApp([
    'appDefinition' => [
        'cards' => [
            [
                'qQuery' => [
                    'type' => 'q-query',
                    'id' => '18870b94-1e63-40e0-8c12-669c90ac5acc',
                    'prompt' => 'Recommend me an itinerary for a trip',
                    'title' => 'Trip Ideas',
                ],
            ],
        ],
    ],
    'appId' => '7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
]);

Result syntax:

[
    'appArn' => 'arn:aws:qapps:us-west-2:123456789012:app/7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appId' => '7212ff04-de7b-4831-bd80-45d6975ba1b0',
    'appVersion' => 99,
    'createdAt' => ,
    'createdBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
    'requiredCapabilities' => [
        'CreatorMode',
    ],
    'status' => 'DRAFT',
    'title' => 'Previous Title Stays the Same',
    'updatedAt' => ,
    'updatedBy' => 'a841e300-40c1-7062-fa34-5b46dadbbaac',
]

UpdateQAppPermissions

$result = $client->updateQAppPermissions([/* ... */]);
$promise = $client->updateQAppPermissionsAsync([/* ... */]);

Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.

Parameter Syntax

$result = $client->updateQAppPermissions([
    'appId' => '<string>', // REQUIRED
    'grantPermissions' => [
        [
            'action' => 'read|write', // REQUIRED
            'principal' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'instanceId' => '<string>', // REQUIRED
    'revokePermissions' => [
        [
            'action' => 'read|write', // REQUIRED
            'principal' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'appId' => '<string>',
    'permissions' => [
        [
            'action' => 'read|write',
            'principal' => [
                'email' => '<string>',
                'userId' => '<string>',
                'userType' => 'owner|user',
            ],
        ],
        // ...
    ],
    'resourceArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ThrottlingException:

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

Examples

Example 1: Grant permissions for the app

$result = $client->updateQAppPermissions([
    'appId' => 'fe0acf86-49e5-4def-a0c2-40ce0cafee14',
    'grantPermissions' => [
        [
            'action' => 'read',
            'principal' => 'user2@example.com',
        ],
    ],
    'instanceId' => '01793661-ad73-4c7d-8eaa-1c95a10151c2',
]);

Result syntax:

[
    'appId' => 'fe0acf86-49e5-4def-a0c2-40ce0cafee14',
    'permissions' => [
        [
            'action' => 'write',
            'principal' => [
                'email' => 'user1@example.com',
                'userId' => 'f8f15330-b091-708b-d46e-adb0d914b699',
            ],
        ],
        [
            'action' => 'read',
            'principal' => [
                'email' => 'user2@example.com',
                'userId' => 'c81133d0-10d1-70eb-aaa3-d427ea6fc0f3',
            ],
        ],
    ],
    'resourceArn' => 'arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14',
]

Example 2: Revoke permissions for the app

$result = $client->updateQAppPermissions([
    'appId' => 'fe0acf86-49e5-4def-a0c2-40ce0cafee14',
    'instanceId' => '01793661-ad73-4c7d-8eaa-1c95a10151c2',
    'revokePermissions' => [
        [
            'action' => 'read',
            'principal' => 'user2@example.com',
        ],
    ],
]);

Result syntax:

[
    'appId' => 'fe0acf86-49e5-4def-a0c2-40ce0cafee14',
    'permissions' => [
        [
            'action' => 'write',
            'principal' => [
                'email' => 'user1@example.com',
                'userId' => 'f8f15330-b091-708b-d46e-adb0d914b699',
            ],
        ],
    ],
    'resourceArn' => 'arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14',
]

UpdateQAppSession

$result = $client->updateQAppSession([/* ... */]);
$promise = $client->updateQAppSessionAsync([/* ... */]);

Updates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.

Parameter Syntax

$result = $client->updateQAppSession([
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
    'values' => [
        [
            'cardId' => '<string>', // REQUIRED
            'submissionMutation' => [
                'mutationType' => 'edit|delete|add', // REQUIRED
                'submissionId' => '<string>', // REQUIRED
            ],
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'sessionArn' => '<string>',
    'sessionId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

UpdateQAppSessionMetadata

$result = $client->updateQAppSessionMetadata([/* ... */]);
$promise = $client->updateQAppSessionMetadataAsync([/* ... */]);

Updates the configuration metadata of a session for a given Q App sessionId.

Parameter Syntax

$result = $client->updateQAppSessionMetadata([
    'instanceId' => '<string>', // REQUIRED
    'sessionId' => '<string>', // REQUIRED
    'sessionName' => '<string>',
    'sharingConfiguration' => [ // REQUIRED
        'acceptResponses' => true || false,
        'enabled' => true || false, // REQUIRED
        'revealCards' => true || false,
    ],
]);

Parameter Details

Result Syntax

[
    'sessionArn' => '<string>',
    'sessionId' => '<string>',
    'sessionName' => '<string>',
    'sharingConfiguration' => [
        'acceptResponses' => true || false,
        'enabled' => true || false,
        'revealCards' => true || false,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The requested resource could not be found.

AccessDeniedException:

The client is not authorized to perform the requested operation.

ValidationException:

The input failed to satisfy the constraints specified by the service.

InternalServerException:

An internal service error occurred while processing the request.

UnauthorizedException:

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

ServiceQuotaExceededException:

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

ThrottlingException:

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

Examples

Example 1: Updates an existing session metadata for an Amazon Q App

$result = $client->updateQAppSessionMetadata([
    'instanceId' => '0b95c9c4-89cc-4aa8-9aae-aa91cbec699f',
    'sessionId' => '56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb',
    'sessionName' => 'Trip itinerary collection session',
    'sharingConfiguration' => [
        'acceptResponses' => 1,
        'enabled' => 1,
        'revealCards' => ,
    ],
]);

Result syntax:

[
    'sessionArn' => 'arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb',
    'sessionId' => '56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb',
    'sessionName' => 'Trip itinerary collection session',
    'sharingConfiguration' => [
        'acceptResponses' => 1,
        'enabled' => 1,
        'revealCards' => ,
    ],
]