CreateAssistant

$result = $client->createAssistant([/* ... */]);
$promise = $client->createAssistantAsync([/* ... */]);

Creates an Amazon Connect Wisdom assistant.

Parameter Syntax

$result = $client->createAssistant([
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'serverSideEncryptionConfiguration' => [
        'kmsKeyId' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'type' => 'AGENT', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assistant' => [
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'description' => '<string>',
        'integrationConfiguration' => [
            'topicIntegrationArn' => '<string>',
        ],
        'name' => '<string>',
        'serverSideEncryptionConfiguration' => [
            'kmsKeyId' => '<string>',
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'type' => 'AGENT',
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException:

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateAssistantAssociation

$result = $client->createAssistantAssociation([/* ... */]);
$promise = $client->createAssistantAssociationAsync([/* ... */]);

Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

Parameter Syntax

$result = $client->createAssistantAssociation([
    'assistantId' => '<string>', // REQUIRED
    'association' => [ // REQUIRED
        'knowledgeBaseId' => '<string>',
    ],
    'associationType' => 'KNOWLEDGE_BASE', // REQUIRED
    'clientToken' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'assistantAssociation' => [
        'assistantArn' => '<string>',
        'assistantAssociationArn' => '<string>',
        'assistantAssociationId' => '<string>',
        'assistantId' => '<string>',
        'associationData' => [
            'knowledgeBaseAssociation' => [
                'knowledgeBaseArn' => '<string>',
                'knowledgeBaseId' => '<string>',
            ],
        ],
        'associationType' => 'KNOWLEDGE_BASE',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException:

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

CreateContent

$result = $client->createContent([/* ... */]);
$promise = $client->createContentAsync([/* ... */]);

Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.

Parameter Syntax

$result = $client->createContent([
    'clientToken' => '<string>',
    'knowledgeBaseId' => '<string>', // REQUIRED
    'metadata' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'overrideLinkOutUri' => '<string>',
    'tags' => ['<string>', ...],
    'title' => '<string>',
    'uploadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'content' => [
        'contentArn' => '<string>',
        'contentId' => '<string>',
        'contentType' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'linkOutUri' => '<string>',
        'metadata' => ['<string>', ...],
        'name' => '<string>',
        'revisionId' => '<string>',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'title' => '<string>',
        'url' => '<string>',
        'urlExpiry' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException:

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

CreateKnowledgeBase

$result = $client->createKnowledgeBase([/* ... */]);
$promise = $client->createKnowledgeBaseAsync([/* ... */]);

Creates a knowledge base.

Parameter Syntax

$result = $client->createKnowledgeBase([
    'clientToken' => '<string>',
    'description' => '<string>',
    'knowledgeBaseType' => 'EXTERNAL|CUSTOM|QUICK_RESPONSES', // REQUIRED
    'name' => '<string>', // REQUIRED
    'renderingConfiguration' => [
        'templateUri' => '<string>',
    ],
    'serverSideEncryptionConfiguration' => [
        'kmsKeyId' => '<string>',
    ],
    'sourceConfiguration' => [
        'appIntegrations' => [
            'appIntegrationArn' => '<string>', // REQUIRED
            'objectFields' => ['<string>', ...],
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'knowledgeBase' => [
        'description' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseType' => 'EXTERNAL|CUSTOM|QUICK_RESPONSES',
        'lastContentModificationTime' => <DateTime>,
        'name' => '<string>',
        'renderingConfiguration' => [
            'templateUri' => '<string>',
        ],
        'serverSideEncryptionConfiguration' => [
            'kmsKeyId' => '<string>',
        ],
        'sourceConfiguration' => [
            'appIntegrations' => [
                'appIntegrationArn' => '<string>',
                'objectFields' => ['<string>', ...],
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException:

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateQuickResponse

$result = $client->createQuickResponse([/* ... */]);
$promise = $client->createQuickResponseAsync([/* ... */]);

Creates a Wisdom quick response.

Parameter Syntax

$result = $client->createQuickResponse([
    'channels' => ['<string>', ...],
    'clientToken' => '<string>',
    'content' => [ // REQUIRED
        'content' => '<string>',
    ],
    'contentType' => '<string>',
    'description' => '<string>',
    'groupingConfiguration' => [
        'criteria' => '<string>',
        'values' => ['<string>', ...],
    ],
    'isActive' => true || false,
    'knowledgeBaseId' => '<string>', // REQUIRED
    'language' => '<string>',
    'name' => '<string>', // REQUIRED
    'shortcutKey' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'quickResponse' => [
        'channels' => ['<string>', ...],
        'contentType' => '<string>',
        'contents' => [
            'markdown' => [
                'content' => '<string>',
            ],
            'plainText' => [
                'content' => '<string>',
            ],
        ],
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'groupingConfiguration' => [
            'criteria' => '<string>',
            'values' => ['<string>', ...],
        ],
        'isActive' => true || false,
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'language' => '<string>',
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'name' => '<string>',
        'quickResponseArn' => '<string>',
        'quickResponseId' => '<string>',
        'shortcutKey' => '<string>',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException:

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

CreateSession

$result = $client->createSession([/* ... */]);
$promise = $client->createSessionAsync([/* ... */]);

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.

Parameter Syntax

$result = $client->createSession([
    'assistantId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'session' => [
        'description' => '<string>',
        'integrationConfiguration' => [
            'topicIntegrationArn' => '<string>',
        ],
        'name' => '<string>',
        'sessionArn' => '<string>',
        'sessionId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

ResourceNotFoundException:

The specified resource does not exist.

DeleteAssistant

$result = $client->deleteAssistant([/* ... */]);
$promise = $client->deleteAssistantAsync([/* ... */]);

Deletes an assistant.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

DeleteAssistantAssociation

$result = $client->deleteAssistantAssociation([/* ... */]);
$promise = $client->deleteAssistantAssociationAsync([/* ... */]);

Deletes an assistant association.

Parameter Syntax

$result = $client->deleteAssistantAssociation([
    'assistantAssociationId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

DeleteContent

$result = $client->deleteContent([/* ... */]);
$promise = $client->deleteContentAsync([/* ... */]);

Deletes the content.

Parameter Syntax

$result = $client->deleteContent([
    'contentId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

DeleteImportJob

$result = $client->deleteImportJob([/* ... */]);
$promise = $client->deleteImportJobAsync([/* ... */]);

Deletes the quick response import job.

Parameter Syntax

$result = $client->deleteImportJob([
    'importJobId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

DeleteKnowledgeBase

$result = $client->deleteKnowledgeBase([/* ... */]);
$promise = $client->deleteKnowledgeBaseAsync([/* ... */]);

Deletes the knowledge base.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

DeleteQuickResponse

$result = $client->deleteQuickResponse([/* ... */]);
$promise = $client->deleteQuickResponseAsync([/* ... */]);

Deletes a quick response.

Parameter Syntax

$result = $client->deleteQuickResponse([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'quickResponseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetAssistant

$result = $client->getAssistant([/* ... */]);
$promise = $client->getAssistantAsync([/* ... */]);

Retrieves information about an assistant.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assistant' => [
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'description' => '<string>',
        'integrationConfiguration' => [
            'topicIntegrationArn' => '<string>',
        ],
        'name' => '<string>',
        'serverSideEncryptionConfiguration' => [
            'kmsKeyId' => '<string>',
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'type' => 'AGENT',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetAssistantAssociation

$result = $client->getAssistantAssociation([/* ... */]);
$promise = $client->getAssistantAssociationAsync([/* ... */]);

Retrieves information about an assistant association.

Parameter Syntax

$result = $client->getAssistantAssociation([
    'assistantAssociationId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'assistantAssociation' => [
        'assistantArn' => '<string>',
        'assistantAssociationArn' => '<string>',
        'assistantAssociationId' => '<string>',
        'assistantId' => '<string>',
        'associationData' => [
            'knowledgeBaseAssociation' => [
                'knowledgeBaseArn' => '<string>',
                'knowledgeBaseId' => '<string>',
            ],
        ],
        'associationType' => 'KNOWLEDGE_BASE',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetContent

$result = $client->getContent([/* ... */]);
$promise = $client->getContentAsync([/* ... */]);

Retrieves content, including a pre-signed URL to download the content.

Parameter Syntax

$result = $client->getContent([
    'contentId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'content' => [
        'contentArn' => '<string>',
        'contentId' => '<string>',
        'contentType' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'linkOutUri' => '<string>',
        'metadata' => ['<string>', ...],
        'name' => '<string>',
        'revisionId' => '<string>',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'title' => '<string>',
        'url' => '<string>',
        'urlExpiry' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetContentSummary

$result = $client->getContentSummary([/* ... */]);
$promise = $client->getContentSummaryAsync([/* ... */]);

Retrieves summary information about the content.

Parameter Syntax

$result = $client->getContentSummary([
    'contentId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'contentSummary' => [
        'contentArn' => '<string>',
        'contentId' => '<string>',
        'contentType' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'metadata' => ['<string>', ...],
        'name' => '<string>',
        'revisionId' => '<string>',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'title' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetImportJob

$result = $client->getImportJob([/* ... */]);
$promise = $client->getImportJobAsync([/* ... */]);

Retrieves the started import job.

Parameter Syntax

$result = $client->getImportJob([
    'importJobId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'importJob' => [
        'createdTime' => <DateTime>,
        'externalSourceConfiguration' => [
            'configuration' => [
                'connectConfiguration' => [
                    'instanceId' => '<string>',
                ],
            ],
            'source' => 'AMAZON_CONNECT',
        ],
        'failedRecordReport' => '<string>',
        'importJobId' => '<string>',
        'importJobType' => 'QUICK_RESPONSES',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'metadata' => ['<string>', ...],
        'status' => 'START_IN_PROGRESS|FAILED|COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'uploadId' => '<string>',
        'url' => '<string>',
        'urlExpiry' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetKnowledgeBase

$result = $client->getKnowledgeBase([/* ... */]);
$promise = $client->getKnowledgeBaseAsync([/* ... */]);

Retrieves information about the knowledge base.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'knowledgeBase' => [
        'description' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseType' => 'EXTERNAL|CUSTOM|QUICK_RESPONSES',
        'lastContentModificationTime' => <DateTime>,
        'name' => '<string>',
        'renderingConfiguration' => [
            'templateUri' => '<string>',
        ],
        'serverSideEncryptionConfiguration' => [
            'kmsKeyId' => '<string>',
        ],
        'sourceConfiguration' => [
            'appIntegrations' => [
                'appIntegrationArn' => '<string>',
                'objectFields' => ['<string>', ...],
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetQuickResponse

$result = $client->getQuickResponse([/* ... */]);
$promise = $client->getQuickResponseAsync([/* ... */]);

Retrieves the quick response.

Parameter Syntax

$result = $client->getQuickResponse([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'quickResponseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'quickResponse' => [
        'channels' => ['<string>', ...],
        'contentType' => '<string>',
        'contents' => [
            'markdown' => [
                'content' => '<string>',
            ],
            'plainText' => [
                'content' => '<string>',
            ],
        ],
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'groupingConfiguration' => [
            'criteria' => '<string>',
            'values' => ['<string>', ...],
        ],
        'isActive' => true || false,
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'language' => '<string>',
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'name' => '<string>',
        'quickResponseArn' => '<string>',
        'quickResponseId' => '<string>',
        'shortcutKey' => '<string>',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetRecommendations

$result = $client->getRecommendations([/* ... */]);
$promise = $client->getRecommendationsAsync([/* ... */]);

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Parameter Syntax

$result = $client->getRecommendations([
    'assistantId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'sessionId' => '<string>', // REQUIRED
    'waitTimeSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'recommendations' => [
        [
            'document' => [
                'contentReference' => [
                    'contentArn' => '<string>',
                    'contentId' => '<string>',
                    'knowledgeBaseArn' => '<string>',
                    'knowledgeBaseId' => '<string>',
                ],
                'excerpt' => [
                    'highlights' => [
                        [
                            'beginOffsetInclusive' => <integer>,
                            'endOffsetExclusive' => <integer>,
                        ],
                        // ...
                    ],
                    'text' => '<string>',
                ],
                'title' => [
                    'highlights' => [
                        [
                            'beginOffsetInclusive' => <integer>,
                            'endOffsetExclusive' => <integer>,
                        ],
                        // ...
                    ],
                    'text' => '<string>',
                ],
            ],
            'recommendationId' => '<string>',
            'relevanceLevel' => 'HIGH|MEDIUM|LOW',
            'relevanceScore' => <float>,
            'type' => 'KNOWLEDGE_CONTENT',
        ],
        // ...
    ],
    'triggers' => [
        [
            'data' => [
                'query' => [
                    'text' => '<string>',
                ],
            ],
            'id' => '<string>',
            'recommendationIds' => ['<string>', ...],
            'source' => 'ISSUE_DETECTION|RULE_EVALUATION|OTHER',
            'type' => 'QUERY',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

GetSession

$result = $client->getSession([/* ... */]);
$promise = $client->getSessionAsync([/* ... */]);

Retrieves information for a specified session.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'session' => [
        'description' => '<string>',
        'integrationConfiguration' => [
            'topicIntegrationArn' => '<string>',
        ],
        'name' => '<string>',
        'sessionArn' => '<string>',
        'sessionId' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ListAssistantAssociations

$result = $client->listAssistantAssociations([/* ... */]);
$promise = $client->listAssistantAssociationsAsync([/* ... */]);

Lists information about assistant associations.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assistantAssociationSummaries' => [
        [
            'assistantArn' => '<string>',
            'assistantAssociationArn' => '<string>',
            'assistantAssociationId' => '<string>',
            'assistantId' => '<string>',
            'associationData' => [
                'knowledgeBaseAssociation' => [
                    'knowledgeBaseArn' => '<string>',
                    'knowledgeBaseId' => '<string>',
                ],
            ],
            'associationType' => 'KNOWLEDGE_BASE',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ListAssistants

$result = $client->listAssistants([/* ... */]);
$promise = $client->listAssistantsAsync([/* ... */]);

Lists information about assistants.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'assistantSummaries' => [
        [
            'assistantArn' => '<string>',
            'assistantId' => '<string>',
            'description' => '<string>',
            'integrationConfiguration' => [
                'topicIntegrationArn' => '<string>',
            ],
            'name' => '<string>',
            'serverSideEncryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
            'tags' => ['<string>', ...],
            'type' => 'AGENT',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListContents

$result = $client->listContents([/* ... */]);
$promise = $client->listContentsAsync([/* ... */]);

Lists the content.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'contentSummaries' => [
        [
            'contentArn' => '<string>',
            'contentId' => '<string>',
            'contentType' => '<string>',
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'metadata' => ['<string>', ...],
            'name' => '<string>',
            'revisionId' => '<string>',
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
            'tags' => ['<string>', ...],
            'title' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ListImportJobs

$result = $client->listImportJobs([/* ... */]);
$promise = $client->listImportJobsAsync([/* ... */]);

Lists information about import jobs.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'importJobSummaries' => [
        [
            'createdTime' => <DateTime>,
            'externalSourceConfiguration' => [
                'configuration' => [
                    'connectConfiguration' => [
                        'instanceId' => '<string>',
                    ],
                ],
                'source' => 'AMAZON_CONNECT',
            ],
            'importJobId' => '<string>',
            'importJobType' => 'QUICK_RESPONSES',
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'metadata' => ['<string>', ...],
            'status' => 'START_IN_PROGRESS|FAILED|COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
            'uploadId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListKnowledgeBases

$result = $client->listKnowledgeBases([/* ... */]);
$promise = $client->listKnowledgeBasesAsync([/* ... */]);

Lists the knowledge bases.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'knowledgeBaseSummaries' => [
        [
            'description' => '<string>',
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'knowledgeBaseType' => 'EXTERNAL|CUSTOM|QUICK_RESPONSES',
            'name' => '<string>',
            'renderingConfiguration' => [
                'templateUri' => '<string>',
            ],
            'serverSideEncryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'sourceConfiguration' => [
                'appIntegrations' => [
                    'appIntegrationArn' => '<string>',
                    'objectFields' => ['<string>', ...],
                ],
            ],
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListQuickResponses

$result = $client->listQuickResponses([/* ... */]);
$promise = $client->listQuickResponsesAsync([/* ... */]);

Lists information about quick response.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'quickResponseSummaries' => [
        [
            'channels' => ['<string>', ...],
            'contentType' => '<string>',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'isActive' => true || false,
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'lastModifiedBy' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'name' => '<string>',
            'quickResponseArn' => '<string>',
            'quickResponseId' => '<string>',
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ListTagsForResource

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

Lists the tags for the specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

NotifyRecommendationsReceived

$result = $client->notifyRecommendationsReceived([/* ... */]);
$promise = $client->notifyRecommendationsReceivedAsync([/* ... */]);

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

Parameter Syntax

$result = $client->notifyRecommendationsReceived([
    'assistantId' => '<string>', // REQUIRED
    'recommendationIds' => ['<string>', ...], // REQUIRED
    'sessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'message' => '<string>',
            'recommendationId' => '<string>',
        ],
        // ...
    ],
    'recommendationIds' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

QueryAssistant

$result = $client->queryAssistant([/* ... */]);
$promise = $client->queryAssistantAsync([/* ... */]);

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'results' => [
        [
            'document' => [
                'contentReference' => [
                    'contentArn' => '<string>',
                    'contentId' => '<string>',
                    'knowledgeBaseArn' => '<string>',
                    'knowledgeBaseId' => '<string>',
                ],
                'excerpt' => [
                    'highlights' => [
                        [
                            'beginOffsetInclusive' => <integer>,
                            'endOffsetExclusive' => <integer>,
                        ],
                        // ...
                    ],
                    'text' => '<string>',
                ],
                'title' => [
                    'highlights' => [
                        [
                            'beginOffsetInclusive' => <integer>,
                            'endOffsetExclusive' => <integer>,
                        ],
                        // ...
                    ],
                    'text' => '<string>',
                ],
            ],
            'relevanceScore' => <float>,
            'resultId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

RequestTimeoutException:

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

RemoveKnowledgeBaseTemplateUri

$result = $client->removeKnowledgeBaseTemplateUri([/* ... */]);
$promise = $client->removeKnowledgeBaseTemplateUriAsync([/* ... */]);

Removes a URI template from a knowledge base.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

SearchContent

$result = $client->searchContent([/* ... */]);
$promise = $client->searchContentAsync([/* ... */]);

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

Parameter Syntax

$result = $client->searchContent([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchExpression' => [ // REQUIRED
        'filters' => [ // REQUIRED
            [
                'field' => 'NAME', // REQUIRED
                'operator' => 'EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'contentSummaries' => [
        [
            'contentArn' => '<string>',
            'contentId' => '<string>',
            'contentType' => '<string>',
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'metadata' => ['<string>', ...],
            'name' => '<string>',
            'revisionId' => '<string>',
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
            'tags' => ['<string>', ...],
            'title' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

SearchQuickResponses

$result = $client->searchQuickResponses([/* ... */]);
$promise = $client->searchQuickResponsesAsync([/* ... */]);

Searches existing Wisdom quick responses in a Wisdom knowledge base.

Parameter Syntax

$result = $client->searchQuickResponses([
    'attributes' => ['<string>', ...],
    'knowledgeBaseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchExpression' => [ // REQUIRED
        'filters' => [
            [
                'includeNoExistence' => true || false,
                'name' => '<string>', // REQUIRED
                'operator' => 'EQUALS|PREFIX', // REQUIRED
                'values' => ['<string>', ...],
            ],
            // ...
        ],
        'orderOnField' => [
            'name' => '<string>', // REQUIRED
            'order' => 'ASC|DESC',
        ],
        'queries' => [
            [
                'allowFuzziness' => true || false,
                'name' => '<string>', // REQUIRED
                'operator' => 'CONTAINS|CONTAINS_AND_PREFIX', // REQUIRED
                'priority' => 'HIGH|MEDIUM|LOW',
                'values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'results' => [
        [
            'attributesInterpolated' => ['<string>', ...],
            'attributesNotInterpolated' => ['<string>', ...],
            'channels' => ['<string>', ...],
            'contentType' => '<string>',
            'contents' => [
                'markdown' => [
                    'content' => '<string>',
                ],
                'plainText' => [
                    'content' => '<string>',
                ],
            ],
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'groupingConfiguration' => [
                'criteria' => '<string>',
                'values' => ['<string>', ...],
            ],
            'isActive' => true || false,
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'language' => '<string>',
            'lastModifiedBy' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'name' => '<string>',
            'quickResponseArn' => '<string>',
            'quickResponseId' => '<string>',
            'shortcutKey' => '<string>',
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

RequestTimeoutException:

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

SearchSessions

$result = $client->searchSessions([/* ... */]);
$promise = $client->searchSessionsAsync([/* ... */]);

Searches for sessions.

Parameter Syntax

$result = $client->searchSessions([
    'assistantId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'searchExpression' => [ // REQUIRED
        'filters' => [ // REQUIRED
            [
                'field' => 'NAME', // REQUIRED
                'operator' => 'EQUALS', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sessionSummaries' => [
        [
            'assistantArn' => '<string>',
            'assistantId' => '<string>',
            'sessionArn' => '<string>',
            'sessionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

StartContentUpload

$result = $client->startContentUpload([/* ... */]);
$promise = $client->startContentUploadAsync([/* ... */]);

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Parameter Syntax

$result = $client->startContentUpload([
    'contentType' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
    'presignedUrlTimeToLive' => <integer>,
]);

Parameter Details

Result Syntax

[
    'headersToInclude' => ['<string>', ...],
    'uploadId' => '<string>',
    'url' => '<string>',
    'urlExpiry' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

StartImportJob

$result = $client->startImportJob([/* ... */]);
$promise = $client->startImportJobAsync([/* ... */]);

Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

• For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

Parameter Syntax

$result = $client->startImportJob([
    'clientToken' => '<string>',
    'externalSourceConfiguration' => [
        'configuration' => [ // REQUIRED
            'connectConfiguration' => [
                'instanceId' => '<string>',
            ],
        ],
        'source' => 'AMAZON_CONNECT', // REQUIRED
    ],
    'importJobType' => 'QUICK_RESPONSES', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
    'metadata' => ['<string>', ...],
    'uploadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'importJob' => [
        'createdTime' => <DateTime>,
        'externalSourceConfiguration' => [
            'configuration' => [
                'connectConfiguration' => [
                    'instanceId' => '<string>',
                ],
            ],
            'source' => 'AMAZON_CONNECT',
        ],
        'failedRecordReport' => '<string>',
        'importJobId' => '<string>',
        'importJobType' => 'QUICK_RESPONSES',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'metadata' => ['<string>', ...],
        'status' => 'START_IN_PROGRESS|FAILED|COMPLETE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'uploadId' => '<string>',
        'url' => '<string>',
        'urlExpiry' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException:

You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

TagResource

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

Adds the specified tags to the specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

TooManyTagsException:

Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.

ResourceNotFoundException:

The specified resource does not exist.

UntagResource

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

Removes the specified tags from the specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

UpdateContent

$result = $client->updateContent([/* ... */]);
$promise = $client->updateContentAsync([/* ... */]);

Updates information about the content.

Parameter Syntax

$result = $client->updateContent([
    'contentId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
    'metadata' => ['<string>', ...],
    'overrideLinkOutUri' => '<string>',
    'removeOverrideLinkOutUri' => true || false,
    'revisionId' => '<string>',
    'title' => '<string>',
    'uploadId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'content' => [
        'contentArn' => '<string>',
        'contentId' => '<string>',
        'contentType' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'linkOutUri' => '<string>',
        'metadata' => ['<string>', ...],
        'name' => '<string>',
        'revisionId' => '<string>',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_FAILED',
        'tags' => ['<string>', ...],
        'title' => '<string>',
        'url' => '<string>',
        'urlExpiry' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

PreconditionFailedException:

The provided revisionId does not match, indicating the content has been modified since it was last read.

ResourceNotFoundException:

The specified resource does not exist.

UpdateKnowledgeBaseTemplateUri

$result = $client->updateKnowledgeBaseTemplateUri([/* ... */]);
$promise = $client->updateKnowledgeBaseTemplateUriAsync([/* ... */]);

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

Parameter Syntax

$result = $client->updateKnowledgeBaseTemplateUri([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'templateUri' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'knowledgeBase' => [
        'description' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseType' => 'EXTERNAL|CUSTOM|QUICK_RESPONSES',
        'lastContentModificationTime' => <DateTime>,
        'name' => '<string>',
        'renderingConfiguration' => [
            'templateUri' => '<string>',
        ],
        'serverSideEncryptionConfiguration' => [
            'kmsKeyId' => '<string>',
        ],
        'sourceConfiguration' => [
            'appIntegrations' => [
                'appIntegrationArn' => '<string>',
                'objectFields' => ['<string>', ...],
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

UpdateQuickResponse

$result = $client->updateQuickResponse([/* ... */]);
$promise = $client->updateQuickResponseAsync([/* ... */]);

Updates an existing Wisdom quick response.

Parameter Syntax

$result = $client->updateQuickResponse([
    'channels' => ['<string>', ...],
    'content' => [
        'content' => '<string>',
    ],
    'contentType' => '<string>',
    'description' => '<string>',
    'groupingConfiguration' => [
        'criteria' => '<string>',
        'values' => ['<string>', ...],
    ],
    'isActive' => true || false,
    'knowledgeBaseId' => '<string>', // REQUIRED
    'language' => '<string>',
    'name' => '<string>',
    'quickResponseId' => '<string>', // REQUIRED
    'removeDescription' => true || false,
    'removeGroupingConfiguration' => true || false,
    'removeShortcutKey' => true || false,
    'shortcutKey' => '<string>',
]);

Parameter Details

Result Syntax

[
    'quickResponse' => [
        'channels' => ['<string>', ...],
        'contentType' => '<string>',
        'contents' => [
            'markdown' => [
                'content' => '<string>',
            ],
            'plainText' => [
                'content' => '<string>',
            ],
        ],
        'createdTime' => <DateTime>,
        'description' => '<string>',
        'groupingConfiguration' => [
            'criteria' => '<string>',
            'values' => ['<string>', ...],
        ],
        'isActive' => true || false,
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'language' => '<string>',
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'name' => '<string>',
        'quickResponseArn' => '<string>',
        'quickResponseId' => '<string>',
        'shortcutKey' => '<string>',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException:

The input fails to satisfy the constraints specified by a service.

AccessDeniedException:

You do not have sufficient access to perform this action.

PreconditionFailedException:

The provided revisionId does not match, indicating the content has been modified since it was last read.

ResourceNotFoundException:

The specified resource does not exist.