AssociatePermission

$result = $client->associatePermission([/* ... */]);
$promise = $client->associatePermissionAsync([/* ... */]);

Adds or updates a permission policy for a Q Business application, allowing cross-account access for an ISV. This operation creates a new policy statement for the specified Q Business application. The policy statement defines the IAM actions that the ISV is allowed to perform on the Q Business application's resources.

Parameter Syntax

$result = $client->associatePermission([
    'actions' => ['<string>', ...], // REQUIRED
    'applicationId' => '<string>', // REQUIRED
    'principal' => '<string>', // REQUIRED
    'statementId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 inconsistencies 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.

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 application or plugin 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 inconsistencies 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
            'mediaExtractionConfiguration' => [
                'imageExtractionConfiguration' => [
                    'imageExtractionStatus' => 'ENABLED|DISABLED', // 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 application or plugin 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 inconsistencies 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' => [
        [
            'copyFrom' => [
                'conversation' => [
                    'attachmentId' => '<string>', // REQUIRED
                    'conversationId' => '<string>', // REQUIRED
                ],
            ],
            'data' => <string || resource || Psr\Http\Message\StreamInterface>,
            'name' => '<string>',
        ],
        // ...
    ],
    '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' => [
                        ],
                    ],
                    // ...
                ],
                'arrayItemJsonSchema' => [
                ],
                '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|QUICKSIGHT|SERVICENOW_NOW_PLATFORM|JIRA_CLOUD|SALESFORCE_CRM|ZENDESK_SUITE|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|MICROSOFT_TEAMS|MICROSOFT_EXCHANGE|PAGERDUTY_ADVANCE|SMARTSHEET|ASANA',
    ],
    'authChallengeRequest' => [
        'authorizationUrl' => '<string>',
    ],
    'conversationId' => '<string>',
    'failedAttachments' => [
        [
            'attachmentId' => '<string>',
            'conversationId' => '<string>',
            'error' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'name' => '<string>',
            'status' => 'FAILED|SUCCESS',
        ],
        // ...
    ],
    'sourceAttributions' => [
        [
            'citationNumber' => <integer>,
            'snippet' => '<string>',
            'textMessageSegments' => [
                [
                    'beginOffset' => <integer>,
                    'endOffset' => <integer>,
                    'mediaId' => '<string>',
                    'mediaMimeType' => '<string>',
                    'snippetExcerpt' => [
                        'text' => '<string>',
                    ],
                ],
                // ...
            ],
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'url' => '<string>',
        ],
        // ...
    ],
    'systemMessage' => '<string>',
    'systemMessageId' => '<string>',
    'userMessageId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 inconsistencies with your resources and try again.

ExternalResourceException:

An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors 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
    ],
    'clientIdsForOIDC' => ['<string>', ...],
    'clientToken' => '<string>',
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'encryptionConfiguration' => [
        'kmsKeyId' => '<string>',
    ],
    'iamIdentityProviderArn' => '<string>',
    'identityCenterInstanceArn' => '<string>',
    'identityType' => 'AWS_IAM_IDP_SAML|AWS_IAM_IDP_OIDC|AWS_IAM_IDC|AWS_QUICKSIGHT_IDP',
    'personalizationConfiguration' => [
        'personalizationControlMode' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'qAppsConfiguration' => [
        'qAppsControlMode' => 'ENABLED|DISABLED', // REQUIRED
    ],
    'quickSightConfiguration' => [
        'clientNamespace' => '<string>', // REQUIRED
    ],
    'roleArn' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 inconsistencies 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.

CreateDataAccessor

$result = $client->createDataAccessor([/* ... */]);
$promise = $client->createDataAccessorAsync([/* ... */]);

Creates a new data accessor for an ISV to access data from a Q Business application. The data accessor is an entity that represents the ISV's access to the Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an AWS IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Q Business application.

Parameter Syntax

$result = $client->createDataAccessor([
    'actionConfigurations' => [ // REQUIRED
        [
            'action' => '<string>', // REQUIRED
            'filterConfiguration' => [
                'documentAttributeFilter' => [ // REQUIRED
                    '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
                        // ...
                    ],
                ],
            ],
        ],
        // ...
    ],
    'applicationId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'principal' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'dataAccessorArn' => '<string>',
    'dataAccessorId' => '<string>',
    'idcApplicationArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 inconsistencies 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
    'mediaExtractionConfiguration' => [
        'imageExtractionConfiguration' => [
            'imageExtractionStatus' => 'ENABLED|DISABLED', // 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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
        ],
        'idcAuthConfiguration' => [
            'idcApplicationArn' => '<string>', // REQUIRED
            'roleArn' => '<string>', // REQUIRED
        ],
        'noAuthConfiguration' => [
        ],
        'oAuth2ClientCredentialConfiguration' => [
            'authorizationUrl' => '<string>',
            'roleArn' => '<string>', // REQUIRED
            'secretArn' => '<string>', // REQUIRED
            'tokenUrl' => '<string>',
        ],
    ],
    '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|QUICKSIGHT|SERVICENOW_NOW_PLATFORM|JIRA_CLOUD|SALESFORCE_CRM|ZENDESK_SUITE|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|MICROSOFT_TEAMS|MICROSOFT_EXCHANGE|PAGERDUTY_ADVANCE|SMARTSHEET|ASANA', // 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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
    'browserExtensionConfiguration' => [
        'enabledBrowserExtensions' => ['<string>', ...], // REQUIRED
    ],
    'clientToken' => '<string>',
    'customizationConfiguration' => [
        'customCSSUrl' => '<string>',
        'faviconUrl' => '<string>',
        'fontUrl' => '<string>',
        'logoUrl' => '<string>',
    ],
    'identityProviderConfiguration' => [
        'openIDConnectConfiguration' => [
            'secretsArn' => '<string>', // REQUIRED
            'secretsRole' => '<string>', // REQUIRED
        ],
        'samlConfiguration' => [
            'authenticationUrl' => '<string>', // REQUIRED
        ],
    ],
    'origins' => ['<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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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 application or plugin 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 application or plugin 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.

DeleteDataAccessor

$result = $client->deleteDataAccessor([/* ... */]);
$promise = $client->deleteDataAccessorAsync([/* ... */]);

Deletes a specified data accessor. This operation permanently removes the data accessor and its associated AWS IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 inconsistencies 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.

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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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 application or plugin 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 inconsistencies 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.

DisassociatePermission

$result = $client->disassociatePermission([/* ... */]);
$promise = $client->disassociatePermissionAsync([/* ... */]);

Removes a permission policy from a Q Business application, revoking the cross-account access that was previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 inconsistencies 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',
    ],
    'autoSubscriptionConfiguration' => [
        'autoSubscribe' => 'ENABLED|DISABLED',
        'defaultSubscriptionType' => 'Q_LITE|Q_BUSINESS',
    ],
    'clientIdsForOIDC' => ['<string>', ...],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'displayName' => '<string>',
    'encryptionConfiguration' => [
        'kmsKeyId' => '<string>',
    ],
    'error' => [
        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
        'errorMessage' => '<string>',
    ],
    'iamIdentityProviderArn' => '<string>',
    'identityCenterApplicationArn' => '<string>',
    'identityType' => 'AWS_IAM_IDP_SAML|AWS_IAM_IDP_OIDC|AWS_IAM_IDC|AWS_QUICKSIGHT_IDP',
    'personalizationConfiguration' => [
        'personalizationControlMode' => 'ENABLED|DISABLED',
    ],
    'qAppsConfiguration' => [
        'qAppsControlMode' => 'ENABLED|DISABLED',
    ],
    'quickSightConfiguration' => [
        'clientNamespace' => '<string>',
    ],
    'roleArn' => '<string>',
    'status' => 'CREATING|ACTIVE|DELETING|FAILED|UPDATING',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 application or plugin 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.

GetDataAccessor

$result = $client->getDataAccessor([/* ... */]);
$promise = $client->getDataAccessorAsync([/* ... */]);

Retrieves information about a specified data accessor. This operation returns details about the data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated Q Business application and AWS IAM Identity Center application, the IAM role for the ISV, the action configurations, and the timestamps for when the data accessor was created and last updated.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'actionConfigurations' => [
        [
            'action' => '<string>',
            'filterConfiguration' => [
                'documentAttributeFilter' => [
                    'andAllFilters' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'containsAll' => [
                        'name' => '<string>',
                        'value' => [
                            'dateValue' => <DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'containsAny' => [
                        'name' => '<string>',
                        'value' => [
                            'dateValue' => <DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'equalsTo' => [
                        'name' => '<string>',
                        'value' => [
                            'dateValue' => <DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'greaterThan' => [
                        'name' => '<string>',
                        'value' => [
                            'dateValue' => <DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'greaterThanOrEquals' => [
                        'name' => '<string>',
                        'value' => [
                            'dateValue' => <DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'lessThan' => [
                        'name' => '<string>',
                        'value' => [
                            'dateValue' => <DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'lessThanOrEquals' => [
                        'name' => '<string>',
                        'value' => [
                            'dateValue' => <DateTime>,
                            'longValue' => <integer>,
                            'stringListValue' => ['<string>', ...],
                            'stringValue' => '<string>',
                        ],
                    ],
                    'notFilter' => [...], // RECURSIVE
                    'orAllFilters' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                ],
            ],
        ],
        // ...
    ],
    'applicationId' => '<string>',
    'createdAt' => <DateTime>,
    'dataAccessorArn' => '<string>',
    'dataAccessorId' => '<string>',
    'displayName' => '<string>',
    'idcApplicationArn' => '<string>',
    'principal' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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>',
    'mediaExtractionConfiguration' => [
        'imageExtractionConfiguration' => [
            'imageExtractionStatus' => 'ENABLED|DISABLED',
        ],
    ],
    '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 application or plugin 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 application or plugin 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 inconsistencies 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 application or plugin 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.

GetMedia

$result = $client->getMedia([/* ... */]);
$promise = $client->getMediaAsync([/* ... */]);

Returns the image bytes corresponding to a media object. If you have implemented your own application with the Chat and ChatSync APIs, and have enabled content extraction from visual data in Amazon Q Business, you use the GetMedia API operation to download the images so you can show them in your UI with responses.

For more information, see Extracting semantic meaning from images and visuals.

Parameter Syntax

$result = $client->getMedia([
    'applicationId' => '<string>', // REQUIRED
    'conversationId' => '<string>', // REQUIRED
    'mediaId' => '<string>', // REQUIRED
    'messageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'mediaBytes' => <string || resource || Psr\Http\Message\StreamInterface>,
    'mediaMimeType' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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.

MediaTooLargeException:

The requested media object is too large to be returned.

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>',
        ],
        'idcAuthConfiguration' => [
            'idcApplicationArn' => '<string>',
            'roleArn' => '<string>',
        ],
        'noAuthConfiguration' => [
        ],
        'oAuth2ClientCredentialConfiguration' => [
            'authorizationUrl' => '<string>',
            'roleArn' => '<string>',
            'secretArn' => '<string>',
            'tokenUrl' => '<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|QUICKSIGHT|SERVICENOW_NOW_PLATFORM|JIRA_CLOUD|SALESFORCE_CRM|ZENDESK_SUITE|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|MICROSOFT_TEAMS|MICROSOFT_EXCHANGE|PAGERDUTY_ADVANCE|SMARTSHEET|ASANA',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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.

GetPolicy

$result = $client->getPolicy([/* ... */]);
$promise = $client->getPolicyAsync([/* ... */]);

Retrieves the current permission policy for a Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 application or plugin 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 application or plugin 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 inconsistencies 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>',
        ],
    ],
    'browserExtensionConfiguration' => [
        'enabledBrowserExtensions' => ['<string>', ...],
    ],
    'createdAt' => <DateTime>,
    'customizationConfiguration' => [
        'customCSSUrl' => '<string>',
        'faviconUrl' => '<string>',
        'fontUrl' => '<string>',
        'logoUrl' => '<string>',
    ],
    'defaultEndpoint' => '<string>',
    'error' => [
        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
        'errorMessage' => '<string>',
    ],
    'identityProviderConfiguration' => [
        'openIDConnectConfiguration' => [
            'secretsArn' => '<string>',
            'secretsRole' => '<string>',
        ],
        'samlConfiguration' => [
            'authenticationUrl' => '<string>',
        ],
    ],
    'origins' => ['<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 application or plugin 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>',
            'identityType' => 'AWS_IAM_IDP_SAML|AWS_IAM_IDP_OIDC|AWS_IAM_IDC|AWS_QUICKSIGHT_IDP',
            'quickSightConfiguration' => [
                'clientNamespace' => '<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.

ListAttachments

$result = $client->listAttachments([/* ... */]);
$promise = $client->listAttachmentsAsync([/* ... */]);

Gets a list of attachments associated with an Amazon Q Business web experience or a list of attachements associated with a specific Amazon Q Business conversation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'attachments' => [
        [
            'attachmentId' => '<string>',
            'conversationId' => '<string>',
            'copyFrom' => [
                'conversation' => [
                    'attachmentId' => '<string>',
                    'conversationId' => '<string>',
                ],
            ],
            'createdAt' => <DateTime>,
            'error' => [
                'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                'errorMessage' => '<string>',
            ],
            'fileSize' => <integer>,
            'fileType' => '<string>',
            'md5chksum' => '<string>',
            'name' => '<string>',
            'status' => 'FAILED|SUCCESS',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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.

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 application or plugin 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.

ListDataAccessors

$result = $client->listDataAccessors([/* ... */]);
$promise = $client->listDataAccessorsAsync([/* ... */]);

Lists the data accessors for a Q Business application. This operation returns a paginated list of data accessor summaries, including the friendly name, unique identifier, ARN, associated IAM role, and creation/update timestamps for each data accessor.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'dataAccessors' => [
        [
            'createdAt' => <DateTime>,
            'dataAccessorArn' => '<string>',
            'dataAccessorId' => '<string>',
            'displayName' => '<string>',
            'idcApplicationArn' => '<string>',
            'principal' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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.

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 application or plugin 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 inconsistencies 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.

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 application or plugin 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 application or plugin 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 application or plugin 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 inconsistencies 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 application or plugin 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' => [
                                ],
                            ],
                            // ...
                        ],
                        'arrayItemJsonSchema' => [
                        ],
                        '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|QUICKSIGHT|SERVICENOW_NOW_PLATFORM|JIRA_CLOUD|SALESFORCE_CRM|ZENDESK_SUITE|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|MICROSOFT_TEAMS|MICROSOFT_EXCHANGE|PAGERDUTY_ADVANCE|SMARTSHEET|ASANA',
            ],
            'attachments' => [
                [
                    'attachmentId' => '<string>',
                    'conversationId' => '<string>',
                    'error' => [
                        'errorCode' => 'InternalError|InvalidRequest|ResourceInactive|ResourceNotFound',
                        'errorMessage' => '<string>',
                    ],
                    'name' => '<string>',
                    'status' => 'FAILED|SUCCESS',
                ],
                // ...
            ],
            'body' => '<string>',
            'messageId' => '<string>',
            'sourceAttribution' => [
                [
                    'citationNumber' => <integer>,
                    'snippet' => '<string>',
                    'textMessageSegments' => [
                        [
                            'beginOffset' => <integer>,
                            'endOffset' => <integer>,
                            'mediaId' => '<string>',
                            'mediaMimeType' => '<string>',
                            'snippetExcerpt' => [
                                'text' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                    'title' => '<string>',
                    'updatedAt' => <DateTime>,
                    'url' => '<string>',
                ],
                // ...
            ],
            'time' => <DateTime>,
            'type' => 'USER|SYSTEM',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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.

ListPluginActions

$result = $client->listPluginActions([/* ... */]);
$promise = $client->listPluginActionsAsync([/* ... */]);

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'actionIdentifier' => '<string>',
            'description' => '<string>',
            'displayName' => '<string>',
            'instructionExample' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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.

ListPluginTypeActions

$result = $client->listPluginTypeActions([/* ... */]);
$promise = $client->listPluginTypeActionsAsync([/* ... */]);

Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

Parameter Syntax

$result = $client->listPluginTypeActions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pluginType' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM|QUICKSIGHT|SERVICENOW_NOW_PLATFORM|JIRA_CLOUD|SALESFORCE_CRM|ZENDESK_SUITE|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|MICROSOFT_TEAMS|MICROSOFT_EXCHANGE|PAGERDUTY_ADVANCE|SMARTSHEET|ASANA', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'actionIdentifier' => '<string>',
            'description' => '<string>',
            'displayName' => '<string>',
            'instructionExample' => '<string>',
        ],
        // ...
    ],
    '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.

ListPluginTypeMetadata

$result = $client->listPluginTypeMetadata([/* ... */]);
$promise = $client->listPluginTypeMetadataAsync([/* ... */]);

Lists metadata for all Amazon Q Business plugin types.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'items' => [
        [
            'category' => 'Customer relationship management (CRM)|Project management|Communication|Productivity|Ticketing and incident management',
            'description' => '<string>',
            'type' => 'SERVICE_NOW|SALESFORCE|JIRA|ZENDESK|CUSTOM|QUICKSIGHT|SERVICENOW_NOW_PLATFORM|JIRA_CLOUD|SALESFORCE_CRM|ZENDESK_SUITE|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|MICROSOFT_TEAMS|MICROSOFT_EXCHANGE|PAGERDUTY_ADVANCE|SMARTSHEET|ASANA',
        ],
        // ...
    ],
    '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.

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|QUICKSIGHT|SERVICENOW_NOW_PLATFORM|JIRA_CLOUD|SALESFORCE_CRM|ZENDESK_SUITE|ATLASSIAN_CONFLUENCE|GOOGLE_CALENDAR|MICROSOFT_TEAMS|MICROSOFT_EXCHANGE|PAGERDUTY_ADVANCE|SMARTSHEET|ASANA',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The application or plugin 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 application or plugin 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 application or plugin 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.