ActivateMessageTemplate

$result = $client->activateMessageTemplate([/* ... */]);
$promise = $client->activateMessageTemplateAsync([/* ... */]);

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.

Parameter Syntax

$result = $client->activateMessageTemplate([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'messageTemplateId' => '<string>', // REQUIRED
    'versionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'messageTemplateArn' => '<string>',
    'messageTemplateId' => '<string>',
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateAIAgent

$result = $client->createAIAgent([/* ... */]);
$promise = $client->createAIAgentAsync([/* ... */]);

Creates an Amazon Q in Connect AI Agent.

Parameter Syntax

$result = $client->createAIAgent([
    'assistantId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'configuration' => [ // REQUIRED
        'answerRecommendationAIAgentConfiguration' => [
            'answerGenerationAIGuardrailId' => '<string>',
            'answerGenerationAIPromptId' => '<string>',
            'associationConfigurations' => [
                [
                    'associationConfigurationData' => [
                        'knowledgeBaseAssociationConfigurationData' => [
                            'contentTagFilter' => [
                                'andConditions' => [
                                    [
                                        'key' => '<string>', // REQUIRED
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'orConditions' => [
                                    [
                                        'andConditions' => [
                                            [
                                                'key' => '<string>', // REQUIRED
                                                'value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'tagCondition' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                                'tagCondition' => [
                                    'key' => '<string>', // REQUIRED
                                    'value' => '<string>',
                                ],
                            ],
                            'maxResults' => <integer>,
                            'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                        ],
                    ],
                    'associationId' => '<string>',
                    'associationType' => 'KNOWLEDGE_BASE',
                ],
                // ...
            ],
            'intentLabelingGenerationAIPromptId' => '<string>',
            'queryReformulationAIPromptId' => '<string>',
        ],
        'manualSearchAIAgentConfiguration' => [
            'answerGenerationAIGuardrailId' => '<string>',
            'answerGenerationAIPromptId' => '<string>',
            'associationConfigurations' => [
                [
                    'associationConfigurationData' => [
                        'knowledgeBaseAssociationConfigurationData' => [
                            'contentTagFilter' => [
                                'andConditions' => [
                                    [
                                        'key' => '<string>', // REQUIRED
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'orConditions' => [
                                    [
                                        'andConditions' => [
                                            [
                                                'key' => '<string>', // REQUIRED
                                                'value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'tagCondition' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                                'tagCondition' => [
                                    'key' => '<string>', // REQUIRED
                                    'value' => '<string>',
                                ],
                            ],
                            'maxResults' => <integer>,
                            'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                        ],
                    ],
                    'associationId' => '<string>',
                    'associationType' => 'KNOWLEDGE_BASE',
                ],
                // ...
            ],
        ],
        'selfServiceAIAgentConfiguration' => [
            'associationConfigurations' => [
                [
                    'associationConfigurationData' => [
                        'knowledgeBaseAssociationConfigurationData' => [
                            'contentTagFilter' => [
                                'andConditions' => [
                                    [
                                        'key' => '<string>', // REQUIRED
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'orConditions' => [
                                    [
                                        'andConditions' => [
                                            [
                                                'key' => '<string>', // REQUIRED
                                                'value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'tagCondition' => [
                                            'key' => '<string>', // REQUIRED
                                            'value' => '<string>',
                                        ],
                                    ],
                                    // ...
                                ],
                                'tagCondition' => [
                                    'key' => '<string>', // REQUIRED
                                    'value' => '<string>',
                                ],
                            ],
                            'maxResults' => <integer>,
                            'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                        ],
                    ],
                    'associationId' => '<string>',
                    'associationType' => 'KNOWLEDGE_BASE',
                ],
                // ...
            ],
            'selfServiceAIGuardrailId' => '<string>',
            'selfServiceAnswerGenerationAIPromptId' => '<string>',
            'selfServicePreProcessingAIPromptId' => '<string>',
        ],
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'type' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE', // REQUIRED
    'visibilityStatus' => 'SAVED|PUBLISHED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'aiAgent' => [
        'aiAgentArn' => '<string>',
        'aiAgentId' => '<string>',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'configuration' => [
            'answerRecommendationAIAgentConfiguration' => [
                'answerGenerationAIGuardrailId' => '<string>',
                'answerGenerationAIPromptId' => '<string>',
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
                'intentLabelingGenerationAIPromptId' => '<string>',
                'queryReformulationAIPromptId' => '<string>',
            ],
            'manualSearchAIAgentConfiguration' => [
                'answerGenerationAIGuardrailId' => '<string>',
                'answerGenerationAIPromptId' => '<string>',
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
            ],
            'selfServiceAIAgentConfiguration' => [
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
                'selfServiceAIGuardrailId' => '<string>',
                'selfServiceAnswerGenerationAIPromptId' => '<string>',
                'selfServicePreProcessingAIPromptId' => '<string>',
            ],
        ],
        'description' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'origin' => 'SYSTEM|CUSTOMER',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'type' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE',
        'visibilityStatus' => 'SAVED|PUBLISHED',
    ],
]

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateAIAgentVersion

$result = $client->createAIAgentVersion([/* ... */]);
$promise = $client->createAIAgentVersionAsync([/* ... */]);

Creates and Amazon Q in Connect AI Agent version.

Parameter Syntax

$result = $client->createAIAgentVersion([
    'aiAgentId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'modifiedTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'aiAgent' => [
        'aiAgentArn' => '<string>',
        'aiAgentId' => '<string>',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'configuration' => [
            'answerRecommendationAIAgentConfiguration' => [
                'answerGenerationAIGuardrailId' => '<string>',
                'answerGenerationAIPromptId' => '<string>',
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
                'intentLabelingGenerationAIPromptId' => '<string>',
                'queryReformulationAIPromptId' => '<string>',
            ],
            'manualSearchAIAgentConfiguration' => [
                'answerGenerationAIGuardrailId' => '<string>',
                'answerGenerationAIPromptId' => '<string>',
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
            ],
            'selfServiceAIAgentConfiguration' => [
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
                'selfServiceAIGuardrailId' => '<string>',
                'selfServiceAnswerGenerationAIPromptId' => '<string>',
                'selfServicePreProcessingAIPromptId' => '<string>',
            ],
        ],
        'description' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'origin' => 'SYSTEM|CUSTOMER',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'type' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE',
        'visibilityStatus' => 'SAVED|PUBLISHED',
    ],
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateAIGuardrail

$result = $client->createAIGuardrail([/* ... */]);
$promise = $client->createAIGuardrailAsync([/* ... */]);

Creates an Amazon Q in Connect AI Guardrail.

Parameter Syntax

$result = $client->createAIGuardrail([
    'assistantId' => '<string>', // REQUIRED
    'blockedInputMessaging' => '<string>', // REQUIRED
    'blockedOutputsMessaging' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'contentPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'inputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'outputStrength' => 'NONE|LOW|MEDIUM|HIGH', // REQUIRED
                'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK', // REQUIRED
            ],
            // ...
        ],
    ],
    'contextualGroundingPolicyConfig' => [
        'filtersConfig' => [ // REQUIRED
            [
                'threshold' => <float>, // REQUIRED
                'type' => 'GROUNDING|RELEVANCE', // REQUIRED
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'sensitiveInformationPolicyConfig' => [
        'piiEntitiesConfig' => [
            [
                'action' => 'BLOCK|ANONYMIZE', // REQUIRED
                'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER', // REQUIRED
            ],
            // ...
        ],
        'regexesConfig' => [
            [
                'action' => 'BLOCK|ANONYMIZE', // REQUIRED
                'description' => '<string>',
                'name' => '<string>', // REQUIRED
                'pattern' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'tags' => ['<string>', ...],
    'topicPolicyConfig' => [
        'topicsConfig' => [ // REQUIRED
            [
                'definition' => '<string>', // REQUIRED
                'examples' => ['<string>', ...],
                'name' => '<string>', // REQUIRED
                'type' => 'DENY', // REQUIRED
            ],
            // ...
        ],
    ],
    'visibilityStatus' => 'SAVED|PUBLISHED', // REQUIRED
    'wordPolicyConfig' => [
        'managedWordListsConfig' => [
            [
                'type' => 'PROFANITY', // REQUIRED
            ],
            // ...
        ],
        'wordsConfig' => [
            [
                'text' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'aiGuardrail' => [
        'aiGuardrailArn' => '<string>',
        'aiGuardrailId' => '<string>',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'blockedInputMessaging' => '<string>',
        'blockedOutputsMessaging' => '<string>',
        'contentPolicyConfig' => [
            'filtersConfig' => [
                [
                    'inputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                    'outputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                    'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK',
                ],
                // ...
            ],
        ],
        'contextualGroundingPolicyConfig' => [
            'filtersConfig' => [
                [
                    'threshold' => <float>,
                    'type' => 'GROUNDING|RELEVANCE',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'sensitiveInformationPolicyConfig' => [
            'piiEntitiesConfig' => [
                [
                    'action' => 'BLOCK|ANONYMIZE',
                    'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                ],
                // ...
            ],
            'regexesConfig' => [
                [
                    'action' => 'BLOCK|ANONYMIZE',
                    'description' => '<string>',
                    'name' => '<string>',
                    'pattern' => '<string>',
                ],
                // ...
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'topicPolicyConfig' => [
            'topicsConfig' => [
                [
                    'definition' => '<string>',
                    'examples' => ['<string>', ...],
                    'name' => '<string>',
                    'type' => 'DENY',
                ],
                // ...
            ],
        ],
        'visibilityStatus' => 'SAVED|PUBLISHED',
        'wordPolicyConfig' => [
            'managedWordListsConfig' => [
                [
                    'type' => 'PROFANITY',
                ],
                // ...
            ],
            'wordsConfig' => [
                [
                    'text' => '<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.

ThrottlingException:

The throttling limit has been exceeded.

CreateAIGuardrailVersion

$result = $client->createAIGuardrailVersion([/* ... */]);
$promise = $client->createAIGuardrailVersionAsync([/* ... */]);

Creates an Amazon Q in Connect AI Guardrail version.

Parameter Syntax

$result = $client->createAIGuardrailVersion([
    'aiGuardrailId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'modifiedTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'aiGuardrail' => [
        'aiGuardrailArn' => '<string>',
        'aiGuardrailId' => '<string>',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'blockedInputMessaging' => '<string>',
        'blockedOutputsMessaging' => '<string>',
        'contentPolicyConfig' => [
            'filtersConfig' => [
                [
                    'inputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                    'outputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                    'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK',
                ],
                // ...
            ],
        ],
        'contextualGroundingPolicyConfig' => [
            'filtersConfig' => [
                [
                    'threshold' => <float>,
                    'type' => 'GROUNDING|RELEVANCE',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'sensitiveInformationPolicyConfig' => [
            'piiEntitiesConfig' => [
                [
                    'action' => 'BLOCK|ANONYMIZE',
                    'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                ],
                // ...
            ],
            'regexesConfig' => [
                [
                    'action' => 'BLOCK|ANONYMIZE',
                    'description' => '<string>',
                    'name' => '<string>',
                    'pattern' => '<string>',
                ],
                // ...
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'topicPolicyConfig' => [
            'topicsConfig' => [
                [
                    'definition' => '<string>',
                    'examples' => ['<string>', ...],
                    'name' => '<string>',
                    'type' => 'DENY',
                ],
                // ...
            ],
        ],
        'visibilityStatus' => 'SAVED|PUBLISHED',
        'wordPolicyConfig' => [
            'managedWordListsConfig' => [
                [
                    'type' => 'PROFANITY',
                ],
                // ...
            ],
            'wordsConfig' => [
                [
                    'text' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateAIPrompt

$result = $client->createAIPrompt([/* ... */]);
$promise = $client->createAIPromptAsync([/* ... */]);

Creates an Amazon Q in Connect AI Prompt.

Parameter Syntax

$result = $client->createAIPrompt([
    'apiFormat' => 'ANTHROPIC_CLAUDE_MESSAGES|ANTHROPIC_CLAUDE_TEXT_COMPLETIONS', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'modelId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'templateConfiguration' => [ // REQUIRED
        'textFullAIPromptEditTemplateConfiguration' => [
            'text' => '<string>', // REQUIRED
        ],
    ],
    'templateType' => 'TEXT', // REQUIRED
    'type' => 'ANSWER_GENERATION|INTENT_LABELING_GENERATION|QUERY_REFORMULATION|SELF_SERVICE_PRE_PROCESSING|SELF_SERVICE_ANSWER_GENERATION', // REQUIRED
    'visibilityStatus' => 'SAVED|PUBLISHED', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'aiPrompt' => [
        'aiPromptArn' => '<string>',
        'aiPromptId' => '<string>',
        'apiFormat' => 'ANTHROPIC_CLAUDE_MESSAGES|ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'description' => '<string>',
        'modelId' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'origin' => 'SYSTEM|CUSTOMER',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'templateConfiguration' => [
            'textFullAIPromptEditTemplateConfiguration' => [
                'text' => '<string>',
            ],
        ],
        'templateType' => 'TEXT',
        'type' => 'ANSWER_GENERATION|INTENT_LABELING_GENERATION|QUERY_REFORMULATION|SELF_SERVICE_PRE_PROCESSING|SELF_SERVICE_ANSWER_GENERATION',
        'visibilityStatus' => 'SAVED|PUBLISHED',
    ],
]

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateAIPromptVersion

$result = $client->createAIPromptVersion([/* ... */]);
$promise = $client->createAIPromptVersionAsync([/* ... */]);

Creates an Amazon Q in Connect AI Prompt version.

Parameter Syntax

$result = $client->createAIPromptVersion([
    'aiPromptId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'modifiedTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'aiPrompt' => [
        'aiPromptArn' => '<string>',
        'aiPromptId' => '<string>',
        'apiFormat' => 'ANTHROPIC_CLAUDE_MESSAGES|ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'description' => '<string>',
        'modelId' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'origin' => 'SYSTEM|CUSTOMER',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'templateConfiguration' => [
            'textFullAIPromptEditTemplateConfiguration' => [
                'text' => '<string>',
            ],
        ],
        'templateType' => 'TEXT',
        'type' => 'ANSWER_GENERATION|INTENT_LABELING_GENERATION|QUERY_REFORMULATION|SELF_SERVICE_PRE_PROCESSING|SELF_SERVICE_ANSWER_GENERATION',
        'visibilityStatus' => 'SAVED|PUBLISHED',
    ],
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateAssistant

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

Creates an Amazon Q in Connect 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' => [
        'aiAgentConfiguration' => [
            '<AIAgentType>' => [
                'aiAgentId' => '<string>',
            ],
            // ...
        ],
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'capabilityConfiguration' => [
            'type' => 'V1|V2',
        ],
        '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 Q in Connect 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 Amazon Q in Connect 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.

CreateContentAssociation

$result = $client->createContentAssociation([/* ... */]);
$promise = $client->createContentAssociationAsync([/* ... */]);

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:

• You can create only one content association for each content resource in a knowledge base.

• You can associate a step-by-step guide with multiple content resources.

For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->createContentAssociation([
    'association' => [ // REQUIRED
        'amazonConnectGuideAssociation' => [
            'flowId' => '<string>',
        ],
    ],
    'associationType' => 'AMAZON_CONNECT_GUIDE', // REQUIRED
    'clientToken' => '<string>',
    'contentId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'contentAssociation' => [
        'associationData' => [
            'amazonConnectGuideAssociation' => [
                'flowId' => '<string>',
            ],
        ],
        'associationType' => 'AMAZON_CONNECT_GUIDE',
        'contentArn' => '<string>',
        'contentAssociationArn' => '<string>',
        'contentAssociationId' => '<string>',
        'contentId' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<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.

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.

ThrottlingException:

The throttling limit has been exceeded.

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|MESSAGE_TEMPLATES|MANAGED', // REQUIRED
    'name' => '<string>', // REQUIRED
    'renderingConfiguration' => [
        'templateUri' => '<string>',
    ],
    'serverSideEncryptionConfiguration' => [
        'kmsKeyId' => '<string>',
    ],
    'sourceConfiguration' => [
        'appIntegrations' => [
            'appIntegrationArn' => '<string>', // REQUIRED
            'objectFields' => ['<string>', ...],
        ],
        'managedSourceConfiguration' => [
            'webCrawlerConfiguration' => [
                'crawlerLimits' => [
                    'rateLimit' => <integer>,
                ],
                'exclusionFilters' => ['<string>', ...],
                'inclusionFilters' => ['<string>', ...],
                'scope' => 'HOST_ONLY|SUBDOMAINS',
                'urlConfiguration' => [ // REQUIRED
                    'seedUrls' => [
                        [
                            'url' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
        ],
    ],
    'tags' => ['<string>', ...],
    'vectorIngestionConfiguration' => [
        'chunkingConfiguration' => [
            'chunkingStrategy' => 'FIXED_SIZE|NONE|HIERARCHICAL|SEMANTIC', // REQUIRED
            'fixedSizeChunkingConfiguration' => [
                'maxTokens' => <integer>, // REQUIRED
                'overlapPercentage' => <integer>, // REQUIRED
            ],
            'hierarchicalChunkingConfiguration' => [
                'levelConfigurations' => [ // REQUIRED
                    [
                        'maxTokens' => <integer>, // REQUIRED
                    ],
                    // ...
                ],
                'overlapTokens' => <integer>, // REQUIRED
            ],
            'semanticChunkingConfiguration' => [
                'breakpointPercentileThreshold' => <integer>, // REQUIRED
                'bufferSize' => <integer>, // REQUIRED
                'maxTokens' => <integer>, // REQUIRED
            ],
        ],
        'parsingConfiguration' => [
            'bedrockFoundationModelConfiguration' => [
                'modelArn' => '<string>', // REQUIRED
                'parsingPrompt' => [
                    'parsingPromptText' => '<string>', // REQUIRED
                ],
            ],
            'parsingStrategy' => 'BEDROCK_FOUNDATION_MODEL', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'knowledgeBase' => [
        'description' => '<string>',
        'ingestionFailureReasons' => ['<string>', ...],
        'ingestionStatus' => 'SYNC_FAILED|SYNCING_IN_PROGRESS|SYNC_SUCCESS|CREATE_IN_PROGRESS',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseType' => 'EXTERNAL|CUSTOM|QUICK_RESPONSES|MESSAGE_TEMPLATES|MANAGED',
        'lastContentModificationTime' => <DateTime>,
        'name' => '<string>',
        'renderingConfiguration' => [
            'templateUri' => '<string>',
        ],
        'serverSideEncryptionConfiguration' => [
            'kmsKeyId' => '<string>',
        ],
        'sourceConfiguration' => [
            'appIntegrations' => [
                'appIntegrationArn' => '<string>',
                'objectFields' => ['<string>', ...],
            ],
            'managedSourceConfiguration' => [
                'webCrawlerConfiguration' => [
                    'crawlerLimits' => [
                        'rateLimit' => <integer>,
                    ],
                    'exclusionFilters' => ['<string>', ...],
                    'inclusionFilters' => ['<string>', ...],
                    'scope' => 'HOST_ONLY|SUBDOMAINS',
                    'urlConfiguration' => [
                        'seedUrls' => [
                            [
                                'url' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'vectorIngestionConfiguration' => [
            'chunkingConfiguration' => [
                'chunkingStrategy' => 'FIXED_SIZE|NONE|HIERARCHICAL|SEMANTIC',
                'fixedSizeChunkingConfiguration' => [
                    'maxTokens' => <integer>,
                    'overlapPercentage' => <integer>,
                ],
                'hierarchicalChunkingConfiguration' => [
                    'levelConfigurations' => [
                        [
                            'maxTokens' => <integer>,
                        ],
                        // ...
                    ],
                    'overlapTokens' => <integer>,
                ],
                'semanticChunkingConfiguration' => [
                    'breakpointPercentileThreshold' => <integer>,
                    'bufferSize' => <integer>,
                    'maxTokens' => <integer>,
                ],
            ],
            'parsingConfiguration' => [
                'bedrockFoundationModelConfiguration' => [
                    'modelArn' => '<string>',
                    'parsingPrompt' => [
                        'parsingPromptText' => '<string>',
                    ],
                ],
                'parsingStrategy' => 'BEDROCK_FOUNDATION_MODEL',
            ],
        ],
    ],
]

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.

CreateMessageTemplate

$result = $client->createMessageTemplate([/* ... */]);
$promise = $client->createMessageTemplateAsync([/* ... */]);

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

Parameter Syntax

$result = $client->createMessageTemplate([
    'channelSubtype' => 'EMAIL|SMS', // REQUIRED
    'clientToken' => '<string>',
    'content' => [ // REQUIRED
        'email' => [
            'body' => [
                'html' => [
                    'content' => '<string>',
                ],
                'plainText' => [
                    'content' => '<string>',
                ],
            ],
            'headers' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'subject' => '<string>',
        ],
        'sms' => [
            'body' => [
                'plainText' => [
                    'content' => '<string>',
                ],
            ],
        ],
    ],
    'defaultAttributes' => [
        'agentAttributes' => [
            'firstName' => '<string>',
            'lastName' => '<string>',
        ],
        'customAttributes' => ['<string>', ...],
        'customerProfileAttributes' => [
            'accountNumber' => '<string>',
            'additionalInformation' => '<string>',
            'address1' => '<string>',
            'address2' => '<string>',
            'address3' => '<string>',
            'address4' => '<string>',
            'billingAddress1' => '<string>',
            'billingAddress2' => '<string>',
            'billingAddress3' => '<string>',
            'billingAddress4' => '<string>',
            'billingCity' => '<string>',
            'billingCountry' => '<string>',
            'billingCounty' => '<string>',
            'billingPostalCode' => '<string>',
            'billingProvince' => '<string>',
            'billingState' => '<string>',
            'birthDate' => '<string>',
            'businessEmailAddress' => '<string>',
            'businessName' => '<string>',
            'businessPhoneNumber' => '<string>',
            'city' => '<string>',
            'country' => '<string>',
            'county' => '<string>',
            'custom' => ['<string>', ...],
            'emailAddress' => '<string>',
            'firstName' => '<string>',
            'gender' => '<string>',
            'homePhoneNumber' => '<string>',
            'lastName' => '<string>',
            'mailingAddress1' => '<string>',
            'mailingAddress2' => '<string>',
            'mailingAddress3' => '<string>',
            'mailingAddress4' => '<string>',
            'mailingCity' => '<string>',
            'mailingCountry' => '<string>',
            'mailingCounty' => '<string>',
            'mailingPostalCode' => '<string>',
            'mailingProvince' => '<string>',
            'mailingState' => '<string>',
            'middleName' => '<string>',
            'mobilePhoneNumber' => '<string>',
            'partyType' => '<string>',
            'phoneNumber' => '<string>',
            'postalCode' => '<string>',
            'profileARN' => '<string>',
            'profileId' => '<string>',
            'province' => '<string>',
            'shippingAddress1' => '<string>',
            'shippingAddress2' => '<string>',
            'shippingAddress3' => '<string>',
            'shippingAddress4' => '<string>',
            'shippingCity' => '<string>',
            'shippingCountry' => '<string>',
            'shippingCounty' => '<string>',
            'shippingPostalCode' => '<string>',
            'shippingProvince' => '<string>',
            'shippingState' => '<string>',
            'state' => '<string>',
        ],
        'systemAttributes' => [
            'customerEndpoint' => [
                'address' => '<string>',
            ],
            'name' => '<string>',
            'systemEndpoint' => [
                'address' => '<string>',
            ],
        ],
    ],
    'description' => '<string>',
    'groupingConfiguration' => [
        'criteria' => '<string>',
        'values' => ['<string>', ...],
    ],
    'knowledgeBaseId' => '<string>', // REQUIRED
    'language' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'messageTemplate' => [
        'attributeTypes' => ['<string>', ...],
        'channelSubtype' => 'EMAIL|SMS',
        'content' => [
            'email' => [
                'body' => [
                    'html' => [
                        'content' => '<string>',
                    ],
                    'plainText' => [
                        'content' => '<string>',
                    ],
                ],
                'headers' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'subject' => '<string>',
            ],
            'sms' => [
                'body' => [
                    'plainText' => [
                        'content' => '<string>',
                    ],
                ],
            ],
        ],
        'createdTime' => <DateTime>,
        'defaultAttributes' => [
            'agentAttributes' => [
                'firstName' => '<string>',
                'lastName' => '<string>',
            ],
            'customAttributes' => ['<string>', ...],
            'customerProfileAttributes' => [
                'accountNumber' => '<string>',
                'additionalInformation' => '<string>',
                'address1' => '<string>',
                'address2' => '<string>',
                'address3' => '<string>',
                'address4' => '<string>',
                'billingAddress1' => '<string>',
                'billingAddress2' => '<string>',
                'billingAddress3' => '<string>',
                'billingAddress4' => '<string>',
                'billingCity' => '<string>',
                'billingCountry' => '<string>',
                'billingCounty' => '<string>',
                'billingPostalCode' => '<string>',
                'billingProvince' => '<string>',
                'billingState' => '<string>',
                'birthDate' => '<string>',
                'businessEmailAddress' => '<string>',
                'businessName' => '<string>',
                'businessPhoneNumber' => '<string>',
                'city' => '<string>',
                'country' => '<string>',
                'county' => '<string>',
                'custom' => ['<string>', ...],
                'emailAddress' => '<string>',
                'firstName' => '<string>',
                'gender' => '<string>',
                'homePhoneNumber' => '<string>',
                'lastName' => '<string>',
                'mailingAddress1' => '<string>',
                'mailingAddress2' => '<string>',
                'mailingAddress3' => '<string>',
                'mailingAddress4' => '<string>',
                'mailingCity' => '<string>',
                'mailingCountry' => '<string>',
                'mailingCounty' => '<string>',
                'mailingPostalCode' => '<string>',
                'mailingProvince' => '<string>',
                'mailingState' => '<string>',
                'middleName' => '<string>',
                'mobilePhoneNumber' => '<string>',
                'partyType' => '<string>',
                'phoneNumber' => '<string>',
                'postalCode' => '<string>',
                'profileARN' => '<string>',
                'profileId' => '<string>',
                'province' => '<string>',
                'shippingAddress1' => '<string>',
                'shippingAddress2' => '<string>',
                'shippingAddress3' => '<string>',
                'shippingAddress4' => '<string>',
                'shippingCity' => '<string>',
                'shippingCountry' => '<string>',
                'shippingCounty' => '<string>',
                'shippingPostalCode' => '<string>',
                'shippingProvince' => '<string>',
                'shippingState' => '<string>',
                'state' => '<string>',
            ],
            'systemAttributes' => [
                'customerEndpoint' => [
                    'address' => '<string>',
                ],
                'name' => '<string>',
                'systemEndpoint' => [
                    'address' => '<string>',
                ],
            ],
        ],
        'description' => '<string>',
        'groupingConfiguration' => [
            'criteria' => '<string>',
            'values' => ['<string>', ...],
        ],
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'language' => '<string>',
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'messageTemplateArn' => '<string>',
        'messageTemplateContentSha256' => '<string>',
        'messageTemplateId' => '<string>',
        'name' => '<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.

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateMessageTemplateAttachment

$result = $client->createMessageTemplateAttachment([/* ... */]);
$promise = $client->createMessageTemplateAttachmentAsync([/* ... */]);

Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

Parameter Syntax

$result = $client->createMessageTemplateAttachment([
    'body' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'contentDisposition' => 'ATTACHMENT', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
    'messageTemplateId' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'attachment' => [
        'attachmentId' => '<string>',
        'contentDisposition' => 'ATTACHMENT',
        'name' => '<string>',
        'uploadedTime' => <DateTime>,
        '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.

ThrottlingException:

The throttling limit has been exceeded.

CreateMessageTemplateVersion

$result = $client->createMessageTemplateVersion([/* ... */]);
$promise = $client->createMessageTemplateVersionAsync([/* ... */]);

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'messageTemplate' => [
        'attachments' => [
            [
                'attachmentId' => '<string>',
                'contentDisposition' => 'ATTACHMENT',
                'name' => '<string>',
                'uploadedTime' => <DateTime>,
                'url' => '<string>',
                'urlExpiry' => <DateTime>,
            ],
            // ...
        ],
        'attributeTypes' => ['<string>', ...],
        'channelSubtype' => 'EMAIL|SMS',
        'content' => [
            'email' => [
                'body' => [
                    'html' => [
                        'content' => '<string>',
                    ],
                    'plainText' => [
                        'content' => '<string>',
                    ],
                ],
                'headers' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'subject' => '<string>',
            ],
            'sms' => [
                'body' => [
                    'plainText' => [
                        'content' => '<string>',
                    ],
                ],
            ],
        ],
        'createdTime' => <DateTime>,
        'defaultAttributes' => [
            'agentAttributes' => [
                'firstName' => '<string>',
                'lastName' => '<string>',
            ],
            'customAttributes' => ['<string>', ...],
            'customerProfileAttributes' => [
                'accountNumber' => '<string>',
                'additionalInformation' => '<string>',
                'address1' => '<string>',
                'address2' => '<string>',
                'address3' => '<string>',
                'address4' => '<string>',
                'billingAddress1' => '<string>',
                'billingAddress2' => '<string>',
                'billingAddress3' => '<string>',
                'billingAddress4' => '<string>',
                'billingCity' => '<string>',
                'billingCountry' => '<string>',
                'billingCounty' => '<string>',
                'billingPostalCode' => '<string>',
                'billingProvince' => '<string>',
                'billingState' => '<string>',
                'birthDate' => '<string>',
                'businessEmailAddress' => '<string>',
                'businessName' => '<string>',
                'businessPhoneNumber' => '<string>',
                'city' => '<string>',
                'country' => '<string>',
                'county' => '<string>',
                'custom' => ['<string>', ...],
                'emailAddress' => '<string>',
                'firstName' => '<string>',
                'gender' => '<string>',
                'homePhoneNumber' => '<string>',
                'lastName' => '<string>',
                'mailingAddress1' => '<string>',
                'mailingAddress2' => '<string>',
                'mailingAddress3' => '<string>',
                'mailingAddress4' => '<string>',
                'mailingCity' => '<string>',
                'mailingCountry' => '<string>',
                'mailingCounty' => '<string>',
                'mailingPostalCode' => '<string>',
                'mailingProvince' => '<string>',
                'mailingState' => '<string>',
                'middleName' => '<string>',
                'mobilePhoneNumber' => '<string>',
                'partyType' => '<string>',
                'phoneNumber' => '<string>',
                'postalCode' => '<string>',
                'profileARN' => '<string>',
                'profileId' => '<string>',
                'province' => '<string>',
                'shippingAddress1' => '<string>',
                'shippingAddress2' => '<string>',
                'shippingAddress3' => '<string>',
                'shippingAddress4' => '<string>',
                'shippingCity' => '<string>',
                'shippingCountry' => '<string>',
                'shippingCounty' => '<string>',
                'shippingPostalCode' => '<string>',
                'shippingProvince' => '<string>',
                'shippingState' => '<string>',
                'state' => '<string>',
            ],
            'systemAttributes' => [
                'customerEndpoint' => [
                    'address' => '<string>',
                ],
                'name' => '<string>',
                'systemEndpoint' => [
                    'address' => '<string>',
                ],
            ],
        ],
        'description' => '<string>',
        'groupingConfiguration' => [
            'criteria' => '<string>',
            'values' => ['<string>', ...],
        ],
        'isActive' => true || false,
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'language' => '<string>',
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'messageTemplateArn' => '<string>',
        'messageTemplateContentSha256' => '<string>',
        'messageTemplateId' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'versionNumber' => <integer>,
    ],
]

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.

ThrottlingException:

The throttling limit has been exceeded.

CreateQuickResponse

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

Creates an Amazon Q in Connect 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 Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Parameter Syntax

$result = $client->createSession([
    'aiAgentConfiguration' => [
        '<AIAgentType>' => [
            'aiAgentId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'assistantId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tagFilter' => [
        'andConditions' => [
            [
                'key' => '<string>', // REQUIRED
                'value' => '<string>',
            ],
            // ...
        ],
        'orConditions' => [
            [
                'andConditions' => [
                    [
                        'key' => '<string>', // REQUIRED
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'tagCondition' => [
                    'key' => '<string>', // REQUIRED
                    'value' => '<string>',
                ],
            ],
            // ...
        ],
        'tagCondition' => [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'session' => [
        'aiAgentConfiguration' => [
            '<AIAgentType>' => [
                'aiAgentId' => '<string>',
            ],
            // ...
        ],
        'description' => '<string>',
        'integrationConfiguration' => [
            'topicIntegrationArn' => '<string>',
        ],
        'name' => '<string>',
        'sessionArn' => '<string>',
        'sessionId' => '<string>',
        'tagFilter' => [
            'andConditions' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'orConditions' => [
                [
                    'andConditions' => [
                        [
                            'key' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'tagCondition' => [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                ],
                // ...
            ],
            'tagCondition' => [
                'key' => '<string>',
                'value' => '<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.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

DeactivateMessageTemplate

$result = $client->deactivateMessageTemplate([/* ... */]);
$promise = $client->deactivateMessageTemplateAsync([/* ... */]);

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.

Parameter Syntax

$result = $client->deactivateMessageTemplate([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'messageTemplateId' => '<string>', // REQUIRED
    'versionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'messageTemplateArn' => '<string>',
    'messageTemplateId' => '<string>',
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

DeleteAIAgent

$result = $client->deleteAIAgent([/* ... */]);
$promise = $client->deleteAIAgentAsync([/* ... */]);

Deletes an Amazon Q in Connect AI Agent.

Parameter Syntax

$result = $client->deleteAIAgent([
    'aiAgentId' => '<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.

ThrottlingException:

The throttling limit has been exceeded.

DeleteAIAgentVersion

$result = $client->deleteAIAgentVersion([/* ... */]);
$promise = $client->deleteAIAgentVersionAsync([/* ... */]);

Deletes an Amazon Q in Connect AI Agent Version.

Parameter Syntax

$result = $client->deleteAIAgentVersion([
    'aiAgentId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'versionNumber' => <integer>, // 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.

ThrottlingException:

The throttling limit has been exceeded.

DeleteAIGuardrail

$result = $client->deleteAIGuardrail([/* ... */]);
$promise = $client->deleteAIGuardrailAsync([/* ... */]);

Deletes an Amazon Q in Connect AI Guardrail.

Parameter Syntax

$result = $client->deleteAIGuardrail([
    'aiGuardrailId' => '<string>', // REQUIRED
    'assistantId' => '<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.

ThrottlingException:

The throttling limit has been exceeded.

DeleteAIGuardrailVersion

$result = $client->deleteAIGuardrailVersion([/* ... */]);
$promise = $client->deleteAIGuardrailVersionAsync([/* ... */]);

Delete and Amazon Q in Connect AI Guardrail version.

Parameter Syntax

$result = $client->deleteAIGuardrailVersion([
    'aiGuardrailId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'versionNumber' => <integer>, // 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.

ThrottlingException:

The throttling limit has been exceeded.

DeleteAIPrompt

$result = $client->deleteAIPrompt([/* ... */]);
$promise = $client->deleteAIPromptAsync([/* ... */]);

Deletes an Amazon Q in Connect AI Prompt.

Parameter Syntax

$result = $client->deleteAIPrompt([
    'aiPromptId' => '<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.

ThrottlingException:

The throttling limit has been exceeded.

DeleteAIPromptVersion

$result = $client->deleteAIPromptVersion([/* ... */]);
$promise = $client->deleteAIPromptVersionAsync([/* ... */]);

Delete and Amazon Q in Connect AI Prompt version.

Parameter Syntax

$result = $client->deleteAIPromptVersion([
    'aiPromptId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'versionNumber' => <integer>, // 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.

ThrottlingException:

The throttling limit has been exceeded.

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.

DeleteContentAssociation

$result = $client->deleteContentAssociation([/* ... */]);
$promise = $client->deleteContentAssociationAsync([/* ... */]);

Deletes the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Parameter Syntax

$result = $client->deleteContentAssociation([
    'contentAssociationId' => '<string>', // REQUIRED
    '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.

DeleteMessageTemplate

$result = $client->deleteMessageTemplate([/* ... */]);
$promise = $client->deleteMessageTemplateAsync([/* ... */]);

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

Parameter Syntax

$result = $client->deleteMessageTemplate([
    'knowledgeBaseId' => '<string>', // REQUIRED
    'messageTemplateId' => '<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.

ThrottlingException:

The throttling limit has been exceeded.

DeleteMessageTemplateAttachment

$result = $client->deleteMessageTemplateAttachment([/* ... */]);
$promise = $client->deleteMessageTemplateAttachmentAsync([/* ... */]);

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.

Parameter Syntax

$result = $client->deleteMessageTemplateAttachment([
    'attachmentId' => '<string>', // REQUIRED
    'knowledgeBaseId' => '<string>', // REQUIRED
    'messageTemplateId' => '<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.

ThrottlingException:

The throttling limit has been exceeded.

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.

GetAIAgent

$result = $client->getAIAgent([/* ... */]);
$promise = $client->getAIAgentAsync([/* ... */]);

Gets an Amazon Q in Connect AI Agent.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'aiAgent' => [
        'aiAgentArn' => '<string>',
        'aiAgentId' => '<string>',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'configuration' => [
            'answerRecommendationAIAgentConfiguration' => [
                'answerGenerationAIGuardrailId' => '<string>',
                'answerGenerationAIPromptId' => '<string>',
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
                'intentLabelingGenerationAIPromptId' => '<string>',
                'queryReformulationAIPromptId' => '<string>',
            ],
            'manualSearchAIAgentConfiguration' => [
                'answerGenerationAIGuardrailId' => '<string>',
                'answerGenerationAIPromptId' => '<string>',
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
            ],
            'selfServiceAIAgentConfiguration' => [
                'associationConfigurations' => [
                    [
                        'associationConfigurationData' => [
                            'knowledgeBaseAssociationConfigurationData' => [
                                'contentTagFilter' => [
                                    'andConditions' => [
                                        [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'orConditions' => [
                                        [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        // ...
                                    ],
                                    'tagCondition' => [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                ],
                                'maxResults' => <integer>,
                                'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                            ],
                        ],
                        'associationId' => '<string>',
                        'associationType' => 'KNOWLEDGE_BASE',
                    ],
                    // ...
                ],
                'selfServiceAIGuardrailId' => '<string>',
                'selfServiceAnswerGenerationAIPromptId' => '<string>',
                'selfServicePreProcessingAIPromptId' => '<string>',
            ],
        ],
        'description' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'origin' => 'SYSTEM|CUSTOMER',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'type' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE',
        'visibilityStatus' => 'SAVED|PUBLISHED',
    ],
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

GetAIGuardrail

$result = $client->getAIGuardrail([/* ... */]);
$promise = $client->getAIGuardrailAsync([/* ... */]);

Gets the Amazon Q in Connect AI Guardrail.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'aiGuardrail' => [
        'aiGuardrailArn' => '<string>',
        'aiGuardrailId' => '<string>',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'blockedInputMessaging' => '<string>',
        'blockedOutputsMessaging' => '<string>',
        'contentPolicyConfig' => [
            'filtersConfig' => [
                [
                    'inputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                    'outputStrength' => 'NONE|LOW|MEDIUM|HIGH',
                    'type' => 'SEXUAL|VIOLENCE|HATE|INSULTS|MISCONDUCT|PROMPT_ATTACK',
                ],
                // ...
            ],
        ],
        'contextualGroundingPolicyConfig' => [
            'filtersConfig' => [
                [
                    'threshold' => <float>,
                    'type' => 'GROUNDING|RELEVANCE',
                ],
                // ...
            ],
        ],
        'description' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'sensitiveInformationPolicyConfig' => [
            'piiEntitiesConfig' => [
                [
                    'action' => 'BLOCK|ANONYMIZE',
                    'type' => 'ADDRESS|AGE|AWS_ACCESS_KEY|AWS_SECRET_KEY|CA_HEALTH_NUMBER|CA_SOCIAL_INSURANCE_NUMBER|CREDIT_DEBIT_CARD_CVV|CREDIT_DEBIT_CARD_EXPIRY|CREDIT_DEBIT_CARD_NUMBER|DRIVER_ID|EMAIL|INTERNATIONAL_BANK_ACCOUNT_NUMBER|IP_ADDRESS|LICENSE_PLATE|MAC_ADDRESS|NAME|PASSWORD|PHONE|PIN|SWIFT_CODE|UK_NATIONAL_HEALTH_SERVICE_NUMBER|UK_NATIONAL_INSURANCE_NUMBER|UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER|URL|USERNAME|US_BANK_ACCOUNT_NUMBER|US_BANK_ROUTING_NUMBER|US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER|US_PASSPORT_NUMBER|US_SOCIAL_SECURITY_NUMBER|VEHICLE_IDENTIFICATION_NUMBER',
                ],
                // ...
            ],
            'regexesConfig' => [
                [
                    'action' => 'BLOCK|ANONYMIZE',
                    'description' => '<string>',
                    'name' => '<string>',
                    'pattern' => '<string>',
                ],
                // ...
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'topicPolicyConfig' => [
            'topicsConfig' => [
                [
                    'definition' => '<string>',
                    'examples' => ['<string>', ...],
                    'name' => '<string>',
                    'type' => 'DENY',
                ],
                // ...
            ],
        ],
        'visibilityStatus' => 'SAVED|PUBLISHED',
        'wordPolicyConfig' => [
            'managedWordListsConfig' => [
                [
                    'type' => 'PROFANITY',
                ],
                // ...
            ],
            'wordsConfig' => [
                [
                    'text' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

GetAIPrompt

$result = $client->getAIPrompt([/* ... */]);
$promise = $client->getAIPromptAsync([/* ... */]);

Gets and Amazon Q in Connect AI Prompt.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'aiPrompt' => [
        'aiPromptArn' => '<string>',
        'aiPromptId' => '<string>',
        'apiFormat' => 'ANTHROPIC_CLAUDE_MESSAGES|ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'description' => '<string>',
        'modelId' => '<string>',
        'modifiedTime' => <DateTime>,
        'name' => '<string>',
        'origin' => 'SYSTEM|CUSTOMER',
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'templateConfiguration' => [
            'textFullAIPromptEditTemplateConfiguration' => [
                'text' => '<string>',
            ],
        ],
        'templateType' => 'TEXT',
        'type' => 'ANSWER_GENERATION|INTENT_LABELING_GENERATION|QUERY_REFORMULATION|SELF_SERVICE_PRE_PROCESSING|SELF_SERVICE_ANSWER_GENERATION',
        'visibilityStatus' => 'SAVED|PUBLISHED',
    ],
    'versionNumber' => <integer>,
]

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.

ThrottlingException:

The throttling limit has been exceeded.

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' => [
        'aiAgentConfiguration' => [
            '<AIAgentType>' => [
                'aiAgentId' => '<string>',
            ],
            // ...
        ],
        'assistantArn' => '<string>',
        'assistantId' => '<string>',
        'capabilityConfiguration' => [
            'type' => 'V1|V2',
        ],
        '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.

GetContentAssociation

$result = $client->getContentAssociation([/* ... */]);
$promise = $client->getContentAssociationAsync([/* ... */]);

Returns the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'contentAssociation' => [
        'associationData' => [
            'amazonConnectGuideAssociation' => [
                'flowId' => '<string>',
            ],
        ],
        'associationType' => 'AMAZON_CONNECT_GUIDE',
        'contentArn' => '<string>',
        'contentAssociationArn' => '<string>',
        'contentAssociationId' => '<string>',
        'contentId' => '<string>',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<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.

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>',
        'ingestionFailureReasons' => ['<string>', ...],
        'ingestionStatus' => 'SYNC_FAILED|SYNCING_IN_PROGRESS|SYNC_SUCCESS|CREATE_IN_PROGRESS',
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'knowledgeBaseType' => 'EXTERNAL|CUSTOM|QUICK_RESPONSES|MESSAGE_TEMPLATES|MANAGED',
        'lastContentModificationTime' => <DateTime>,
        'name' => '<string>',
        'renderingConfiguration' => [
            'templateUri' => '<string>',
        ],
        'serverSideEncryptionConfiguration' => [
            'kmsKeyId' => '<string>',
        ],
        'sourceConfiguration' => [
            'appIntegrations' => [
                'appIntegrationArn' => '<string>',
                'objectFields' => ['<string>', ...],
            ],
            'managedSourceConfiguration' => [
                'webCrawlerConfiguration' => [
                    'crawlerLimits' => [
                        'rateLimit' => <integer>,
                    ],
                    'exclusionFilters' => ['<string>', ...],
                    'inclusionFilters' => ['<string>', ...],
                    'scope' => 'HOST_ONLY|SUBDOMAINS',
                    'urlConfiguration' => [
                        'seedUrls' => [
                            [
                                'url' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
        ],
        'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
        'tags' => ['<string>', ...],
        'vectorIngestionConfiguration' => [
            'chunkingConfiguration' => [
                'chunkingStrategy' => 'FIXED_SIZE|NONE|HIERARCHICAL|SEMANTIC',
                'fixedSizeChunkingConfiguration' => [
                    'maxTokens' => <integer>,
                    'overlapPercentage' => <integer>,
                ],
                'hierarchicalChunkingConfiguration' => [
                    'levelConfigurations' => [
                        [
                            'maxTokens' => <integer>,
                        ],
                        // ...
                    ],
                    'overlapTokens' => <integer>,
                ],
                'semanticChunkingConfiguration' => [
                    'breakpointPercentileThreshold' => <integer>,
                    'bufferSize' => <integer>,
                    'maxTokens' => <integer>,
                ],
            ],
            'parsingConfiguration' => [
                'bedrockFoundationModelConfiguration' => [
                    'modelArn' => '<string>',
                    'parsingPrompt' => [
                        'parsingPromptText' => '<string>',
                    ],
                ],
                'parsingStrategy' => 'BEDROCK_FOUNDATION_MODEL',
            ],
        ],
    ],
]

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.

GetMessageTemplate

$result = $client->getMessageTemplate([/* ... */]);
$promise = $client->getMessageTemplateAsync([/* ... */]);

Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'messageTemplate' => [
        'attachments' => [
            [
                'attachmentId' => '<string>',
                'contentDisposition' => 'ATTACHMENT',
                'name' => '<string>',
                'uploadedTime' => <DateTime>,
                'url' => '<string>',
                'urlExpiry' => <DateTime>,
            ],
            // ...
        ],
        'attributeTypes' => ['<string>', ...],
        'channelSubtype' => 'EMAIL|SMS',
        'content' => [
            'email' => [
                'body' => [
                    'html' => [
                        'content' => '<string>',
                    ],
                    'plainText' => [
                        'content' => '<string>',
                    ],
                ],
                'headers' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'subject' => '<string>',
            ],
            'sms' => [
                'body' => [
                    'plainText' => [
                        'content' => '<string>',
                    ],
                ],
            ],
        ],
        'createdTime' => <DateTime>,
        'defaultAttributes' => [
            'agentAttributes' => [
                'firstName' => '<string>',
                'lastName' => '<string>',
            ],
            'customAttributes' => ['<string>', ...],
            'customerProfileAttributes' => [
                'accountNumber' => '<string>',
                'additionalInformation' => '<string>',
                'address1' => '<string>',
                'address2' => '<string>',
                'address3' => '<string>',
                'address4' => '<string>',
                'billingAddress1' => '<string>',
                'billingAddress2' => '<string>',
                'billingAddress3' => '<string>',
                'billingAddress4' => '<string>',
                'billingCity' => '<string>',
                'billingCountry' => '<string>',
                'billingCounty' => '<string>',
                'billingPostalCode' => '<string>',
                'billingProvince' => '<string>',
                'billingState' => '<string>',
                'birthDate' => '<string>',
                'businessEmailAddress' => '<string>',
                'businessName' => '<string>',
                'businessPhoneNumber' => '<string>',
                'city' => '<string>',
                'country' => '<string>',
                'county' => '<string>',
                'custom' => ['<string>', ...],
                'emailAddress' => '<string>',
                'firstName' => '<string>',
                'gender' => '<string>',
                'homePhoneNumber' => '<string>',
                'lastName' => '<string>',
                'mailingAddress1' => '<string>',
                'mailingAddress2' => '<string>',
                'mailingAddress3' => '<string>',
                'mailingAddress4' => '<string>',
                'mailingCity' => '<string>',
                'mailingCountry' => '<string>',
                'mailingCounty' => '<string>',
                'mailingPostalCode' => '<string>',
                'mailingProvince' => '<string>',
                'mailingState' => '<string>',
                'middleName' => '<string>',
                'mobilePhoneNumber' => '<string>',
                'partyType' => '<string>',
                'phoneNumber' => '<string>',
                'postalCode' => '<string>',
                'profileARN' => '<string>',
                'profileId' => '<string>',
                'province' => '<string>',
                'shippingAddress1' => '<string>',
                'shippingAddress2' => '<string>',
                'shippingAddress3' => '<string>',
                'shippingAddress4' => '<string>',
                'shippingCity' => '<string>',
                'shippingCountry' => '<string>',
                'shippingCounty' => '<string>',
                'shippingPostalCode' => '<string>',
                'shippingProvince' => '<string>',
                'shippingState' => '<string>',
                'state' => '<string>',
            ],
            'systemAttributes' => [
                'customerEndpoint' => [
                    'address' => '<string>',
                ],
                'name' => '<string>',
                'systemEndpoint' => [
                    'address' => '<string>',
                ],
            ],
        ],
        'description' => '<string>',
        'groupingConfiguration' => [
            'criteria' => '<string>',
            'values' => ['<string>', ...],
        ],
        'isActive' => true || false,
        'knowledgeBaseArn' => '<string>',
        'knowledgeBaseId' => '<string>',
        'language' => '<string>',
        'lastModifiedBy' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'messageTemplateArn' => '<string>',
        'messageTemplateContentSha256' => '<string>',
        'messageTemplateId' => '<string>',
        'name' => '<string>',
        'tags' => ['<string>', ...],
        'versionNumber' => <integer>,
    ],
]

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.

ThrottlingException:

The throttling limit has been exceeded.

GetNextMessage

$result = $client->getNextMessage([/* ... */]);
$promise = $client->getNextMessageAsync([/* ... */]);

Retrieves next message on an Amazon Q in Connect session.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'conversationSessionData' => [
        [
            'key' => '<string>',
            'value' => [
                'stringValue' => '<string>',
            ],
        ],
        // ...
    ],
    'conversationState' => [
        'reason' => 'SUCCESS|FAILED|REJECTED',
        'status' => 'CLOSED|READY|PROCESSING',
    ],
    'nextMessageToken' => '<string>',
    'requestMessageId' => '<string>',
    'response' => [
        'messageId' => '<string>',
        'participant' => 'CUSTOMER|AGENT|BOT',
        'timestamp' => <DateTime>,
        'value' => [
            'text' => [
                'value' => '<string>',
            ],
        ],
    ],
    'type' => 'TEXT',
]

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([/* ... */]);

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

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' => [
        [
            'data' => [
                'details' => [
                    'contentData' => [
                        'rankingData' => [
                            'relevanceLevel' => 'HIGH|MEDIUM|LOW',
                            'relevanceScore' => <float>,
                        ],
                        'textData' => [
                            'excerpt' => [
                                'highlights' => [
                                    [
                                        'beginOffsetInclusive' => <integer>,
                                        'endOffsetExclusive' => <integer>,
                                    ],
                                    // ...
                                ],
                                'text' => '<string>',
                            ],
                            'title' => [
                                'highlights' => [
                                    [
                                        'beginOffsetInclusive' => <integer>,
                                        'endOffsetExclusive' => <integer>,
                                    ],
                                    // ...
                                ],
                                'text' => '<string>',
                            ],
                        ],
                    ],
                    'generativeData' => [
                        'completion' => '<string>',
                        'rankingData' => [
                            'relevanceLevel' => 'HIGH|MEDIUM|LOW',
                            'relevanceScore' => <float>,
                        ],
                        'references' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                    ],
                    'intentDetectedData' => [
                        'intent' => '<string>',
                        'intentId' => '<string>',
                    ],
                    'sourceContentData' => [
                        'citationSpan' => [
                            'beginOffsetInclusive' => <integer>,
                            'endOffsetExclusive' => <integer>,
                        ],
                        'id' => '<string>',
                        'rankingData' => [
                            'relevanceLevel' => 'HIGH|MEDIUM|LOW',
                            'relevanceScore' => <float>,
                        ],
                        'textData' => [
                            'excerpt' => [
                                'highlights' => [
                                    [
                                        'beginOffsetInclusive' => <integer>,
                                        'endOffsetExclusive' => <integer>,
                                    ],
                                    // ...
                                ],
                                'text' => '<string>',
                            ],
                            'title' => [
                                'highlights' => [
                                    [
                                        'beginOffsetInclusive' => <integer>,
                                        'endOffsetExclusive' => <integer>,
                                    ],
                                    // ...
                                ],
                                'text' => '<string>',
                            ],
                        ],
                        'type' => 'KNOWLEDGE_CONTENT',
                    ],
                ],
                'reference' => [
                    'contentReference' => [
                        'contentArn' => '<string>',
                        'contentId' => '<string>',
                        'knowledgeBaseArn' => '<string>',
                        'knowledgeBaseId' => '<string>',
                        'referenceType' => 'WEB_CRAWLER|KNOWLEDGE_BASE',
                        'sourceURL' => '<string>',
                    ],
                    'generativeReference' => [
                        'generationId' => '<string>',
                        'modelId' => '<string>',
                    ],
                ],
            ],
            'document' => [
                'contentReference' => [
                    'contentArn' => '<string>',
                    'contentId' => '<string>',
                    'knowledgeBaseArn' => '<string>',
                    'knowledgeBaseId' => '<string>',
                    'referenceType' => 'WEB_CRAWLER|KNOWLEDGE_BASE',
                    'sourceURL' => '<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|GENERATIVE_RESPONSE|GENERATIVE_ANSWER|DETECTED_INTENT',
        ],
        // ...
    ],
    'triggers' => [
        [
            'data' => [
                'query' => [
                    'text' => '<string>',
                ],
            ],
            'id' => '<string>',
            'recommendationIds' => ['<string>', ...],
            'source' => 'ISSUE_DETECTION|RULE_EVALUATION|OTHER',
            'type' => 'QUERY|GENERATIVE',
        ],
        // ...
    ],
]

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' => [
        'aiAgentConfiguration' => [
            '<AIAgentType>' => [
                'aiAgentId' => '<string>',
            ],
            // ...
        ],
        'description' => '<string>',
        'integrationConfiguration' => [
            'topicIntegrationArn' => '<string>',
        ],
        'name' => '<string>',
        'sessionArn' => '<string>',
        'sessionId' => '<string>',
        'tagFilter' => [
            'andConditions' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'orConditions' => [
                [
                    'andConditions' => [
                        [
                            'key' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'tagCondition' => [
                        'key' => '<string>',
                        'value' => '<string>',
                    ],
                ],
                // ...
            ],
            'tagCondition' => [
                'key' => '<string>',
                'value' => '<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.

ListAIAgentVersions

$result = $client->listAIAgentVersions([/* ... */]);
$promise = $client->listAIAgentVersionsAsync([/* ... */]);

List AI Agent versions.

Parameter Syntax

$result = $client->listAIAgentVersions([
    'aiAgentId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'origin' => 'SYSTEM|CUSTOMER',
]);

Parameter Details

Result Syntax

[
    'aiAgentVersionSummaries' => [
        [
            'aiAgentSummary' => [
                'aiAgentArn' => '<string>',
                'aiAgentId' => '<string>',
                'assistantArn' => '<string>',
                'assistantId' => '<string>',
                'configuration' => [
                    'answerRecommendationAIAgentConfiguration' => [
                        'answerGenerationAIGuardrailId' => '<string>',
                        'answerGenerationAIPromptId' => '<string>',
                        'associationConfigurations' => [
                            [
                                'associationConfigurationData' => [
                                    'knowledgeBaseAssociationConfigurationData' => [
                                        'contentTagFilter' => [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'orConditions' => [
                                                [
                                                    'andConditions' => [
                                                        [
                                                            'key' => '<string>',
                                                            'value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                    'tagCondition' => [
                                                        'key' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        'maxResults' => <integer>,
                                        'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                                    ],
                                ],
                                'associationId' => '<string>',
                                'associationType' => 'KNOWLEDGE_BASE',
                            ],
                            // ...
                        ],
                        'intentLabelingGenerationAIPromptId' => '<string>',
                        'queryReformulationAIPromptId' => '<string>',
                    ],
                    'manualSearchAIAgentConfiguration' => [
                        'answerGenerationAIGuardrailId' => '<string>',
                        'answerGenerationAIPromptId' => '<string>',
                        'associationConfigurations' => [
                            [
                                'associationConfigurationData' => [
                                    'knowledgeBaseAssociationConfigurationData' => [
                                        'contentTagFilter' => [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'orConditions' => [
                                                [
                                                    'andConditions' => [
                                                        [
                                                            'key' => '<string>',
                                                            'value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                    'tagCondition' => [
                                                        'key' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        'maxResults' => <integer>,
                                        'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                                    ],
                                ],
                                'associationId' => '<string>',
                                'associationType' => 'KNOWLEDGE_BASE',
                            ],
                            // ...
                        ],
                    ],
                    'selfServiceAIAgentConfiguration' => [
                        'associationConfigurations' => [
                            [
                                'associationConfigurationData' => [
                                    'knowledgeBaseAssociationConfigurationData' => [
                                        'contentTagFilter' => [
                                            'andConditions' => [
                                                [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'orConditions' => [
                                                [
                                                    'andConditions' => [
                                                        [
                                                            'key' => '<string>',
                                                            'value' => '<string>',
                                                        ],
                                                        // ...
                                                    ],
                                                    'tagCondition' => [
                                                        'key' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                ],
                                                // ...
                                            ],
                                            'tagCondition' => [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                        ],
                                        'maxResults' => <integer>,
                                        'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                                    ],
                                ],
                                'associationId' => '<string>',
                                'associationType' => 'KNOWLEDGE_BASE',
                            ],
                            // ...
                        ],
                        'selfServiceAIGuardrailId' => '<string>',
                        'selfServiceAnswerGenerationAIPromptId' => '<string>',
                        'selfServicePreProcessingAIPromptId' => '<string>',
                    ],
                ],
                'description' => '<string>',
                'modifiedTime' => <DateTime>,
                'name' => '<string>',
                'origin' => 'SYSTEM|CUSTOMER',
                'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
                'tags' => ['<string>', ...],
                'type' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE',
                'visibilityStatus' => 'SAVED|PUBLISHED',
            ],
            'versionNumber' => <integer>,
        ],
        // ...
    ],
    '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.

ThrottlingException:

The throttling limit has been exceeded.

ListAIAgents

$result = $client->listAIAgents([/* ... */]);
$promise = $client->listAIAgentsAsync([/* ... */]);

Lists AI Agents.

Parameter Syntax

$result = $client->listAIAgents([
    'assistantId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'origin' => 'SYSTEM|CUSTOMER',
]);

Parameter Details

Result Syntax

[
    'aiAgentSummaries' => [
        [
            'aiAgentArn' => '<string>',
            'aiAgentId' => '<string>',
            'assistantArn' => '<string>',
            'assistantId' => '<string>',
            'configuration' => [
                'answerRecommendationAIAgentConfiguration' => [
                    'answerGenerationAIGuardrailId' => '<string>',
                    'answerGenerationAIPromptId' => '<string>',
                    'associationConfigurations' => [
                        [
                            'associationConfigurationData' => [
                                'knowledgeBaseAssociationConfigurationData' => [
                                    'contentTagFilter' => [
                                        'andConditions' => [
                                            [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'orConditions' => [
                                            [
                                                'andConditions' => [
                                                    [
                                                        'key' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'tagCondition' => [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                            ],
                                            // ...
                                        ],
                                        'tagCondition' => [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                    ],
                                    'maxResults' => <integer>,
                                    'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                                ],
                            ],
                            'associationId' => '<string>',
                            'associationType' => 'KNOWLEDGE_BASE',
                        ],
                        // ...
                    ],
                    'intentLabelingGenerationAIPromptId' => '<string>',
                    'queryReformulationAIPromptId' => '<string>',
                ],
                'manualSearchAIAgentConfiguration' => [
                    'answerGenerationAIGuardrailId' => '<string>',
                    'answerGenerationAIPromptId' => '<string>',
                    'associationConfigurations' => [
                        [
                            'associationConfigurationData' => [
                                'knowledgeBaseAssociationConfigurationData' => [
                                    'contentTagFilter' => [
                                        'andConditions' => [
                                            [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'orConditions' => [
                                            [
                                                'andConditions' => [
                                                    [
                                                        'key' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'tagCondition' => [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                            ],
                                            // ...
                                        ],
                                        'tagCondition' => [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                    ],
                                    'maxResults' => <integer>,
                                    'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                                ],
                            ],
                            'associationId' => '<string>',
                            'associationType' => 'KNOWLEDGE_BASE',
                        ],
                        // ...
                    ],
                ],
                'selfServiceAIAgentConfiguration' => [
                    'associationConfigurations' => [
                        [
                            'associationConfigurationData' => [
                                'knowledgeBaseAssociationConfigurationData' => [
                                    'contentTagFilter' => [
                                        'andConditions' => [
                                            [
                                                'key' => '<string>',
                                                'value' => '<string>',
                                            ],
                                            // ...
                                        ],
                                        'orConditions' => [
                                            [
                                                'andConditions' => [
                                                    [
                                                        'key' => '<string>',
                                                        'value' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                                'tagCondition' => [
                                                    'key' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                            ],
                                            // ...
                                        ],
                                        'tagCondition' => [
                                            'key' => '<string>',
                                            'value' => '<string>',
                                        ],
                                    ],
                                    'maxResults' => <integer>,
                                    'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC',
                                ],
                            ],
                            'associationId' => '<string>',
                            'associationType' => 'KNOWLEDGE_BASE',
                        ],
                        // ...
                    ],
                    'selfServiceAIGuardrailId' => '<string>',
                    'selfServiceAnswerGenerationAIPromptId' => '<string>',
                    'selfServicePreProcessingAIPromptId' => '<string>',
                ],
            ],
            'description' => '<string>',
            'modifiedTime' => <DateTime>,
            'name' => '<string>',
            'origin' => 'SYSTEM|CUSTOMER',
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
            'tags' => ['<string>', ...],
            'type' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE',
            'visibilityStatus' => 'SAVED|PUBLISHED',
        ],
        // ...
    ],
    '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.

ThrottlingException:

The throttling limit has been exceeded.

ListAIGuardrailVersions

$result = $client->listAIGuardrailVersions([/* ... */]);
$promise = $client->listAIGuardrailVersionsAsync([/* ... */]);

Lists AI Guardrail versions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'aiGuardrailVersionSummaries' => [
        [
            'aiGuardrailSummary' => [
                'aiGuardrailArn' => '<string>',
                'aiGuardrailId' => '<string>',
                'assistantArn' => '<string>',
                'assistantId' => '<string>',
                'description' => '<string>',
                'modifiedTime' => <DateTime>,
                'name' => '<string>',
                'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
                'tags' => ['<string>', ...],
                'visibilityStatus' => 'SAVED|PUBLISHED',
            ],
            'versionNumber' => <integer>,
        ],
        // ...
    ],
    '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.

ThrottlingException:

The throttling limit has been exceeded.

ListAIGuardrails

$result = $client->listAIGuardrails([/* ... */]);
$promise = $client->listAIGuardrailsAsync([/* ... */]);

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'aiGuardrailSummaries' => [
        [
            'aiGuardrailArn' => '<string>',
            'aiGuardrailId' => '<string>',
            'assistantArn' => '<string>',
            'assistantId' => '<string>',
            'description' => '<string>',
            'modifiedTime' => <DateTime>,
            'name' => '<string>',
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
            'tags' => ['<string>', ...],
            'visibilityStatus' => 'SAVED|PUBLISHED',
        ],
        // ...
    ],
    '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.

ThrottlingException:

The throttling limit has been exceeded.

ListAIPromptVersions

$result = $client->listAIPromptVersions([/* ... */]);
$promise = $client->listAIPromptVersionsAsync([/* ... */]);

Lists AI Prompt versions.

Parameter Syntax

$result = $client->listAIPromptVersions([
    'aiPromptId' => '<string>', // REQUIRED
    'assistantId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'origin' => 'SYSTEM|CUSTOMER',
]);

Parameter Details

Result Syntax

[
    'aiPromptVersionSummaries' => [
        [
            'aiPromptSummary' => [
                'aiPromptArn' => '<string>',
                'aiPromptId' => '<string>',
                'apiFormat' => 'ANTHROPIC_CLAUDE_MESSAGES|ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
                'assistantArn' => '<string>',
                'assistantId' => '<string>',
                'description' => '<string>',
                'modelId' => '<string>',
                'modifiedTime' => <DateTime>,
                'name' => '<string>',
                'origin' => 'SYSTEM|CUSTOMER',
                'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
                'tags' => ['<string>', ...],
                'templateType' => 'TEXT',
                'type' => 'ANSWER_GENERATION|INTENT_LABELING_GENERATION|QUERY_REFORMULATION|SELF_SERVICE_PRE_PROCESSING|SELF_SERVICE_ANSWER_GENERATION',
                'visibilityStatus' => 'SAVED|PUBLISHED',
            ],
            'versionNumber' => <integer>,
        ],
        // ...
    ],
    '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.

ThrottlingException:

The throttling limit has been exceeded.

ListAIPrompts

$result = $client->listAIPrompts([/* ... */]);
$promise = $client->listAIPromptsAsync([/* ... */]);

Lists the AI Prompts available on the Amazon Q in Connect assistant.

Parameter Syntax

$result = $client->listAIPrompts([
    'assistantId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'origin' => 'SYSTEM|CUSTOMER',
]);

Parameter Details

Result Syntax

[
    'aiPromptSummaries' => [
        [
            'aiPromptArn' => '<string>',
            'aiPromptId' => '<string>',
            'apiFormat' => 'ANTHROPIC_CLAUDE_MESSAGES|ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
            'assistantArn' => '<string>',
            'assistantId' => '<string>',
            'description' => '<string>',
            'modelId' => '<string>',
            'modifiedTime' => <DateTime>,
            'name' => '<string>',
            'origin' => 'SYSTEM|CUSTOMER',
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
            'tags' => ['<string>', ...],
            'templateType' => 'TEXT',
            'type' => 'ANSWER_GENERATION|INTENT_LABELING_GENERATION|QUERY_REFORMULATION|SELF_SERVICE_PRE_PROCESSING|SELF_SERVICE_ANSWER_GENERATION',
            'visibilityStatus' => 'SAVED|PUBLISHED',
        ],
        // ...
    ],
    '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.

ThrottlingException:

The throttling limit has been exceeded.

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' => [
        [
            'aiAgentConfiguration' => [
                '<AIAgentType>' => [
                    'aiAgentId' => '<string>',
                ],
                // ...
            ],
            'assistantArn' => '<string>',
            'assistantId' => '<string>',
            'capabilityConfiguration' => [
                'type' => 'V1|V2',
            ],
            '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.

ListContentAssociations

$result = $client->listContentAssociations([/* ... */]);
$promise = $client->listContentAssociationsAsync([/* ... */]);

Lists the content associations.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'contentAssociationSummaries' => [
        [
            'associationData' => [
                'amazonConnectGuideAssociation' => [
                    'flowId' => '<string>',
                ],
            ],
            'associationType' => 'AMAZON_CONNECT_GUIDE',
            'contentArn' => '<string>',
            'contentAssociationArn' => '<string>',
            'contentAssociationId' => '<string>',
            'contentId' => '<string>',
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            '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.

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|MESSAGE_TEMPLATES|MANAGED',
            'name' => '<string>',
            'renderingConfiguration' => [
                'templateUri' => '<string>',
            ],
            'serverSideEncryptionConfiguration' => [
                'kmsKeyId' => '<string>',
            ],
            'sourceConfiguration' => [
                'appIntegrations' => [
                    'appIntegrationArn' => '<string>',
                    'objectFields' => ['<string>', ...],
                ],
                'managedSourceConfiguration' => [
                    'webCrawlerConfiguration' => [
                        'crawlerLimits' => [
                            'rateLimit' => <integer>,
                        ],
                        'exclusionFilters' => ['<string>', ...],
                        'inclusionFilters' => ['<string>', ...],
                        'scope' => 'HOST_ONLY|SUBDOMAINS',
                        'urlConfiguration' => [
                            'seedUrls' => [
                                [
                                    'url' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                ],
            ],
            'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED',
            'tags' => ['<string>', ...],
            'vectorIngestionConfiguration' => [
                'chunkingConfiguration' => [
                    'chunkingStrategy' => 'FIXED_SIZE|NONE|HIERARCHICAL|SEMANTIC',
                    'fixedSizeChunkingConfiguration' => [
                        'maxTokens' => <integer>,
                        'overlapPercentage' => <integer>,
                    ],
                    'hierarchicalChunkingConfiguration' => [
                        'levelConfigurations' => [
                            [
                                'maxTokens' => <integer>,
                            ],
                            // ...
                        ],
                        'overlapTokens' => <integer>,
                    ],
                    'semanticChunkingConfiguration' => [
                        'breakpointPercentileThreshold' => <integer>,
                        'bufferSize' => <integer>,
                        'maxTokens' => <integer>,
                    ],
                ],
                'parsingConfiguration' => [
                    'bedrockFoundationModelConfiguration' => [
                        'modelArn' => '<string>',
                        'parsingPrompt' => [
                            'parsingPromptText' => '<string>',
                        ],
                    ],
                    'parsingStrategy' => 'BEDROCK_FOUNDATION_MODEL',
                ],
            ],
        ],
        // ...
    ],
    '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.

ListMessageTemplateVersions

$result = $client->listMessageTemplateVersions([/* ... */]);
$promise = $client->listMessageTemplateVersionsAsync([/* ... */]);

Lists all the available versions for the specified Amazon Q in Connect message template.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'messageTemplateVersionSummaries' => [
        [
            'channelSubtype' => 'EMAIL|SMS',
            'isActive' => true || false,
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'messageTemplateArn' => '<string>',
            'messageTemplateId' => '<string>',
            'name' => '<string>',
            'versionNumber' => <integer>,
        ],
        // ...
    ],
    '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.

ThrottlingException:

The throttling limit has been exceeded.

ListMessageTemplates

$result = $client->listMessageTemplates([/* ... */]);
$promise = $client->listMessageTemplatesAsync([/* ... */]);

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'messageTemplateSummaries' => [
        [
            'activeVersionNumber' => <integer>,
            'channelSubtype' => 'EMAIL|SMS',
            'createdTime' => <DateTime>,
            'description' => '<string>',
            'knowledgeBaseArn' => '<string>',
            'knowledgeBaseId' => '<string>',
            'lastModifiedBy' => '<string>',
            'lastModifiedTime' => <DateTime>,
            'messageTemplateArn' => '<string>',
            'messageTemplateId' => '<string>',
            'name' => '<string>',
            '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.

ThrottlingException:

The throttling limit has been exceeded.

ListMessages

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

Lists messages on an Amazon Q in Connect session.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'messages' => [
        [
            'messageId' => '<string>',
            'participant' => 'CUSTOMER|AGENT|BOT',
            'timestamp' => <DateTime>,
            'value' => [
                'text' => [
                    'value' => '<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.

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.