BatchDeleteDocument

$result = $client->batchDeleteDocument([/* ... */]);
$promise = $client->batchDeleteDocumentAsync([/* ... */]);

Asynchronously deletes one or more documents added using the BatchPutDocument API from an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

Parameter Syntax

$result = $client->batchDeleteDocument([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceSyncId' => '<string>',
    'documents' => [ // REQUIRED
        [
            'documentId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'failedDocuments' => [
        [
            'dataSourceId' => '<string>',
            'error' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

BatchPutDocument

$result = $client->batchPutDocument([/* ... */]);
$promise = $client->batchPutDocumentAsync([/* ... */]);

Adds one or more documents to an Amazon Q Business index.

You use this API to:

• ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.

• add custom attributes to documents in an Amazon Q Business index.

• attach an access control list to the documents added to an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

Parameter Syntax

$result = $client->batchPutDocument([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceSyncId' => '<string>',
    'documents' => [ // REQUIRED
        [
            'accessConfiguration' => [
                'accessControls' => [ // REQUIRED
                    [
                        'memberRelation' => 'AND|OR',
                        'principals' => [ // REQUIRED
                            [
                                'group' => [
                                    'access' => 'ALLOW|DENY', // REQUIRED
                                    'membershipType' => 'INDEX|DATASOURCE',
                                    'name' => '<string>',
                                ],
                                'user' => [
                                    'access' => 'ALLOW|DENY', // REQUIRED
                                    'id' => '<string>',
                                    'membershipType' => 'INDEX|DATASOURCE',
                                ],
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'memberRelation' => 'AND|OR',
            ],
            'attributes' => [
                [
                    'name' => '<string>', // REQUIRED
                    'value' => [ // REQUIRED
                        'dateValue' => <integer || string || DateTime>,
                        'longValue' => <integer>,
                        'stringListValue' => ['<string>', ...],
                        'stringValue' => '<string>',
                    ],
                ],
                // ...
            ],
            'content' => [
                'blob' => <string || resource || Psr\Http\Message\StreamInterface>,
                's3' => [
                    'bucket' => '<string>', // REQUIRED
                    'key' => '<string>', // REQUIRED
                ],
            ],
            'contentType' => 'PDF|HTML|MS_WORD|PLAIN_TEXT|PPT|RTF|XML|XSLT|MS_EXCEL|CSV|JSON|MD',
            'documentEnrichmentConfiguration' => [
                'inlineConfigurations' => [
                    [
                        'condition' => [
                            'key' => '<string>', // REQUIRED
                            'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                            'value' => [
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                        'documentContentOperator' => 'DELETE',
                        'target' => [
                            'attributeValueOperator' => 'DELETE',
                            'key' => '<string>', // REQUIRED
                            'value' => [
                                'dateValue' => <integer || string || DateTime>,
                                'longValue' => <integer>,
                                'stringListValue' => ['<string>', ...],
                                'stringValue' => '<string>',
                            ],
                        ],
                    ],
                    // ...
                ],
                'postExtractionHookConfiguration' => [
                    'invocationCondition' => [
                        'key' => '<string>', // REQUIRED
                        'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                        'value' => [
                            'dateValue' => <integer || string || DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'lambdaArn' => '<string>',
                    'roleArn' => '<string>',
                    's3BucketName' => '<string>',
                ],
                'preExtractionHookConfiguration' => [
                    'invocationCondition' => [
                        'key' => '<string>', // REQUIRED
                        'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                        'value' => [
                            'dateValue' => <integer || string || DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'lambdaArn' => '<string>',
                    'roleArn' => '<string>',
                    's3BucketName' => '<string>',
                ],
            ],
            'id' => '<string>', // REQUIRED
            'title' => '<string>',
        ],
        // ...
    ],
    'indexId' => '<string>', // REQUIRED
    'roleArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'failedDocuments' => [
        [
            'dataSourceId' => '<string>',
            'error' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'id' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

ChatSync

$result = $client->chatSync([/* ... */]);
$promise = $client->chatSyncAsync([/* ... */]);

Starts or continues a non-streaming Amazon Q Business conversation.

Parameter Syntax

$result = $client->chatSync([
    'actionExecution' => [
        'payload' => [ // REQUIRED
            '<ActionPayloadFieldKey>' => [
                'value' => [ // REQUIRED
                ],
            ],
            // ...
        ],
        'payloadFieldNameSeparator' => '<string>', // REQUIRED
        'pluginId' => '<string>', // REQUIRED
    ],
    'applicationId' => '<string>', // REQUIRED
    'attachments' => [
        [
            'data' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
            'name' => '<string>', // REQUIRED
        ],
        // ...
    ],
    '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
            // ...
        ],
    ],
    'authChallengeResponse' => [
        'responseMap' => ['<string>', ...], // REQUIRED
    ],
    'chatMode' => 'RETRIEVAL_MODE|CREATOR_MODE|PLUGIN_MODE',
    'chatModeConfiguration' => [
        'pluginConfiguration' => [
            'pluginId' => '<string>', // REQUIRED
        ],
    ],
    'clientToken' => '<string>',
    'conversationId' => '<string>',
    'parentMessageId' => '<string>',
    'userGroups' => ['<string>', ...],
    'userId' => '<string>',
    'userMessage' => '<string>',
]);

Parameter Details

Result Syntax

[
    'actionReview' => [
        'payload' => [
            '<ActionPayloadFieldKey>' => [
                'allowedFormat' => '<string>',
                'allowedValues' => [
                    [
                        'displayValue' => [
                        ],
                        'value' => [
                        ],
                    ],
                    // ...
                ],
                'displayDescription' => '<string>',
                'displayName' => '<string>',
                'displayOrder' => <integer>,
                'required' => true || false,
                'type' => 'STRING|NUMBER|ARRAY|BOOLEAN',
                'value' => [
                ],
            ],
            // ...
        ],
        'payloadFieldNameSeparator' => '<string>',
        'pluginId' => '<string>',
        'pluginType' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM',
    ],
    'authChallengeRequest' => [
        'authorizationUrl' => '<string>',
    ],
    'conversationId' => '<string>',
    'failedAttachments' => [
        [
            'error' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'name' => '<string>',
            'status' => 'FAILED|SUCCEEDED',
        ],
        // ...
    ],
    'sourceAttributions' => [
        [
            'citationNumber' => <integer>,
            'snippet' => '<string>',
            'textMessageSegments' => [
                [
                    'beginOffset' => <integer>,
                    'endOffset' => <integer>,
                    'snippetExcerpt' => [
                        'text' => '<string>',
                    ],
                ],
                // ...
            ],
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'url' => '<string>',
        ],
        // ...
    ],
    'systemMessage' => '<string>',
    'systemMessageId' => '<string>',
    'userMessageId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

LicenseNotFoundException:

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates an Amazon Q Business application.

Parameter Syntax

$result = $client->createApplication([
    'attachmentsConfiguration' => [
        'attachmentsControlMode' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'encryptionConfiguration' => [
        'kmsKeyId' => '<string>',
    ],
    'identityCenterInstanceArn' => '<string>',
    'roleArn' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'applicationArn' => '<string>',
    'applicationId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

CreateDataSource

$result = $client->createDataSource([/* ... */]);
$promise = $client->createDataSourceAsync([/* ... */]);

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Parameter Syntax

$result = $client->createDataSource([
    'applicationId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'configuration' => [ // REQUIRED
    ],
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'documentEnrichmentConfiguration' => [
        'inlineConfigurations' => [
            [
                'condition' => [
                    'key' => '<string>', // REQUIRED
                    'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                    'value' => [
                        'dateValue' => <integer || string || DateTime>,
                        'longValue' => <integer>,
                        'stringListValue' => ['<string>', ...],
                        'stringValue' => '<string>',
                    ],
                ],
                'documentContentOperator' => 'DELETE',
                'target' => [
                    'attributeValueOperator' => 'DELETE',
                    'key' => '<string>', // REQUIRED
                    'value' => [
                        'dateValue' => <integer || string || DateTime>,
                        'longValue' => <integer>,
                        'stringListValue' => ['<string>', ...],
                        'stringValue' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'postExtractionHookConfiguration' => [
            'invocationCondition' => [
                'key' => '<string>', // REQUIRED
                'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                'value' => [
                    'dateValue' => <integer || string || DateTime>,
                    'longValue' => <integer>,
                    'stringListValue' => ['<string>', ...],
                    'stringValue' => '<string>',
                ],
            ],
            'lambdaArn' => '<string>',
            'roleArn' => '<string>',
            's3BucketName' => '<string>',
        ],
        'preExtractionHookConfiguration' => [
            'invocationCondition' => [
                'key' => '<string>', // REQUIRED
                'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                'value' => [
                    'dateValue' => <integer || string || DateTime>,
                    'longValue' => <integer>,
                    'stringListValue' => ['<string>', ...],
                    'stringValue' => '<string>',
                ],
            ],
            'lambdaArn' => '<string>',
            'roleArn' => '<string>',
            's3BucketName' => '<string>',
        ],
    ],
    'indexId' => '<string>', // REQUIRED
    'roleArn' => '<string>',
    'syncSchedule' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'vpcConfiguration' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'dataSourceArn' => '<string>',
    'dataSourceId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

CreateIndex

$result = $client->createIndex([/* ... */]);
$promise = $client->createIndexAsync([/* ... */]);

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

Parameter Syntax

$result = $client->createIndex([
    'applicationId' => '<string>', // REQUIRED
    'capacityConfiguration' => [
        'units' => <integer>,
    ],
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'type' => 'ENTERPRISE|STARTER',
]);

Parameter Details

Result Syntax

[
    'indexArn' => '<string>',
    'indexId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

CreatePlugin

$result = $client->createPlugin([/* ... */]);
$promise = $client->createPluginAsync([/* ... */]);

Creates an Amazon Q Business plugin.

Parameter Syntax

$result = $client->createPlugin([
    'applicationId' => '<string>', // REQUIRED
    'authConfiguration' => [ // REQUIRED
        'basicAuthConfiguration' => [
            'roleArn' => '<string>', // REQUIRED
            'secretArn' => '<string>', // REQUIRED
        ],
        'noAuthConfiguration' => [
        ],
        'oAuth2ClientCredentialConfiguration' => [
            'roleArn' => '<string>', // REQUIRED
            'secretArn' => '<string>', // REQUIRED
        ],
    ],
    'clientToken' => '<string>',
    'customPluginConfiguration' => [
        'apiSchema' => [ // REQUIRED
            'payload' => '<string>',
            's3' => [
                'bucket' => '<string>', // REQUIRED
                'key' => '<string>', // REQUIRED
            ],
        ],
        'apiSchemaType' => 'OPEN_API_V3', // REQUIRED
        'description' => '<string>', // REQUIRED
    ],
    'displayName' => '<string>', // REQUIRED
    'serverUrl' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'type' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'buildStatus' => 'READY|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'pluginArn' => '<string>',
    'pluginId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

CreateRetriever

$result = $client->createRetriever([/* ... */]);
$promise = $client->createRetrieverAsync([/* ... */]);

Adds a retriever to your Amazon Q Business application.

Parameter Syntax

$result = $client->createRetriever([
    'applicationId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'configuration' => [ // REQUIRED
        'kendraIndexConfiguration' => [
            'indexId' => '<string>', // REQUIRED
        ],
        'nativeIndexConfiguration' => [
            'boostingOverride' => [
                '<DocumentAttributeKey>' => [
                    'dateConfiguration' => [
                        'boostingDurationInSeconds' => <integer>,
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                    ],
                    'numberConfiguration' => [
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                        'boostingType' => 'PRIORITIZE_LARGER_VALUES|PRIORITIZE_SMALLER_VALUES',
                    ],
                    'stringConfiguration' => [
                        'attributeValueBoosting' => ['<string>', ...],
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                    ],
                    'stringListConfiguration' => [
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                    ],
                ],
                // ...
            ],
            'indexId' => '<string>', // REQUIRED
        ],
    ],
    'displayName' => '<string>', // REQUIRED
    'roleArn' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'type' => 'NATIVE_INDEX|KENDRA_INDEX', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'retrieverArn' => '<string>',
    'retrieverId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a universally unique identifier (UUID) mapped to a list of local user ids within an application.

Parameter Syntax

$result = $client->createUser([
    'applicationId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'userAliases' => [
        [
            'dataSourceId' => '<string>',
            'indexId' => '<string>',
            'userId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

CreateWebExperience

$result = $client->createWebExperience([/* ... */]);
$promise = $client->createWebExperienceAsync([/* ... */]);

Creates an Amazon Q Business web experience.

Parameter Syntax

$result = $client->createWebExperience([
    'applicationId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'roleArn' => '<string>',
    'samplePromptsControlMode' => 'ENABLED|DISABLED',
    'subtitle' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'title' => '<string>',
    'welcomeMessage' => '<string>',
]);

Parameter Details

Result Syntax

[
    'webExperienceArn' => '<string>',
    'webExperienceId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes an Amazon Q Business application.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteChatControlsConfiguration

$result = $client->deleteChatControlsConfiguration([/* ... */]);
$promise = $client->deleteChatControlsConfigurationAsync([/* ... */]);

Deletes chat controls configured for an existing Amazon Q Business application.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteConversation

$result = $client->deleteConversation([/* ... */]);
$promise = $client->deleteConversationAsync([/* ... */]);

Deletes an Amazon Q Business web experience conversation.

Parameter Syntax

$result = $client->deleteConversation([
    'applicationId' => '<string>', // REQUIRED
    'conversationId' => '<string>', // REQUIRED
    'userId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

LicenseNotFoundException:

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteDataSource

$result = $client->deleteDataSource([/* ... */]);
$promise = $client->deleteDataSourceAsync([/* ... */]);

Deletes an Amazon Q Business data source connector. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING.

Parameter Syntax

$result = $client->deleteDataSource([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group. For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their chat results.

If you want to delete, update, or replace users or sub groups of a group, you need to use the PutGroup operation. For example, if a user in the group "Engineering" leaves the engineering team and another user takes their place, you provide an updated list of users or sub groups that belong to the "Engineering" group when calling PutGroup.

Parameter Syntax

$result = $client->deleteGroup([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>',
    'groupName' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteIndex

$result = $client->deleteIndex([/* ... */]);
$promise = $client->deleteIndexAsync([/* ... */]);

Deletes an Amazon Q Business index.

Parameter Syntax

$result = $client->deleteIndex([
    'applicationId' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeletePlugin

$result = $client->deletePlugin([/* ... */]);
$promise = $client->deletePluginAsync([/* ... */]);

Deletes an Amazon Q Business plugin.

Parameter Syntax

$result = $client->deletePlugin([
    'applicationId' => '<string>', // REQUIRED
    'pluginId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteRetriever

$result = $client->deleteRetriever([/* ... */]);
$promise = $client->deleteRetrieverAsync([/* ... */]);

Deletes the retriever used by an Amazon Q Business application.

Parameter Syntax

$result = $client->deleteRetriever([
    'applicationId' => '<string>', // REQUIRED
    'retrieverId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user by email id.

Parameter Syntax

$result = $client->deleteUser([
    'applicationId' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

DeleteWebExperience

$result = $client->deleteWebExperience([/* ... */]);
$promise = $client->deleteWebExperienceAsync([/* ... */]);

Deletes an Amazon Q Business web experience.

Parameter Syntax

$result = $client->deleteWebExperience([
    'applicationId' => '<string>', // REQUIRED
    'webExperienceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Gets information about an existing Amazon Q Business application.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'applicationArn' => '<string>',
    'applicationId' => '<string>',
    'attachmentsConfiguration' => [
        'attachmentsControlMode' => 'ENABLED|DISABLED',
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'displayName' => '<string>',
    'encryptionConfiguration' => [
        'kmsKeyId' => '<string>',
    ],
    'error' => [
        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
        'errorMessage' => '<string>',
    ],
    'identityCenterApplicationArn' => '<string>',
    'roleArn' => '<string>',
    'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetChatControlsConfiguration

$result = $client->getChatControlsConfiguration([/* ... */]);
$promise = $client->getChatControlsConfigurationAsync([/* ... */]);

Gets information about an chat controls configured for an existing Amazon Q Business application.

Parameter Syntax

$result = $client->getChatControlsConfiguration([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'blockedPhrases' => [
        'blockedPhrases' => ['<string>', ...],
        'systemMessageOverride' => '<string>',
    ],
    'creatorModeConfiguration' => [
        'creatorModeControl' => 'ENABLED|DISABLED',
    ],
    'nextToken' => '<string>',
    'responseScope' => 'ENTERPRISE_CONTENT_ONLY|EXTENDED_KNOWLEDGE_ENABLED',
    'topicConfigurations' => [
        [
            'description' => '<string>',
            'exampleChatMessages' => ['<string>', ...],
            'name' => '<string>',
            'rules' => [
                [
                    'excludedUsersAndGroups' => [
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'includedUsersAndGroups' => [
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'ruleConfiguration' => [
                        'contentBlockerRule' => [
                            'systemMessageOverride' => '<string>',
                        ],
                        'contentRetrievalRule' => [
                            'eligibleDataSources' => [
                                [
                                    'dataSourceId' => '<string>',
                                    'indexId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'ruleType' => 'CONTENT_BLOCKER_RULE|CONTENT_RETRIEVAL_RULE',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetDataSource

$result = $client->getDataSource([/* ... */]);
$promise = $client->getDataSourceAsync([/* ... */]);

Gets information about an existing Amazon Q Business data source connector.

Parameter Syntax

$result = $client->getDataSource([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
    'configuration' => [
    ],
    'createdAt' => <DateTime>,
    'dataSourceArn' => '<string>',
    'dataSourceId' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>',
    'documentEnrichmentConfiguration' => [
        'inlineConfigurations' => [
            [
                'condition' => [
                    'key' => '<string>',
                    'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH',
                    'value' => [
                        'dateValue' => <DateTime>,
                        'longValue' => <integer>,
                        'stringListValue' => ['<string>', ...],
                        'stringValue' => '<string>',
                    ],
                ],
                'documentContentOperator' => 'DELETE',
                'target' => [
                    'attributeValueOperator' => 'DELETE',
                    'key' => '<string>',
                    'value' => [
                        'dateValue' => <DateTime>,
                        'longValue' => <integer>,
                        'stringListValue' => ['<string>', ...],
                        'stringValue' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'postExtractionHookConfiguration' => [
            'invocationCondition' => [
                'key' => '<string>',
                'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH',
                'value' => [
                    'dateValue' => <DateTime>,
                    'longValue' => <integer>,
                    'stringListValue' => ['<string>', ...],
                    'stringValue' => '<string>',
                ],
            ],
            'lambdaArn' => '<string>',
            'roleArn' => '<string>',
            's3BucketName' => '<string>',
        ],
        'preExtractionHookConfiguration' => [
            'invocationCondition' => [
                'key' => '<string>',
                'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH',
                'value' => [
                    'dateValue' => <DateTime>,
                    'longValue' => <integer>,
                    'stringListValue' => ['<string>', ...],
                    'stringValue' => '<string>',
                ],
            ],
            'lambdaArn' => '<string>',
            'roleArn' => '<string>',
            's3BucketName' => '<string>',
        ],
    ],
    'error' => [
        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
        'errorMessage' => '<string>',
    ],
    'indexId' => '<string>',
    'roleArn' => '<string>',
    'status' => 'PENDING_CREATION|CREATING|ACTIVE|DELETING|FAILED|UPDATING',
    'syncSchedule' => '<string>',
    'type' => '<string>',
    'updatedAt' => <DateTime>,
    'vpcConfiguration' => [
        'securityGroupIds' => ['<string>', ...],
        'subnetIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetGroup

$result = $client->getGroup([/* ... */]);
$promise = $client->getGroupAsync([/* ... */]);

Describes a group by group name.

Parameter Syntax

$result = $client->getGroup([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>',
    'groupName' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'status' => [
        'errorDetail' => [
            'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
            'errorMessage' => '<string>',
        ],
        'lastUpdatedAt' => <DateTime>,
        'status' => 'FAILED|SUCCEEDED|PROCESSING|DELETING|DELETED',
    ],
    'statusHistory' => [
        [
            'errorDetail' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'lastUpdatedAt' => <DateTime>,
            'status' => 'FAILED|SUCCEEDED|PROCESSING|DELETING|DELETED',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetIndex

$result = $client->getIndex([/* ... */]);
$promise = $client->getIndexAsync([/* ... */]);

Gets information about an existing Amazon Q Business index.

Parameter Syntax

$result = $client->getIndex([
    'applicationId' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
    'capacityConfiguration' => [
        'units' => <integer>,
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'displayName' => '<string>',
    'documentAttributeConfigurations' => [
        [
            'name' => '<string>',
            'search' => 'ENABLED|DISABLED',
            'type' => 'STRING|STRING_LIST|NUMBER|DATE',
        ],
        // ...
    ],
    'error' => [
        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
        'errorMessage' => '<string>',
    ],
    'indexArn' => '<string>',
    'indexId' => '<string>',
    'indexStatistics' => [
        'textDocumentStatistics' => [
            'indexedTextBytes' => <integer>,
            'indexedTextDocumentCount' => <integer>,
        ],
    ],
    'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
    'type' => 'ENTERPRISE|STARTER',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetPlugin

$result = $client->getPlugin([/* ... */]);
$promise = $client->getPluginAsync([/* ... */]);

Gets information about an existing Amazon Q Business plugin.

Parameter Syntax

$result = $client->getPlugin([
    'applicationId' => '<string>', // REQUIRED
    'pluginId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
    'authConfiguration' => [
        'basicAuthConfiguration' => [
            'roleArn' => '<string>',
            'secretArn' => '<string>',
        ],
        'noAuthConfiguration' => [
        ],
        'oAuth2ClientCredentialConfiguration' => [
            'roleArn' => '<string>',
            'secretArn' => '<string>',
        ],
    ],
    'buildStatus' => 'READY|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'createdAt' => <DateTime>,
    'customPluginConfiguration' => [
        'apiSchema' => [
            'payload' => '<string>',
            's3' => [
                'bucket' => '<string>',
                'key' => '<string>',
            ],
        ],
        'apiSchemaType' => 'OPEN_API_V3',
        'description' => '<string>',
    ],
    'displayName' => '<string>',
    'pluginArn' => '<string>',
    'pluginId' => '<string>',
    'serverUrl' => '<string>',
    'state' => 'ENABLED|DISABLED',
    'type' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetRetriever

$result = $client->getRetriever([/* ... */]);
$promise = $client->getRetrieverAsync([/* ... */]);

Gets information about an existing retriever used by an Amazon Q Business application.

Parameter Syntax

$result = $client->getRetriever([
    'applicationId' => '<string>', // REQUIRED
    'retrieverId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
    'configuration' => [
        'kendraIndexConfiguration' => [
            'indexId' => '<string>',
        ],
        'nativeIndexConfiguration' => [
            'boostingOverride' => [
                '<DocumentAttributeKey>' => [
                    'dateConfiguration' => [
                        'boostingDurationInSeconds' => <integer>,
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH',
                    ],
                    'numberConfiguration' => [
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH',
                        'boostingType' => 'PRIORITIZE_LARGER_VALUES|PRIORITIZE_SMALLER_VALUES',
                    ],
                    'stringConfiguration' => [
                        'attributeValueBoosting' => ['<string>', ...],
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH',
                    ],
                    'stringListConfiguration' => [
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH',
                    ],
                ],
                // ...
            ],
            'indexId' => '<string>',
        ],
    ],
    'createdAt' => <DateTime>,
    'displayName' => '<string>',
    'retrieverArn' => '<string>',
    'retrieverId' => '<string>',
    'roleArn' => '<string>',
    'status' => 'CREATING|ACTIVE|FAILED',
    'type' => 'NATIVE_INDEX|KENDRA_INDEX',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetUser

$result = $client->getUser([/* ... */]);
$promise = $client->getUserAsync([/* ... */]);

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Parameter Syntax

$result = $client->getUser([
    'applicationId' => '<string>', // REQUIRED
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'userAliases' => [
        [
            'dataSourceId' => '<string>',
            'indexId' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

GetWebExperience

$result = $client->getWebExperience([/* ... */]);
$promise = $client->getWebExperienceAsync([/* ... */]);

Gets information about an existing Amazon Q Business web experience.

Parameter Syntax

$result = $client->getWebExperience([
    'applicationId' => '<string>', // REQUIRED
    'webExperienceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
    'authenticationConfiguration' => [
        'samlConfiguration' => [
            'metadataXML' => '<string>',
            'roleArn' => '<string>',
            'userGroupAttribute' => '<string>',
            'userIdAttribute' => '<string>',
        ],
    ],
    'createdAt' => <DateTime>,
    'defaultEndpoint' => '<string>',
    'error' => [
        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
        'errorMessage' => '<string>',
    ],
    'roleArn' => '<string>',
    'samplePromptsControlMode' => 'ENABLED|DISABLED',
    'status' => 'CREATING|ACTIVE|DELETING|FAILED|PENDING_AUTH_CONFIG',
    'subtitle' => '<string>',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
    'webExperienceArn' => '<string>',
    'webExperienceId' => '<string>',
    'welcomeMessage' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

Lists Amazon Q Business applications.

Parameter Syntax

$result = $client->listApplications([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'applications' => [
        [
            'applicationId' => '<string>',
            'createdAt' => <DateTime>,
            'displayName' => '<string>',
            'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListConversations

$result = $client->listConversations([/* ... */]);
$promise = $client->listConversationsAsync([/* ... */]);

Lists one or more Amazon Q Business conversations.

Parameter Syntax

$result = $client->listConversations([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'userId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'conversations' => [
        [
            'conversationId' => '<string>',
            'startTime' => <DateTime>,
            'title' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

LicenseNotFoundException:

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListDataSourceSyncJobs

$result = $client->listDataSourceSyncJobs([/* ... */]);
$promise = $client->listDataSourceSyncJobsAsync([/* ... */]);

Get information about an Amazon Q Business data source connector synchronization.

Parameter Syntax

$result = $client->listDataSourceSyncJobs([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>', // REQUIRED
    'endTime' => <integer || string || DateTime>,
    'indexId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'startTime' => <integer || string || DateTime>,
    'statusFilter' => 'FAILED|SUCCEEDED|SYNCING|INCOMPLETE|STOPPING|ABORTED|SYNCING_INDEXING',
]);

Parameter Details

Result Syntax

[
    'history' => [
        [
            'dataSourceErrorCode' => '<string>',
            'endTime' => <DateTime>,
            'error' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'executionId' => '<string>',
            'metrics' => [
                'documentsAdded' => '<string>',
                'documentsDeleted' => '<string>',
                'documentsFailed' => '<string>',
                'documentsModified' => '<string>',
                'documentsScanned' => '<string>',
            ],
            'startTime' => <DateTime>,
            'status' => 'FAILED|SUCCEEDED|SYNCING|INCOMPLETE|STOPPING|ABORTED|SYNCING_INDEXING',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListDataSources

$result = $client->listDataSources([/* ... */]);
$promise = $client->listDataSourcesAsync([/* ... */]);

Lists the Amazon Q Business data source connectors that you have created.

Parameter Syntax

$result = $client->listDataSources([
    'applicationId' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dataSources' => [
        [
            'createdAt' => <DateTime>,
            'dataSourceId' => '<string>',
            'displayName' => '<string>',
            'status' => 'PENDING_CREATION|CREATING|ACTIVE|DELETING|FAILED|UPDATING',
            'type' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListDocuments

$result = $client->listDocuments([/* ... */]);
$promise = $client->listDocumentsAsync([/* ... */]);

A list of documents attached to an index.

Parameter Syntax

$result = $client->listDocuments([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceIds' => ['<string>', ...],
    'indexId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'documentDetailList' => [
        [
            'createdAt' => <DateTime>,
            'documentId' => '<string>',
            'error' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'status' => 'RECEIVED|PROCESSING|INDEXED|UPDATED|FAILED|DELETING|DELETED|DOCUMENT_FAILED_TO_INDEX',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListGroups

$result = $client->listGroups([/* ... */]);
$promise = $client->listGroupsAsync([/* ... */]);

Provides a list of groups that are mapped to users.

Parameter Syntax

$result = $client->listGroups([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>',
    'indexId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'updatedEarlierThan' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'groupName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListIndices

$result = $client->listIndices([/* ... */]);
$promise = $client->listIndicesAsync([/* ... */]);

Lists the Amazon Q Business indices you have created.

Parameter Syntax

$result = $client->listIndices([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'indices' => [
        [
            'createdAt' => <DateTime>,
            'displayName' => '<string>',
            'indexId' => '<string>',
            'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListMessages

$result = $client->listMessages([/* ... */]);
$promise = $client->listMessagesAsync([/* ... */]);

Gets a list of messages associated with an Amazon Q Business web experience.

Parameter Syntax

$result = $client->listMessages([
    'applicationId' => '<string>', // REQUIRED
    'conversationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'userId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'messages' => [
        [
            'actionExecution' => [
                'payload' => [
                    '<ActionPayloadFieldKey>' => [
                        'value' => [
                        ],
                    ],
                    // ...
                ],
                'payloadFieldNameSeparator' => '<string>',
                'pluginId' => '<string>',
            ],
            'actionReview' => [
                'payload' => [
                    '<ActionPayloadFieldKey>' => [
                        'allowedFormat' => '<string>',
                        'allowedValues' => [
                            [
                                'displayValue' => [
                                ],
                                'value' => [
                                ],
                            ],
                            // ...
                        ],
                        'displayDescription' => '<string>',
                        'displayName' => '<string>',
                        'displayOrder' => <integer>,
                        'required' => true || false,
                        'type' => 'STRING|NUMBER|ARRAY|BOOLEAN',
                        'value' => [
                        ],
                    ],
                    // ...
                ],
                'payloadFieldNameSeparator' => '<string>',
                'pluginId' => '<string>',
                'pluginType' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM',
            ],
            'attachments' => [
                [
                    'error' => [
                        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                        'errorMessage' => '<string>',
                    ],
                    'name' => '<string>',
                    'status' => 'FAILED|SUCCEEDED',
                ],
                // ...
            ],
            'body' => '<string>',
            'messageId' => '<string>',
            'sourceAttribution' => [
                [
                    'citationNumber' => <integer>,
                    'snippet' => '<string>',
                    'textMessageSegments' => [
                        [
                            'beginOffset' => <integer>,
                            'endOffset' => <integer>,
                            'snippetExcerpt' => [
                                'text' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'title' => '<string>',
                    'updatedAt' => <DateTime>,
                    'url' => '<string>',
                ],
                // ...
            ],
            'time' => <DateTime>,
            'type' => 'USER|SYSTEM',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

LicenseNotFoundException:

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListPlugins

$result = $client->listPlugins([/* ... */]);
$promise = $client->listPluginsAsync([/* ... */]);

Lists configured Amazon Q Business plugins.

Parameter Syntax

$result = $client->listPlugins([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'plugins' => [
        [
            'buildStatus' => 'READY|CREATE_IN_PROGRESS|CREATE_FAILED|UPDATE_IN_PROGRESS|UPDATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
            'createdAt' => <DateTime>,
            'displayName' => '<string>',
            'pluginId' => '<string>',
            'serverUrl' => '<string>',
            'state' => 'ENABLED|DISABLED',
            'type' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListRetrievers

$result = $client->listRetrievers([/* ... */]);
$promise = $client->listRetrieversAsync([/* ... */]);

Lists the retriever used by an Amazon Q Business application.

Parameter Syntax

$result = $client->listRetrievers([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'retrievers' => [
        [
            'applicationId' => '<string>',
            'displayName' => '<string>',
            'retrieverId' => '<string>',
            'status' => 'CREATING|ACTIVE|FAILED',
            'type' => 'NATIVE_INDEX|KENDRA_INDEX',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListTagsForResource

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

Gets a list of tags associated with a specified resource. Amazon Q Business applications and data sources can have tags associated with them.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ListWebExperiences

$result = $client->listWebExperiences([/* ... */]);
$promise = $client->listWebExperiencesAsync([/* ... */]);

Lists one or more Amazon Q Business Web Experiences.

Parameter Syntax

$result = $client->listWebExperiences([
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'webExperiences' => [
        [
            'createdAt' => <DateTime>,
            'defaultEndpoint' => '<string>',
            'status' => 'CREATING|ACTIVE|DELETING|FAILED|PENDING_AUTH_CONFIG',
            'updatedAt' => <DateTime>,
            'webExperienceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

PutFeedback

$result = $client->putFeedback([/* ... */]);
$promise = $client->putFeedbackAsync([/* ... */]);

Enables your end user to provide feedback on their Amazon Q Business generated chat responses.

Parameter Syntax

$result = $client->putFeedback([
    'applicationId' => '<string>', // REQUIRED
    'conversationId' => '<string>', // REQUIRED
    'messageCopiedAt' => <integer || string || DateTime>,
    'messageId' => '<string>', // REQUIRED
    'messageUsefulness' => [
        'comment' => '<string>',
        'reason' => 'NOT_FACTUALLY_CORRECT|HARMFUL_OR_UNSAFE|INCORRECT_OR_MISSING_SOURCES|NOT_HELPFUL|FACTUALLY_CORRECT|COMPLETE|RELEVANT_SOURCES|HELPFUL|NOT_BASED_ON_DOCUMENTS|NOT_COMPLETE|NOT_CONCISE|OTHER',
        'submittedAt' => <integer || string || DateTime>, // REQUIRED
        'usefulness' => 'USEFUL|NOT_USEFUL', // REQUIRED
    ],
    'userId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

PutGroup

$result = $client->putGroup([/* ... */]);
$promise = $client->putGroupAsync([/* ... */]);

Create, or updates, a mapping of users—who have access to a document—to groups.

You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their Amazon Q Business chat results.

Parameter Syntax

$result = $client->putGroup([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>',
    'groupMembers' => [ // REQUIRED
        'memberGroups' => [
            [
                'groupName' => '<string>', // REQUIRED
                'type' => 'INDEX|DATASOURCE',
            ],
            // ...
        ],
        'memberUsers' => [
            [
                'type' => 'INDEX|DATASOURCE',
                'userId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'groupName' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
    'type' => 'INDEX|DATASOURCE', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

StartDataSourceSyncJob

$result = $client->startDataSourceSyncJob([/* ... */]);
$promise = $client->startDataSourceSyncJobAsync([/* ... */]);

Starts a data source connector synchronization job. If a synchronization job is already in progress, Amazon Q Business returns a ConflictException.

Parameter Syntax

$result = $client->startDataSourceSyncJob([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

StopDataSourceSyncJob

$result = $client->stopDataSourceSyncJob([/* ... */]);
$promise = $client->stopDataSourceSyncJobAsync([/* ... */]);

Stops an Amazon Q Business data source connector synchronization job already in progress.

Parameter Syntax

$result = $client->stopDataSourceSyncJob([
    'applicationId' => '<string>', // REQUIRED
    'dataSourceId' => '<string>', // REQUIRED
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

TagResource

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

Adds the specified tag to the specified Amazon Q Business application or data source resource. If the tag already exists, the existing value is replaced with the new value.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

UntagResource

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

Removes a tag from an Amazon Q Business application or a data source.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates an existing Amazon Q Business application.

Parameter Syntax

$result = $client->updateApplication([
    'applicationId' => '<string>', // REQUIRED
    'attachmentsConfiguration' => [
        'attachmentsControlMode' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'description' => '<string>',
    'displayName' => '<string>',
    'identityCenterInstanceArn' => '<string>',
    'roleArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

UpdateChatControlsConfiguration

$result = $client->updateChatControlsConfiguration([/* ... */]);
$promise = $client->updateChatControlsConfigurationAsync([/* ... */]);

Updates an set of chat controls configured for an existing Amazon Q Business application.

Parameter Syntax

$result = $client->updateChatControlsConfiguration([
    'applicationId' => '<string>', // REQUIRED
    'blockedPhrasesConfigurationUpdate' => [
        'blockedPhrasesToCreateOrUpdate' => ['<string>', ...],
        'blockedPhrasesToDelete' => ['<string>', ...],
        'systemMessageOverride' => '<string>',
    ],
    'clientToken' => '<string>',
    'creatorModeConfiguration' => [
        'creatorModeControl' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'responseScope' => 'ENTERPRISE_CONTENT_ONLY|EXTENDED_KNOWLEDGE_ENABLED',
    'topicConfigurationsToCreateOrUpdate' => [
        [
            'description' => '<string>',
            'exampleChatMessages' => ['<string>', ...],
            'name' => '<string>', // REQUIRED
            'rules' => [ // REQUIRED
                [
                    'excludedUsersAndGroups' => [
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'includedUsersAndGroups' => [
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'ruleConfiguration' => [
                        'contentBlockerRule' => [
                            'systemMessageOverride' => '<string>',
                        ],
                        'contentRetrievalRule' => [
                            'eligibleDataSources' => [
                                [
                                    'dataSourceId' => '<string>',
                                    'indexId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'ruleType' => 'CONTENT_BLOCKER_RULE|CONTENT_RETRIEVAL_RULE', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'topicConfigurationsToDelete' => [
        [
            'description' => '<string>',
            'exampleChatMessages' => ['<string>', ...],
            'name' => '<string>', // REQUIRED
            'rules' => [ // REQUIRED
                [
                    'excludedUsersAndGroups' => [
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'includedUsersAndGroups' => [
                        'userGroups' => ['<string>', ...],
                        'userIds' => ['<string>', ...],
                    ],
                    'ruleConfiguration' => [
                        'contentBlockerRule' => [
                            'systemMessageOverride' => '<string>',
                        ],
                        'contentRetrievalRule' => [
                            'eligibleDataSources' => [
                                [
                                    'dataSourceId' => '<string>',
                                    'indexId' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'ruleType' => 'CONTENT_BLOCKER_RULE|CONTENT_RETRIEVAL_RULE', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

UpdateDataSource

$result = $client->updateDataSource([/* ... */]);
$promise = $client->updateDataSourceAsync([/* ... */]);

Updates an existing Amazon Q Business data source connector.

Parameter Syntax

$result = $client->updateDataSource([
    'applicationId' => '<string>', // REQUIRED
    'configuration' => [
    ],
    'dataSourceId' => '<string>', // REQUIRED
    'description' => '<string>',
    'displayName' => '<string>',
    'documentEnrichmentConfiguration' => [
        'inlineConfigurations' => [
            [
                'condition' => [
                    'key' => '<string>', // REQUIRED
                    'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                    'value' => [
                        'dateValue' => <integer || string || DateTime>,
                        'longValue' => <integer>,
                        'stringListValue' => ['<string>', ...],
                        'stringValue' => '<string>',
                    ],
                ],
                'documentContentOperator' => 'DELETE',
                'target' => [
                    'attributeValueOperator' => 'DELETE',
                    'key' => '<string>', // REQUIRED
                    'value' => [
                        'dateValue' => <integer || string || DateTime>,
                        'longValue' => <integer>,
                        'stringListValue' => ['<string>', ...],
                        'stringValue' => '<string>',
                    ],
                ],
            ],
            // ...
        ],
        'postExtractionHookConfiguration' => [
            'invocationCondition' => [
                'key' => '<string>', // REQUIRED
                'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                'value' => [
                    'dateValue' => <integer || string || DateTime>,
                    'longValue' => <integer>,
                    'stringListValue' => ['<string>', ...],
                    'stringValue' => '<string>',
                ],
            ],
            'lambdaArn' => '<string>',
            'roleArn' => '<string>',
            's3BucketName' => '<string>',
        ],
        'preExtractionHookConfiguration' => [
            'invocationCondition' => [
                'key' => '<string>', // REQUIRED
                'operator' => 'GREATER_THAN|GREATER_THAN_OR_EQUALS|LESS_THAN|LESS_THAN_OR_EQUALS|EQUALS|NOT_EQUALS|CONTAINS|NOT_CONTAINS|EXISTS|NOT_EXISTS|BEGINS_WITH', // REQUIRED
                'value' => [
                    'dateValue' => <integer || string || DateTime>,
                    'longValue' => <integer>,
                    'stringListValue' => ['<string>', ...],
                    'stringValue' => '<string>',
                ],
            ],
            'lambdaArn' => '<string>',
            'roleArn' => '<string>',
            's3BucketName' => '<string>',
        ],
    ],
    'indexId' => '<string>', // REQUIRED
    'roleArn' => '<string>',
    'syncSchedule' => '<string>',
    'vpcConfiguration' => [
        'securityGroupIds' => ['<string>', ...], // REQUIRED
        'subnetIds' => ['<string>', ...], // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

UpdateIndex

$result = $client->updateIndex([/* ... */]);
$promise = $client->updateIndexAsync([/* ... */]);

Updates an Amazon Q Business index.

Parameter Syntax

$result = $client->updateIndex([
    'applicationId' => '<string>', // REQUIRED
    'capacityConfiguration' => [
        'units' => <integer>,
    ],
    'description' => '<string>',
    'displayName' => '<string>',
    'documentAttributeConfigurations' => [
        [
            'name' => '<string>',
            'search' => 'ENABLED|DISABLED',
            'type' => 'STRING|STRING_LIST|NUMBER|DATE',
        ],
        // ...
    ],
    'indexId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

UpdatePlugin

$result = $client->updatePlugin([/* ... */]);
$promise = $client->updatePluginAsync([/* ... */]);

Updates an Amazon Q Business plugin.

Parameter Syntax

$result = $client->updatePlugin([
    'applicationId' => '<string>', // REQUIRED
    'authConfiguration' => [
        'basicAuthConfiguration' => [
            'roleArn' => '<string>', // REQUIRED
            'secretArn' => '<string>', // REQUIRED
        ],
        'noAuthConfiguration' => [
        ],
        'oAuth2ClientCredentialConfiguration' => [
            'roleArn' => '<string>', // REQUIRED
            'secretArn' => '<string>', // REQUIRED
        ],
    ],
    'customPluginConfiguration' => [
        'apiSchema' => [ // REQUIRED
            'payload' => '<string>',
            's3' => [
                'bucket' => '<string>', // REQUIRED
                'key' => '<string>', // REQUIRED
            ],
        ],
        'apiSchemaType' => 'OPEN_API_V3', // REQUIRED
        'description' => '<string>', // REQUIRED
    ],
    'displayName' => '<string>',
    'pluginId' => '<string>', // REQUIRED
    'serverUrl' => '<string>',
    'state' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

UpdateRetriever

$result = $client->updateRetriever([/* ... */]);
$promise = $client->updateRetrieverAsync([/* ... */]);

Updates the retriever used for your Amazon Q Business application.

Parameter Syntax

$result = $client->updateRetriever([
    'applicationId' => '<string>', // REQUIRED
    'configuration' => [
        'kendraIndexConfiguration' => [
            'indexId' => '<string>', // REQUIRED
        ],
        'nativeIndexConfiguration' => [
            'boostingOverride' => [
                '<DocumentAttributeKey>' => [
                    'dateConfiguration' => [
                        'boostingDurationInSeconds' => <integer>,
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                    ],
                    'numberConfiguration' => [
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                        'boostingType' => 'PRIORITIZE_LARGER_VALUES|PRIORITIZE_SMALLER_VALUES',
                    ],
                    'stringConfiguration' => [
                        'attributeValueBoosting' => ['<string>', ...],
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                    ],
                    'stringListConfiguration' => [
                        'boostingLevel' => 'NONE|LOW|MEDIUM|HIGH|VERY_HIGH', // REQUIRED
                    ],
                ],
                // ...
            ],
            'indexId' => '<string>', // REQUIRED
        ],
    ],
    'displayName' => '<string>',
    'retrieverId' => '<string>', // REQUIRED
    'roleArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

Updates a information associated with a user id.

Parameter Syntax

$result = $client->updateUser([
    'applicationId' => '<string>', // REQUIRED
    'userAliasesToDelete' => [
        [
            'dataSourceId' => '<string>',
            'indexId' => '<string>',
            'userId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'userAliasesToUpdate' => [
        [
            'dataSourceId' => '<string>',
            'indexId' => '<string>',
            'userId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'userId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'userAliasesAdded' => [
        [
            'dataSourceId' => '<string>',
            'indexId' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
    'userAliasesDeleted' => [
        [
            'dataSourceId' => '<string>',
            'indexId' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
    'userAliasesUpdated' => [
        [
            'dataSourceId' => '<string>',
            'indexId' => '<string>',
            'userId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

ServiceQuotaExceededException:

You have exceeded the set limits for your Amazon Q Business service.

UpdateWebExperience

$result = $client->updateWebExperience([/* ... */]);
$promise = $client->updateWebExperienceAsync([/* ... */]);

Updates an Amazon Q Business web experience.

Parameter Syntax

$result = $client->updateWebExperience([
    'applicationId' => '<string>', // REQUIRED
    'authenticationConfiguration' => [
        'samlConfiguration' => [
            'metadataXML' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
            'userGroupAttribute' => '<string>',
            'userIdAttribute' => '<string>', // REQUIRED
        ],
    ],
    'roleArn' => '<string>',
    'samplePromptsControlMode' => 'ENABLED|DISABLED',
    'subtitle' => '<string>',
    'title' => '<string>',
    'webExperienceId' => '<string>', // REQUIRED
    'welcomeMessage' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

InternalServerException:

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

ConflictException:

You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.

ThrottlingException:

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException:

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

AccessDeniedException:

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.