Amazon Q Connect 2020-10-19
- Client: Aws\QConnect\QConnectClient
- Service ID: qconnect
- Version: 2020-10-19
This page describes the parameters and results for the operations of the Amazon Q Connect (2020-10-19), and shows how to use the Aws\QConnect\QConnectClient object to call the described operations. This documentation is specific to the 2020-10-19 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- ActivateMessageTemplate ( array $params = [] )
- Activates a specific version of the Amazon Q in Connect message template.
- CreateAIAgent ( array $params = [] )
- Creates an Amazon Q in Connect AI Agent.
- CreateAIAgentVersion ( array $params = [] )
- Creates and Amazon Q in Connect AI Agent version.
- CreateAIGuardrail ( array $params = [] )
- Creates an Amazon Q in Connect AI Guardrail.
- CreateAIGuardrailVersion ( array $params = [] )
- Creates an Amazon Q in Connect AI Guardrail version.
- CreateAIPrompt ( array $params = [] )
- Creates an Amazon Q in Connect AI Prompt.
- CreateAIPromptVersion ( array $params = [] )
- Creates an Amazon Q in Connect AI Prompt version.
- CreateAssistant ( array $params = [] )
- Creates an Amazon Q in Connect assistant.
- CreateAssistantAssociation ( array $params = [] )
- Creates an association between an Amazon Q in Connect assistant and another resource.
- CreateContent ( array $params = [] )
- Creates Amazon Q in Connect content.
- CreateContentAssociation ( array $params = [] )
- Creates an association between a content resource in a knowledge base and step-by-step guides.
- CreateKnowledgeBase ( array $params = [] )
- Creates a knowledge base.
- CreateMessageTemplate ( array $params = [] )
- Creates an Amazon Q in Connect message template.
- CreateMessageTemplateAttachment ( array $params = [] )
- Uploads an attachment file to the specified Amazon Q in Connect message template.
- CreateMessageTemplateVersion ( array $params = [] )
- Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template.
- CreateQuickResponse ( array $params = [] )
- Creates an Amazon Q in Connect quick response.
- CreateSession ( array $params = [] )
- Creates a session.
- DeactivateMessageTemplate ( array $params = [] )
- Deactivates a specific version of the Amazon Q in Connect message template .
- DeleteAIAgent ( array $params = [] )
- Deletes an Amazon Q in Connect AI Agent.
- DeleteAIAgentVersion ( array $params = [] )
- Deletes an Amazon Q in Connect AI Agent Version.
- DeleteAIGuardrail ( array $params = [] )
- Deletes an Amazon Q in Connect AI Guardrail.
- DeleteAIGuardrailVersion ( array $params = [] )
- Delete and Amazon Q in Connect AI Guardrail version.
- DeleteAIPrompt ( array $params = [] )
- Deletes an Amazon Q in Connect AI Prompt.
- DeleteAIPromptVersion ( array $params = [] )
- Delete and Amazon Q in Connect AI Prompt version.
- DeleteAssistant ( array $params = [] )
- Deletes an assistant.
- DeleteAssistantAssociation ( array $params = [] )
- Deletes an assistant association.
- DeleteContent ( array $params = [] )
- Deletes the content.
- DeleteContentAssociation ( array $params = [] )
- Deletes the content association.
- DeleteImportJob ( array $params = [] )
- Deletes the quick response import job.
- DeleteKnowledgeBase ( array $params = [] )
- Deletes the knowledge base.
- DeleteMessageTemplate ( array $params = [] )
- Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request.
- DeleteMessageTemplateAttachment ( array $params = [] )
- Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier.
- DeleteQuickResponse ( array $params = [] )
- Deletes a quick response.
- GetAIAgent ( array $params = [] )
- Gets an Amazon Q in Connect AI Agent.
- GetAIGuardrail ( array $params = [] )
- Gets the Amazon Q in Connect AI Guardrail.
- GetAIPrompt ( array $params = [] )
- Gets and Amazon Q in Connect AI Prompt.
- GetAssistant ( array $params = [] )
- Retrieves information about an assistant.
- GetAssistantAssociation ( array $params = [] )
- Retrieves information about an assistant association.
- GetContent ( array $params = [] )
- Retrieves content, including a pre-signed URL to download the content.
- GetContentAssociation ( array $params = [] )
- Returns the content association.
- GetContentSummary ( array $params = [] )
- Retrieves summary information about the content.
- GetImportJob ( array $params = [] )
- Retrieves the started import job.
- GetKnowledgeBase ( array $params = [] )
- Retrieves information about the knowledge base.
- GetMessageTemplate ( array $params = [] )
- Retrieves the Amazon Q in Connect message template.
- GetNextMessage ( array $params = [] )
- Retrieves next message on an Amazon Q in Connect session.
- GetQuickResponse ( array $params = [] )
- Retrieves the quick response.
- GetRecommendations ( array $params = [] )
- This API will be discontinued starting June 1, 2024.
- GetSession ( array $params = [] )
- Retrieves information for a specified session.
- ListAIAgentVersions ( array $params = [] )
- List AI Agent versions.
- ListAIAgents ( array $params = [] )
- Lists AI Agents.
- ListAIGuardrailVersions ( array $params = [] )
- Lists AI Guardrail versions.
- ListAIGuardrails ( array $params = [] )
- Lists the AI Guardrails available on the Amazon Q in Connect assistant.
- ListAIPromptVersions ( array $params = [] )
- Lists AI Prompt versions.
- ListAIPrompts ( array $params = [] )
- Lists the AI Prompts available on the Amazon Q in Connect assistant.
- ListAssistantAssociations ( array $params = [] )
- Lists information about assistant associations.
- ListAssistants ( array $params = [] )
- Lists information about assistants.
- ListContentAssociations ( array $params = [] )
- Lists the content associations.
- ListContents ( array $params = [] )
- Lists the content.
- ListImportJobs ( array $params = [] )
- Lists information about import jobs.
- ListKnowledgeBases ( array $params = [] )
- Lists the knowledge bases.
- ListMessageTemplateVersions ( array $params = [] )
- Lists all the available versions for the specified Amazon Q in Connect message template.
- ListMessageTemplates ( array $params = [] )
- Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
- ListMessages ( array $params = [] )
- Lists messages on an Amazon Q in Connect session.
- ListQuickResponses ( array $params = [] )
- Lists information about quick response.
- ListTagsForResource ( array $params = [] )
- Lists the tags for the specified resource.
- NotifyRecommendationsReceived ( array $params = [] )
- Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
- PutFeedback ( array $params = [] )
- Provides feedback against the specified assistant for the specified target.
- QueryAssistant ( array $params = [] )
- This API will be discontinued starting June 1, 2024.
- RemoveAssistantAIAgent ( array $params = [] )
- Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
- RemoveKnowledgeBaseTemplateUri ( array $params = [] )
- Removes a URI template from a knowledge base.
- RenderMessageTemplate ( array $params = [] )
- Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content.
- SearchContent ( array $params = [] )
- Searches for content in a specified knowledge base.
- SearchMessageTemplates ( array $params = [] )
- Searches for Amazon Q in Connect message templates in the specified knowledge base.
- SearchQuickResponses ( array $params = [] )
- Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
- SearchSessions ( array $params = [] )
- Searches for sessions.
- SendMessage ( array $params = [] )
- Submits a message to the Amazon Q in Connect session.
- StartContentUpload ( array $params = [] )
- Get a URL to upload content to a knowledge base.
- StartImportJob ( array $params = [] )
- Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.
- TagResource ( array $params = [] )
- Adds the specified tags to the specified resource.
- UntagResource ( array $params = [] )
- Removes the specified tags from the specified resource.
- UpdateAIAgent ( array $params = [] )
- Updates an AI Agent.
- UpdateAIGuardrail ( array $params = [] )
- Updates an AI Guardrail.
- UpdateAIPrompt ( array $params = [] )
- Updates an AI Prompt.
- UpdateAssistantAIAgent ( array $params = [] )
- Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
- UpdateContent ( array $params = [] )
- Updates information about the content.
- UpdateKnowledgeBaseTemplateUri ( array $params = [] )
- Updates the template URI of a knowledge base.
- UpdateMessageTemplate ( array $params = [] )
- Updates the Amazon Q in Connect message template.
- UpdateMessageTemplateMetadata ( array $params = [] )
- Updates the Amazon Q in Connect message template metadata.
- UpdateQuickResponse ( array $params = [] )
- Updates an existing Amazon Q in Connect quick response.
- UpdateSession ( array $params = [] )
- Updates a session.
- UpdateSessionData ( array $params = [] )
- Updates the data stored on an Amazon Q in Connect Session.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListAIAgentVersions
- ListAIAgents
- ListAIGuardrailVersions
- ListAIGuardrails
- ListAIPromptVersions
- ListAIPrompts
- ListAssistantAssociations
- ListAssistants
- ListContentAssociations
- ListContents
- ListImportJobs
- ListKnowledgeBases
- ListMessageTemplateVersions
- ListMessageTemplates
- ListMessages
- ListQuickResponses
- QueryAssistant
- SearchContent
- SearchMessageTemplates
- SearchQuickResponses
- SearchSessions
Operations
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
- versionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the message template version to activate.
Result Syntax
[ 'messageTemplateArn' => '<string>', 'messageTemplateId' => '<string>', 'versionNumber' => <integer>, ]
Result Details
Members
- messageTemplateArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the message template.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template.
- versionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the message template version that is activated.
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 asCreateAssistant
) 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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- configuration
-
- Required: Yes
- Type: AIAgentConfiguration structure
The configuration of the AI Agent.
- description
-
- Type: string
The description of the AI Agent.
- name
-
- Required: Yes
- Type: string
The name of the AI Agent.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of the AI Agent.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Agent.
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
Members
- aiAgent
-
- Type: AIAgentData structure
The data of the created AI Agent.
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 asCreateAssistant
) 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
Members
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Agent.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.
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
Members
- aiAgent
-
- Type: AIAgentData structure
The data of the AI Agent version.
- versionNumber
-
- Type: long (int|float)
The version number of the AI Agent version.
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 asCreateAssistant
) 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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- blockedInputMessaging
-
- Required: Yes
- Type: string
The message to return when the AI Guardrail blocks a prompt.
- blockedOutputsMessaging
-
- Required: Yes
- Type: string
The message to return when the AI Guardrail blocks a model response.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- contentPolicyConfig
-
- Type: AIGuardrailContentPolicyConfig structure
The content filter policies to configure for the AI Guardrail.
- contextualGroundingPolicyConfig
-
- Type: AIGuardrailContextualGroundingPolicyConfig structure
The contextual grounding policy configuration used to create an AI Guardrail.
- description
-
- Type: string
A description of the AI Guardrail.
- name
-
- Required: Yes
- Type: string
The name of the AI Guardrail.
- sensitiveInformationPolicyConfig
-
- Type: AIGuardrailSensitiveInformationPolicyConfig structure
The sensitive information policy to configure for the AI Guardrail.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- topicPolicyConfig
-
- Type: AIGuardrailTopicPolicyConfig structure
The topic policies to configure for the AI Guardrail.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Guardrail.
- wordPolicyConfig
-
- Type: AIGuardrailWordPolicyConfig structure
The word policy you configure for the AI Guardrail.
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
Members
- aiGuardrail
-
- Type: AIGuardrailData structure
The data of the AI Guardrail.
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 asCreateAssistant
) 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
Members
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Guardrail was last modified.
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
Members
- aiGuardrail
-
- Type: AIGuardrailData structure
The data of the AI Guardrail version.
- versionNumber
-
- Type: long (int|float)
The version number of the AI Guardrail version.
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 asCreateAssistant
) 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
Members
- apiFormat
-
- Required: Yes
- Type: string
The API Format of the AI Prompt.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- description
-
- Type: string
The description of the AI Prompt.
- modelId
-
- Required: Yes
- Type: string
The identifier of the model used for this AI Prompt. Model Ids supported are:
CLAUDE_3_HAIKU_20240307_V1
- name
-
- Required: Yes
- Type: string
The name of the AI Prompt.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- templateConfiguration
-
- Required: Yes
- Type: AIPromptTemplateConfiguration structure
The configuration of the prompt template for this AI Prompt.
- templateType
-
- Required: Yes
- Type: string
The type of the prompt template for this AI Prompt.
- type
-
- Required: Yes
- Type: string
The type of this AI Prompt.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Prompt.
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
Members
- aiPrompt
-
- Type: AIPromptData structure
The data of the AI Prompt.
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 asCreateAssistant
) 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
Members
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI prompt.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Prompt was last modified.
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
Members
- aiPrompt
-
- Type: AIPromptData structure
The data of the AI Prompt version.
- versionNumber
-
- Type: long (int|float)
The version number of the AI Prompt version.
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 asCreateAssistant
) 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
Members
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- description
-
- Type: string
The description of the assistant.
- name
-
- Required: Yes
- Type: string
The name of the assistant.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The configuration information for the customer managed key used for encryption.
The customer managed key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,kms:Decrypt
, andkms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of assistant.
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
Members
- assistant
-
- Type: AssistantData structure
Information about the assistant.
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 asCreateAssistant
) 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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- association
-
- Required: Yes
- Type: AssistantAssociationInputData structure
The identifier of the associated resource.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[ 'assistantAssociation' => [ 'assistantArn' => '<string>', 'assistantAssociationArn' => '<string>', 'assistantAssociationId' => '<string>', 'assistantId' => '<string>', 'associationData' => [ 'knowledgeBaseAssociation' => [ 'knowledgeBaseArn' => '<string>', 'knowledgeBaseId' => '<string>', ], ], 'associationType' => 'KNOWLEDGE_BASE', 'tags' => ['<string>', ...], ], ]
Result Details
Members
- assistantAssociation
-
- Type: AssistantAssociationData structure
The assistant association.
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 asCreateAssistant
) 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
Members
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- metadata
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
- name
-
- Required: Yes
- Type: string
The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
- overrideLinkOutUri
-
- Type: string
The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- title
-
- Type: string
The title of the content. If not set, the title is equal to the name.
- uploadId
-
- Required: Yes
- Type: string
A pointer to the uploaded asset. This value is returned by StartContentUpload.
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
Members
- content
-
- Type: ContentData structure
The content.
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 asCreateAssistant
) 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
Members
- association
-
- Required: Yes
- Type: ContentAssociationContents structure
The identifier of the associated resource.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
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
Members
- contentAssociation
-
- Type: ContentAssociationData structure
The association between Amazon Q in Connect content and another resource.
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 asCreateAssistant
) 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.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException
error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
-
Call DeleteKnowledgeBase.
-
Call DeleteDataIntegration.
-
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
-
Call CreateKnowledgeBase.
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
Members
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- description
-
- Type: string
The description.
- knowledgeBaseType
-
- Required: Yes
- Type: string
The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- renderingConfiguration
-
- Type: RenderingConfiguration structure
Information about how to render the content.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,kms:Decrypt
, andkms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
- sourceConfiguration
-
- Type: SourceConfiguration structure
The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- vectorIngestionConfiguration
-
- Type: VectorIngestionConfiguration structure
Contains details about how to ingest the documents in a data source.
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
Members
- knowledgeBase
-
- Type: KnowledgeBaseData structure
The knowledge base.
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 asCreateAssistant
) 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
Members
- channelSubtype
-
- Required: Yes
- Type: string
The channel subtype this message template applies to.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- content
-
- Required: Yes
- Type: MessageTemplateContentProvider structure
The content of the message template.
- defaultAttributes
-
- Type: MessageTemplateAttributes structure
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
- description
-
- Type: string
The description of the message template.
- groupingConfiguration
-
- Type: GroupingConfiguration structure
The configuration information of the grouping of Amazon Q in Connect users.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- language
-
- Type: string
The language code value for the language in which the quick response is written. The supported language codes include
de_DE
,en_US
,es_ES
,fr_FR
,id_ID
,it_IT
,ja_JP
,ko_KR
,pt_BR
,zh_CN
,zh_TW
- name
-
- Required: Yes
- Type: string
The name of the message template.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
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
Members
- messageTemplate
-
- Type: MessageTemplateData structure
The message template.
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 asCreateAssistant
) 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
Members
- body
-
- Required: Yes
- Type: string
The body of the attachment file being uploaded. It should be encoded using base64 encoding.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- contentDisposition
-
- Required: Yes
- Type: string
The presentation information for the attachment file.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
- name
-
- Required: Yes
- Type: string
The name of the attachment file being uploaded. The name should include the file extension.
Result Syntax
[ 'attachment' => [ 'attachmentId' => '<string>', 'contentDisposition' => 'ATTACHMENT', 'name' => '<string>', 'uploadedTime' => <DateTime>, 'url' => '<string>', 'urlExpiry' => <DateTime>, ], ]
Result Details
Members
- attachment
-
- Type: MessageTemplateAttachment structure
The message template attachment.
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 asCreateAssistant
) 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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateContentSha256
-
- Type: string
The checksum value of the message template content that is referenced by the
$LATEST
qualifier. It can be returned inMessageTemplateData
orExtendedMessageTemplateData
. It’s calculated by content, language,defaultAttributes
andAttachments
of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the$LATEST
qualifier by default. - messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
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
Members
- messageTemplate
-
- Type: ExtendedMessageTemplateData structure
The message template.
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 asCreateAssistant
) 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
Members
- channels
-
- Type: Array of strings
The Amazon Connect channels this quick response applies to.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- content
-
- Required: Yes
- Type: QuickResponseDataProvider structure
The content of the quick response.
- contentType
-
- Type: string
The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for a quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for a quick response written in richtext.
- description
-
- Type: string
The description of the quick response.
- groupingConfiguration
-
- Type: GroupingConfiguration structure
The configuration information of the user groups that the quick response is accessible to.
- isActive
-
- Type: boolean
Whether the quick response is active.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- language
-
- Type: string
The language code value for the language in which the quick response is written. The supported language codes include
de_DE
,en_US
,es_ES
,fr_FR
,id_ID
,it_IT
,ja_JP
,ko_KR
,pt_BR
,zh_CN
,zh_TW
- name
-
- Required: Yes
- Type: string
The name of the quick response.
- shortcutKey
-
- Type: string
The shortcut key of the quick response. The value should be unique across the knowledge base.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
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
Members
- quickResponse
-
- Type: QuickResponseData structure
The quick response.
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 asCreateAssistant
) 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
Members
- aiAgentConfiguration
-
- Type: Associative array of custom strings keys (AIAgentType) to AIAgentConfigurationData structures
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- description
-
- Type: string
The description.
- name
-
- Required: Yes
- Type: string
The name of the session.
- tagFilter
-
- Type: TagFilter structure
An object that can be used to specify Tag conditions.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
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
Members
- session
-
- Type: SessionData structure
The session.
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 asCreateAssistant
) 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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
- versionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the message template version to deactivate.
Result Syntax
[ 'messageTemplateArn' => '<string>', 'messageTemplateId' => '<string>', 'versionNumber' => <integer>, ]
Result Details
Members
- messageTemplateArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the message template.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template.
- versionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the message template version that has been deactivated.
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 asCreateAssistant
) 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
Members
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- versionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the AI Agent version.
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 asCreateAssistant
) 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
Members
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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 asCreateAssistant
) 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
Members
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- versionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the AI Guardrail version to be deleted.
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 asCreateAssistant
) 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
Members
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI prompt.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- versionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the AI Prompt version to be deleted.
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 asCreateAssistant
) 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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- contentAssociationId
-
- Required: Yes
- Type: string
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
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
Members
- importJobId
-
- Required: Yes
- Type: string
The identifier of the import job to be deleted.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
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 asCreateAssistant
) 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.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
Parameter Syntax
$result = $client->deleteKnowledgeBase([ 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
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 asCreateAssistant
) 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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN.
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 asCreateAssistant
) 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
Members
- attachmentId
-
- Required: Yes
- Type: string
The identifier of the attachment file.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
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 asCreateAssistant
) 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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The knowledge base from which the quick response is deleted. The identifier of the knowledge base.
- quickResponseId
-
- Required: Yes
- Type: string
The identifier of the quick response to delete.
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
Members
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- aiAgent
-
- Type: AIAgentData structure
The data of the AI Agent.
- versionNumber
-
- Type: long (int|float)
The version number of the AI Agent version (returned if an AI Agent version was specified via use of a qualifier for the
aiAgentId
on the request).
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
Members
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- aiGuardrail
-
- Type: AIGuardrailData structure
The data of the AI Guardrail.
- versionNumber
-
- Type: long (int|float)
The version number of the AI Guardrail version (returned if an AI Guardrail version was specified via use of a qualifier for the
aiGuardrailId
on the request).
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
Members
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI prompt.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- aiPrompt
-
- Type: AIPromptData structure
The data of the AI Prompt.
- versionNumber
-
- Type: long (int|float)
The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the
aiPromptId
on the request).
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- assistant
-
- Type: AssistantData structure
Information about the assistant.
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
Members
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[ 'assistantAssociation' => [ 'assistantArn' => '<string>', 'assistantAssociationArn' => '<string>', 'assistantAssociationId' => '<string>', 'assistantId' => '<string>', 'associationData' => [ 'knowledgeBaseAssociation' => [ 'knowledgeBaseArn' => '<string>', 'knowledgeBaseId' => '<string>', ], ], 'associationType' => 'KNOWLEDGE_BASE', 'tags' => ['<string>', ...], ], ]
Result Details
Members
- assistantAssociation
-
- Type: AssistantAssociationData structure
The assistant association.
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
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- content
-
- Type: ContentData structure
The content.
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
Members
- contentAssociationId
-
- Required: Yes
- Type: string
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
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
Members
- contentAssociation
-
- Type: ContentAssociationData structure
The association between Amazon Q in Connect content and another resource.
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
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- contentSummary
-
- Type: ContentSummary structure
The content summary.
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
Members
- importJobId
-
- Required: Yes
- Type: string
The identifier of the import job to retrieve.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base that the import job belongs to.
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
Members
- importJob
-
- Type: ImportJobData structure
The import job.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- knowledgeBase
-
- Type: KnowledgeBaseData structure
The knowledge base.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN.
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
Members
- messageTemplate
-
- Type: ExtendedMessageTemplateData structure
The message template.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- nextMessageToken
-
- Required: Yes
- Type: string
The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect session.
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
Members
- conversationSessionData
-
- Type: Array of RuntimeSessionData structures
The conversation data stored on an Amazon Q in Connect Session.
- conversationState
-
- Required: Yes
- Type: ConversationState structure
The state of current conversation.
- nextMessageToken
-
- Type: string
The token for the next message.
- requestMessageId
-
- Required: Yes
- Type: string
The identifier of the submitted message.
- response
-
- Required: Yes
- Type: MessageOutput structure
The message response to the requested message.
- type
-
- Required: Yes
- Type: string
The type of message response.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.
- quickResponseId
-
- Required: Yes
- Type: string
The identifier of the quick response.
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
Members
- quickResponse
-
- Type: QuickResponseData structure
The quick response.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
- waitTimeSeconds
-
- Type: int
The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than
WaitTimeSeconds
. If no messages are available and the wait time expires, the call returns successfully with an empty list.
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
Members
- recommendations
-
- Required: Yes
- Type: Array of RecommendationData structures
The recommendations.
- triggers
-
- Type: Array of RecommendationTrigger structures
The triggers corresponding to recommendations.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
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
Members
- session
-
- Type: SessionData structure
The session.
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
Members
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- origin
-
- Type: string
The origin of the AI Agent versions to be listed.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs.
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
Members
- aiAgentVersionSummaries
-
- Required: Yes
- Type: Array of AIAgentVersionSummary structures
The summaries of AI Agent versions.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- origin
-
- Type: string
The origin of the AI Agents to be listed.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs.
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
Members
- aiAgentSummaries
-
- Required: Yes
- Type: Array of AIAgentSummary structures
The summaries of AI Agents.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- aiGuardrailVersionSummaries
-
- Required: Yes
- Type: Array of AIGuardrailVersionSummary structures
The summaries of the AI Guardrail versions.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- aiGuardrailSummaries
-
- Required: Yes
- Type: Array of AIGuardrailSummary structures
The summaries of the AI Guardrails.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- origin
-
- Type: string
The origin of the AI Prompt versions to be listed.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs.
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
Members
- aiPromptVersionSummaries
-
- Required: Yes
- Type: Array of AIPromptVersionSummary structures
The summaries of the AI Prompt versions.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- origin
-
- Type: string
The origin of the AI Prompts to be listed.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs.
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
Members
- aiPromptSummaries
-
- Required: Yes
- Type: Array of AIPromptSummary structures
The summaries of the AI Prompts.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- assistantAssociationSummaries
-
- Required: Yes
- Type: Array of AssistantAssociationSummary structures
Summary information about assistant associations.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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
Members
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- assistantSummaries
-
- Required: Yes
- Type: Array of AssistantSummary structures
Information about the assistants.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- contentAssociationSummaries
-
- Required: Yes
- Type: Array of ContentAssociationSummary structures
Summary information about content associations.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- contentSummaries
-
- Required: Yes
- Type: Array of ContentSummary structures
Information about the content.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- importJobSummaries
-
- Required: Yes
- Type: Array of ImportJobSummary structures
Summary information about the import jobs.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- knowledgeBaseSummaries
-
- Required: Yes
- Type: Array of KnowledgeBaseSummary structures
Information about the knowledge bases.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- messageTemplateVersionSummaries
-
- Required: Yes
- Type: Array of MessageTemplateVersionSummary structures
Summary information about the versions of a message template.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- messageTemplateSummaries
-
- Required: Yes
- Type: Array of MessageTemplateSummary structures
Summary information about the message template.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect session.
Result Syntax
[ 'messages' => [ [ 'messageId' => '<string>', 'participant' => 'CUSTOMER|AGENT|BOT', 'timestamp' => <DateTime>, 'value' => [ 'text' => [ 'value' => '<string>', ], ], ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- messages
-
- Required: Yes
- Type: Array of MessageOutput structures
The message information.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
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
Members
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- quickResponseSummaries
-
- Required: Yes
- Type: Array of QuickResponseSummary structures
Summary information about the quick responses.
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
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
Result Syntax
[ 'tags' => ['<string>', ...], ]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
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
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- recommendationIds
-
- Required: Yes
- Type: Array of strings
The identifiers of the recommendations.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[ 'errors' => [ [ 'message' => '<string>', 'recommendationId' => '<string>', ], // ... ], 'recommendationIds' => ['<string>', ...], ]
Result Details
Members
- errors
-
- Type: Array of NotifyRecommendationsReceivedError structures
The identifiers of recommendations that are causing errors.
- recommendationIds
-
- Type: Array of strings
The identifiers of the recommendations.
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.
PutFeedback
$result = $client->putFeedback
([/* ... */]); $promise = $client->putFeedbackAsync
([/* ... */]);
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
Parameter Syntax
$result = $client->putFeedback([ 'assistantId' => '<string>', // REQUIRED 'contentFeedback' => [ // REQUIRED 'generativeContentFeedbackData' => [ 'relevance' => 'HELPFUL|NOT_HELPFUL', // REQUIRED ], ], 'targetId' => '<string>', // REQUIRED 'targetType' => 'RECOMMENDATION|RESULT', // REQUIRED ]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- contentFeedback
-
- Required: Yes
- Type: ContentFeedbackData structure
Information about the feedback provided.
- targetId
-
- Required: Yes
- Type: string
The identifier of the feedback target.
- targetType
-
- Required: Yes
- Type: string
The type of the feedback target.
Result Syntax
[ 'assistantArn' => '<string>', 'assistantId' => '<string>', 'contentFeedback' => [ 'generativeContentFeedbackData' => [ 'relevance' => 'HELPFUL|NOT_HELPFUL', ], ], 'targetId' => '<string>', 'targetType' => 'RECOMMENDATION|RESULT', ]
Result Details
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- contentFeedback
-
- Required: Yes
- Type: ContentFeedbackData structure
Information about the feedback provided.
- targetId
-
- Required: Yes
- Type: string
The identifier of the feedback target.
- targetType
-
- Required: Yes
- Type: string
The type of the feedback target.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by a service.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The specified resource does not exist.
QueryAssistant
$result = $client->queryAssistant
([/* ... */]); $promise = $client->queryAssistantAsync
([/* ... */]);
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.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
Parameter Syntax
$result = $client->queryAssistant([ 'assistantId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'overrideKnowledgeBaseSearchType' => 'HYBRID|SEMANTIC', 'queryCondition' => [ [ 'single' => [ 'comparator' => 'EQUALS', // REQUIRED 'field' => 'RESULT_TYPE', // REQUIRED 'value' => '<string>', // REQUIRED ], ], // ... ], 'queryInputData' => [ 'intentInputData' => [ 'intentId' => '<string>', // REQUIRED ], 'queryTextInputData' => [ 'text' => '<string>', // REQUIRED ], ], 'queryText' => '<string>', 'sessionId' => '<string>', ]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- overrideKnowledgeBaseSearchType
-
- Type: string
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text. - queryCondition
-
- Type: Array of QueryCondition structures
Information about how to query content.
- queryInputData
-
- Type: QueryInputData structure
Information about the query.
- queryText
-
- Type: string
The text to search for.
- sessionId
-
- Type: string
The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[ 'nextToken' => '<string>', 'results' => [ [ '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>', ], ], 'relevanceScore' => <float>, 'resultId' => '<string>', 'type' => 'KNOWLEDGE_CONTENT|INTENT_ANSWER|GENERATIVE_ANSWER', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- results
-
- Required: Yes
- Type: Array of ResultData structures
The results of the query.
Errors
- RequestTimeoutException:
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException:
The input fails to satisfy the constraints specified by a service.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The specified resource does not exist.
RemoveAssistantAIAgent
$result = $client->removeAssistantAIAgent
([/* ... */]); $promise = $client->removeAssistantAIAgentAsync
([/* ... */]);
Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
Parameter Syntax
$result = $client->removeAssistantAIAgent([ 'aiAgentType' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE', // REQUIRED 'assistantId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- aiAgentType
-
- Required: Yes
- Type: string
The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
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.
RemoveKnowledgeBaseTemplateUri
$result = $client->removeKnowledgeBaseTemplateUri
([/* ... */]); $promise = $client->removeKnowledgeBaseTemplateUriAsync
([/* ... */]);
Removes a URI template from a knowledge base.
Parameter Syntax
$result = $client->removeKnowledgeBaseTemplateUri([ 'knowledgeBaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
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.
RenderMessageTemplate
$result = $client->renderMessageTemplate
([/* ... */]); $promise = $client->renderMessageTemplateAsync
([/* ... */]);
Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
Parameter Syntax
$result = $client->renderMessageTemplate([ 'attributes' => [ // REQUIRED '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>', ], ], ], 'knowledgeBaseId' => '<string>', // REQUIRED 'messageTemplateId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- attributes
-
- Required: Yes
- Type: MessageTemplateAttributes structure
An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN.
Result Syntax
[ 'attachments' => [ [ 'attachmentId' => '<string>', 'contentDisposition' => 'ATTACHMENT', 'name' => '<string>', 'uploadedTime' => <DateTime>, 'url' => '<string>', 'urlExpiry' => <DateTime>, ], // ... ], 'attributesNotInterpolated' => ['<string>', ...], 'content' => [ 'email' => [ 'body' => [ 'html' => [ 'content' => '<string>', ], 'plainText' => [ 'content' => '<string>', ], ], 'headers' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'subject' => '<string>', ], 'sms' => [ 'body' => [ 'plainText' => [ 'content' => '<string>', ], ], ], ], ]
Result Details
Members
- attachments
-
- Type: Array of MessageTemplateAttachment structures
The message template attachments.
- attributesNotInterpolated
-
- Type: Array of strings
The attribute keys that are not resolved.
- content
-
- Required: Yes
- Type: MessageTemplateContentProvider structure
The content of the message template.
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.
SearchContent
$result = $client->searchContent
([/* ... */]); $promise = $client->searchContentAsync
([/* ... */]);
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
Parameter Syntax
$result = $client->searchContent([ 'knowledgeBaseId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'searchExpression' => [ // REQUIRED 'filters' => [ // REQUIRED [ 'field' => 'NAME', // REQUIRED 'operator' => 'EQUALS', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ], ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- searchExpression
-
- Required: Yes
- Type: SearchExpression structure
The search expression to filter results.
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
Members
- contentSummaries
-
- Required: Yes
- Type: Array of ContentSummary structures
Summary information about the content.
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
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.
SearchMessageTemplates
$result = $client->searchMessageTemplates
([/* ... */]); $promise = $client->searchMessageTemplatesAsync
([/* ... */]);
Searches for Amazon Q in Connect message templates in the specified knowledge base.
Parameter Syntax
$result = $client->searchMessageTemplates([ 'knowledgeBaseId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'searchExpression' => [ // REQUIRED 'filters' => [ [ 'includeNoExistence' => true || false, 'name' => '<string>', // REQUIRED 'operator' => 'EQUALS|PREFIX', // REQUIRED 'values' => ['<string>', ...], ], // ... ], 'orderOnField' => [ 'name' => '<string>', // REQUIRED 'order' => 'ASC|DESC', ], 'queries' => [ [ 'allowFuzziness' => true || false, 'name' => '<string>', // REQUIRED 'operator' => 'CONTAINS|CONTAINS_AND_PREFIX', // REQUIRED 'priority' => 'HIGH|MEDIUM|LOW', 'values' => ['<string>', ...], // REQUIRED ], // ... ], ], ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- searchExpression
-
- Required: Yes
- Type: MessageTemplateSearchExpression structure
The search expression for querying the message template.
Result Syntax
[ 'nextToken' => '<string>', 'results' => [ [ 'channelSubtype' => 'EMAIL|SMS', 'createdTime' => <DateTime>, 'description' => '<string>', 'groupingConfiguration' => [ 'criteria' => '<string>', 'values' => ['<string>', ...], ], 'isActive' => true || false, 'knowledgeBaseArn' => '<string>', 'knowledgeBaseId' => '<string>', 'language' => '<string>', 'lastModifiedBy' => '<string>', 'lastModifiedTime' => <DateTime>, 'messageTemplateArn' => '<string>', 'messageTemplateId' => '<string>', 'name' => '<string>', 'tags' => ['<string>', ...], 'versionNumber' => <integer>, ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- results
-
- Required: Yes
- Type: Array of MessageTemplateSearchResultData structures
The results of the message template search.
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.
SearchQuickResponses
$result = $client->searchQuickResponses
([/* ... */]); $promise = $client->searchQuickResponsesAsync
([/* ... */]);
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
Parameter Syntax
$result = $client->searchQuickResponses([ 'attributes' => ['<string>', ...], 'knowledgeBaseId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'searchExpression' => [ // REQUIRED 'filters' => [ [ 'includeNoExistence' => true || false, 'name' => '<string>', // REQUIRED 'operator' => 'EQUALS|PREFIX', // REQUIRED 'values' => ['<string>', ...], ], // ... ], 'orderOnField' => [ 'name' => '<string>', // REQUIRED 'order' => 'ASC|DESC', ], 'queries' => [ [ 'allowFuzziness' => true || false, 'name' => '<string>', // REQUIRED 'operator' => 'CONTAINS|CONTAINS_AND_PREFIX', // REQUIRED 'priority' => 'HIGH|MEDIUM|LOW', 'values' => ['<string>', ...], // REQUIRED ], // ... ], ], ]);
Parameter Details
Members
- attributes
-
- Type: Associative array of custom strings keys (ContactAttributeKey) to strings
The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- searchExpression
-
- Required: Yes
- Type: QuickResponseSearchExpression structure
The search expression for querying the quick response.
Result Syntax
[ 'nextToken' => '<string>', 'results' => [ [ 'attributesInterpolated' => ['<string>', ...], 'attributesNotInterpolated' => ['<string>', ...], 'channels' => ['<string>', ...], 'contentType' => '<string>', 'contents' => [ 'markdown' => [ 'content' => '<string>', ], 'plainText' => [ 'content' => '<string>', ], ], 'createdTime' => <DateTime>, 'description' => '<string>', 'groupingConfiguration' => [ 'criteria' => '<string>', 'values' => ['<string>', ...], ], 'isActive' => true || false, 'knowledgeBaseArn' => '<string>', 'knowledgeBaseId' => '<string>', 'language' => '<string>', 'lastModifiedBy' => '<string>', 'lastModifiedTime' => <DateTime>, 'name' => '<string>', 'quickResponseArn' => '<string>', 'quickResponseId' => '<string>', 'shortcutKey' => '<string>', 'status' => 'CREATE_IN_PROGRESS|CREATE_FAILED|CREATED|DELETE_IN_PROGRESS|DELETE_FAILED|DELETED|UPDATE_IN_PROGRESS|UPDATE_FAILED', 'tags' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- results
-
- Required: Yes
- Type: Array of QuickResponseSearchResultData structures
The results of the quick response search.
Errors
- RequestTimeoutException:
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException:
The input fails to satisfy the constraints specified by a service.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The specified resource does not exist.
SearchSessions
$result = $client->searchSessions
([/* ... */]); $promise = $client->searchSessionsAsync
([/* ... */]);
Searches for sessions.
Parameter Syntax
$result = $client->searchSessions([ 'assistantId' => '<string>', // REQUIRED 'maxResults' => <integer>, 'nextToken' => '<string>', 'searchExpression' => [ // REQUIRED 'filters' => [ // REQUIRED [ 'field' => 'NAME', // REQUIRED 'operator' => 'EQUALS', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ], ]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- nextToken
-
- Type: string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
- searchExpression
-
- Required: Yes
- Type: SearchExpression structure
The search expression to filter results.
Result Syntax
[ 'nextToken' => '<string>', 'sessionSummaries' => [ [ 'assistantArn' => '<string>', 'assistantId' => '<string>', 'sessionArn' => '<string>', 'sessionId' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- sessionSummaries
-
- Required: Yes
- Type: Array of SessionSummary structures
Summary information about the sessions.
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.
SendMessage
$result = $client->sendMessage
([/* ... */]); $promise = $client->sendMessageAsync
([/* ... */]);
Submits a message to the Amazon Q in Connect session.
Parameter Syntax
$result = $client->sendMessage([ 'assistantId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'conversationContext' => [ 'selfServiceConversationHistory' => [ // REQUIRED [ 'botResponse' => '<string>', 'inputTranscript' => '<string>', 'turnNumber' => <integer>, // REQUIRED ], // ... ], ], 'message' => [ // REQUIRED 'value' => [ // REQUIRED 'text' => [ 'value' => '<string>', ], ], ], 'sessionId' => '<string>', // REQUIRED 'type' => 'TEXT', // REQUIRED ]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.
- conversationContext
-
- Type: ConversationContext structure
The conversation context before the Amazon Q in Connect session.
- message
-
- Required: Yes
- Type: MessageInput structure
The message data to submit to the Amazon Q in Connect session.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect session.
- type
-
- Required: Yes
- Type: string
The message type.
Result Syntax
[ 'nextMessageToken' => '<string>', 'requestMessageId' => '<string>', ]
Result Details
Members
- nextMessageToken
-
- Required: Yes
- Type: string
The token for the next message, used by GetNextMessage.
- requestMessageId
-
- Required: Yes
- Type: string
The identifier of the submitted message.
Errors
- RequestTimeoutException:
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- 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 asCreateAssistant
) 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.
StartContentUpload
$result = $client->startContentUpload
([/* ... */]); $promise = $client->startContentUploadAsync
([/* ... */]);
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
Parameter Syntax
$result = $client->startContentUpload([ 'contentType' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED 'presignedUrlTimeToLive' => <integer>, ]);
Parameter Details
Members
- contentType
-
- Required: Yes
- Type: string
The type of content to upload.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- presignedUrlTimeToLive
-
- Type: int
The expected expiration time of the generated presigned URL, specified in minutes.
Result Syntax
[ 'headersToInclude' => ['<string>', ...], 'uploadId' => '<string>', 'url' => '<string>', 'urlExpiry' => <DateTime>, ]
Result Details
Members
- headersToInclude
-
- Required: Yes
- Type: Associative array of custom strings keys (NonEmptyString) to strings
The headers to include in the upload.
- uploadId
-
- Required: Yes
- Type: string
The identifier of the upload.
- url
-
- Required: Yes
- Type: string
The URL of the upload.
- urlExpiry
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration time of the URL as an epoch timestamp.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by a service.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The specified resource does not exist.
StartImportJob
$result = $client->startImportJob
([/* ... */]); $promise = $client->startImportJobAsync
([/* ... */]);
Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
-
For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
Parameter Syntax
$result = $client->startImportJob([ 'clientToken' => '<string>', 'externalSourceConfiguration' => [ 'configuration' => [ // REQUIRED 'connectConfiguration' => [ 'instanceId' => '<string>', ], ], 'source' => 'AMAZON_CONNECT', // REQUIRED ], 'importJobType' => 'QUICK_RESPONSES', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED 'metadata' => ['<string>', ...], 'uploadId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- clientToken
-
- Type: string
The tags used to organize, track, or control access for this resource.
- externalSourceConfiguration
-
- Type: ExternalSourceConfiguration structure
The configuration information of the external source that the resource data are imported from.
- importJobType
-
- Required: Yes
- Type: string
The type of the import job.
-
For importing quick response resource, set the value to
QUICK_RESPONSES
.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
-
For importing Amazon Q in Connect quick responses, this should be a
QUICK_RESPONSES
type knowledge base.
- metadata
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
The metadata fields of the imported Amazon Q in Connect resources.
- uploadId
-
- Required: Yes
- Type: string
A pointer to the uploaded asset. This value is returned by StartContentUpload.
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
Members
- importJob
-
- Type: ImportJobData structure
The import job.
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 asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.- ValidationException:
The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException:
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- ResourceNotFoundException:
The specified resource does not exist.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds the specified tags to the specified resource.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
Result Syntax
[]
Result Details
Errors
- TooManyTagsException:
Amazon Q in Connect throws this exception if you have too many tags in your tag set.
- ResourceNotFoundException:
The specified resource does not exist.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes the specified tags from the specified resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource does not exist.
UpdateAIAgent
$result = $client->updateAIAgent
([/* ... */]); $promise = $client->updateAIAgentAsync
([/* ... */]);
Updates an AI Agent.
Parameter Syntax
$result = $client->updateAIAgent([ 'aiAgentId' => '<string>', // REQUIRED 'assistantId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'configuration' => [ '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>', 'visibilityStatus' => 'SAVED|PUBLISHED', // REQUIRED ]);
Parameter Details
Members
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Agent.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- configuration
-
- Type: AIAgentConfiguration structure
The configuration of the Amazon Q in Connect AI Agent.
- description
-
- Type: string
The description of the Amazon Q in Connect AI Agent.
- visibilityStatus
-
- Required: Yes
- Type: string
The visbility status of the Amazon Q in Connect AI Agent.
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
Members
- aiAgent
-
- Type: AIAgentData structure
The data of the updated Amazon Q in Connect AI Agent.
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 asCreateAssistant
) 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.
UpdateAIGuardrail
$result = $client->updateAIGuardrail
([/* ... */]); $promise = $client->updateAIGuardrailAsync
([/* ... */]);
Updates an AI Guardrail.
Parameter Syntax
$result = $client->updateAIGuardrail([ 'aiGuardrailId' => '<string>', // REQUIRED '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>', '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 ], // ... ], ], '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
Members
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- blockedInputMessaging
-
- Required: Yes
- Type: string
The message to return when the AI Guardrail blocks a prompt.
- blockedOutputsMessaging
-
- Required: Yes
- Type: string
The message to return when the AI Guardrail blocks a model response.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- contentPolicyConfig
-
- Type: AIGuardrailContentPolicyConfig structure
The content filter policies to configure for the AI Guardrail.
- contextualGroundingPolicyConfig
-
- Type: AIGuardrailContextualGroundingPolicyConfig structure
The contextual grounding policy configuration used to create an AI Guardrail.
- description
-
- Type: string
A description of the AI Guardrail.
- sensitiveInformationPolicyConfig
-
- Type: AIGuardrailSensitiveInformationPolicyConfig structure
The sensitive information policy to configure for the AI Guardrail.
- topicPolicyConfig
-
- Type: AIGuardrailTopicPolicyConfig structure
The topic policies to configure for the AI Guardrail.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the Amazon Q in Connect AI Guardrail.
- wordPolicyConfig
-
- Type: AIGuardrailWordPolicyConfig structure
The word policy you configure for the AI Guardrail.
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
Members
- aiGuardrail
-
- Type: AIGuardrailData structure
The data of the updated Amazon Q in Connect AI Guardrail.
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 asCreateAssistant
) 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.
UpdateAIPrompt
$result = $client->updateAIPrompt
([/* ... */]); $promise = $client->updateAIPromptAsync
([/* ... */]);
Updates an AI Prompt.
Parameter Syntax
$result = $client->updateAIPrompt([ 'aiPromptId' => '<string>', // REQUIRED 'assistantId' => '<string>', // REQUIRED 'clientToken' => '<string>', 'description' => '<string>', 'templateConfiguration' => [ 'textFullAIPromptEditTemplateConfiguration' => [ 'text' => '<string>', // REQUIRED ], ], 'visibilityStatus' => 'SAVED|PUBLISHED', // REQUIRED ]);
Parameter Details
Members
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Prompt.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- clientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..
- description
-
- Type: string
The description of the Amazon Q in Connect AI Prompt.
- templateConfiguration
-
- Type: AIPromptTemplateConfiguration structure
The configuration of the prompt template for this AI Prompt.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the Amazon Q in Connect AI prompt.
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
Members
- aiPrompt
-
- Type: AIPromptData structure
The data of the updated Amazon Q in Connect AI Prompt.
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 asCreateAssistant
) 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.
UpdateAssistantAIAgent
$result = $client->updateAssistantAIAgent
([/* ... */]); $promise = $client->updateAssistantAIAgentAsync
([/* ... */]);
Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
Parameter Syntax
$result = $client->updateAssistantAIAgent([ 'aiAgentType' => 'MANUAL_SEARCH|ANSWER_RECOMMENDATION|SELF_SERVICE', // REQUIRED 'assistantId' => '<string>', // REQUIRED 'configuration' => [ // REQUIRED 'aiAgentId' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- aiAgentType
-
- Required: Yes
- Type: string
The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- configuration
-
- Required: Yes
- Type: AIAgentConfigurationData structure
The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
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
Members
- assistant
-
- Type: AssistantData structure
The assistant data.
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.
UpdateContent
$result = $client->updateContent
([/* ... */]); $promise = $client->updateContentAsync
([/* ... */]);
Updates information about the content.
Parameter Syntax
$result = $client->updateContent([ 'contentId' => '<string>', // REQUIRED 'knowledgeBaseId' => '<string>', // REQUIRED 'metadata' => ['<string>', ...], 'overrideLinkOutUri' => '<string>', 'removeOverrideLinkOutUri' => true || false, 'revisionId' => '<string>', 'title' => '<string>', 'uploadId' => '<string>', ]);
Parameter Details
Members
- contentId
-
- Required: Yes
- Type: string
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN
- metadata
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
- overrideLinkOutUri
-
- Type: string
The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing
overrideLinkOurUri
, exclude this argument and setremoveOverrideLinkOutUri
to true. - removeOverrideLinkOutUri
-
- Type: boolean
Unset the existing
overrideLinkOutUri
if it exists. - revisionId
-
- Type: string
The
revisionId
of the content resource to update, taken from an earlier call toGetContent
,GetContentSummary
,SearchContent
, orListContents
. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws aPreconditionFailedException
. - title
-
- Type: string
The title of the content.
- uploadId
-
- Type: string
A pointer to the uploaded asset. This value is returned by StartContentUpload.
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
Members
- content
-
- Type: ContentData structure
The content.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by a service.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- PreconditionFailedException:
The provided
revisionId
does not match, indicating the content has been modified since it was last read.- ResourceNotFoundException:
The specified resource does not exist.
UpdateKnowledgeBaseTemplateUri
$result = $client->updateKnowledgeBaseTemplateUri
([/* ... */]); $promise = $client->updateKnowledgeBaseTemplateUriAsync
([/* ... */]);
Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable}
format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id
value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view
.
Parameter Syntax
$result = $client->updateKnowledgeBaseTemplateUri([ 'knowledgeBaseId' => '<string>', // REQUIRED 'templateUri' => '<string>', // REQUIRED ]);
Parameter Details
Members
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- templateUri
-
- Required: Yes
- Type: string
The template URI to update.
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
Members
- knowledgeBase
-
- Type: KnowledgeBaseData structure
The knowledge base to update.
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.
UpdateMessageTemplate
$result = $client->updateMessageTemplate
([/* ... */]); $promise = $client->updateMessageTemplateAsync
([/* ... */]);
Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST
qualifier. Any modification will only apply to the message template that is referenced by the $LATEST
qualifier. The fields for all available versions will remain unchanged.
Parameter Syntax
$result = $client->updateMessageTemplate([ 'content' => [ '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>', ], ], ], 'knowledgeBaseId' => '<string>', // REQUIRED 'language' => '<string>', 'messageTemplateId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- content
-
- Type: MessageTemplateContentProvider structure
The content of the message template.
- defaultAttributes
-
- Type: MessageTemplateAttributes structure
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- language
-
- Type: string
The language code value for the language in which the quick response is written. The supported language codes include
de_DE
,en_US
,es_ES
,fr_FR
,id_ID
,it_IT
,ja_JP
,ko_KR
,pt_BR
,zh_CN
,zh_TW
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
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
Members
- messageTemplate
-
- Type: MessageTemplateData structure
The message template.
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 asCreateAssistant
) 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.
UpdateMessageTemplateMetadata
$result = $client->updateMessageTemplateMetadata
([/* ... */]); $promise = $client->updateMessageTemplateMetadataAsync
([/* ... */]);
Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST
qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
Parameter Syntax
$result = $client->updateMessageTemplateMetadata([ 'description' => '<string>', 'groupingConfiguration' => [ 'criteria' => '<string>', 'values' => ['<string>', ...], ], 'knowledgeBaseId' => '<string>', // REQUIRED 'messageTemplateId' => '<string>', // REQUIRED 'name' => '<string>', ]);
Parameter Details
Members
- description
-
- Type: string
The description of the message template.
- groupingConfiguration
-
- Type: GroupingConfiguration structure
The configuration information of the grouping of Amazon Q in Connect users.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
- name
-
- Type: string
The name of the message template.
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
Members
- messageTemplate
-
- Type: MessageTemplateData structure
The message template.
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 asCreateAssistant
) 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.
UpdateQuickResponse
$result = $client->updateQuickResponse
([/* ... */]); $promise = $client->updateQuickResponseAsync
([/* ... */]);
Updates an existing Amazon Q in Connect quick response.
Parameter Syntax
$result = $client->updateQuickResponse([ 'channels' => ['<string>', ...], 'content' => [ 'content' => '<string>', ], 'contentType' => '<string>', 'description' => '<string>', 'groupingConfiguration' => [ 'criteria' => '<string>', 'values' => ['<string>', ...], ], 'isActive' => true || false, 'knowledgeBaseId' => '<string>', // REQUIRED 'language' => '<string>', 'name' => '<string>', 'quickResponseId' => '<string>', // REQUIRED 'removeDescription' => true || false, 'removeGroupingConfiguration' => true || false, 'removeShortcutKey' => true || false, 'shortcutKey' => '<string>', ]);
Parameter Details
Members
- channels
-
- Type: Array of strings
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat
. - content
-
- Type: QuickResponseDataProvider structure
The updated content of the quick response.
- contentType
-
- Type: string
The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
- description
-
- Type: string
The updated description of the quick response.
- groupingConfiguration
-
- Type: GroupingConfiguration structure
The updated grouping configuration of the quick response.
- isActive
-
- Type: boolean
Whether the quick response is active.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- language
-
- Type: string
The language code value for the language in which the quick response is written. The supported language codes include
de_DE
,en_US
,es_ES
,fr_FR
,id_ID
,it_IT
,ja_JP
,ko_KR
,pt_BR
,zh_CN
,zh_TW
- name
-
- Type: string
The name of the quick response.
- quickResponseId
-
- Required: Yes
- Type: string
The identifier of the quick response.
- removeDescription
-
- Type: boolean
Whether to remove the description from the quick response.
- removeGroupingConfiguration
-
- Type: boolean
Whether to remove the grouping configuration of the quick response.
- removeShortcutKey
-
- Type: boolean
Whether to remove the shortcut key of the quick response.
- shortcutKey
-
- Type: string
The shortcut key of the quick response. The value should be unique across the knowledge base.
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
Members
- quickResponse
-
- Type: QuickResponseData structure
The quick response.
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 asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.- ValidationException:
The input fails to satisfy the constraints specified by a service.
- AccessDeniedException:
You do not have sufficient access to perform this action.
- PreconditionFailedException:
The provided
revisionId
does not match, indicating the content has been modified since it was last read.- ResourceNotFoundException:
The specified resource does not exist.
UpdateSession
$result = $client->updateSession
([/* ... */]); $promise = $client->updateSessionAsync
([/* ... */]);
Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
Parameter Syntax
$result = $client->updateSession([ 'aiAgentConfiguration' => [ '<AIAgentType>' => [ 'aiAgentId' => '<string>', // REQUIRED ], // ... ], 'assistantId' => '<string>', // REQUIRED 'description' => '<string>', 'sessionId' => '<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>', ], ], ]);
Parameter Details
Members
- aiAgentConfiguration
-
- Type: Associative array of custom strings keys (AIAgentType) to AIAgentConfigurationData structures
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description
-
- Type: string
The description.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
- tagFilter
-
- Type: TagFilter structure
An object that can be used to specify Tag conditions.
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
Members
- session
-
- Type: SessionData structure
Information about the session.
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.
UpdateSessionData
$result = $client->updateSessionData
([/* ... */]); $promise = $client->updateSessionDataAsync
([/* ... */]);
Updates the data stored on an Amazon Q in Connect Session.
Parameter Syntax
$result = $client->updateSessionData([ 'assistantId' => '<string>', // REQUIRED 'data' => [ // REQUIRED [ 'key' => '<string>', // REQUIRED 'value' => [ // REQUIRED 'stringValue' => '<string>', ], ], // ... ], 'namespace' => 'Custom', 'sessionId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- data
-
- Required: Yes
- Type: Array of RuntimeSessionData structures
The data stored on the Amazon Q in Connect Session.
- namespace
-
- Type: string
The namespace into which the session data is stored. Supported namespaces are: Custom
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Result Syntax
[ 'data' => [ [ 'key' => '<string>', 'value' => [ 'stringValue' => '<string>', ], ], // ... ], 'namespace' => 'Custom', 'sessionArn' => '<string>', 'sessionId' => '<string>', ]
Result Details
Members
- data
-
- Required: Yes
- Type: Array of RuntimeSessionData structures
Data stored in the session.
- namespace
-
- Required: Yes
- Type: string
The namespace into which the session data is stored. Supported namespaces are: Custom
- sessionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the session.
- sessionId
-
- Required: Yes
- Type: string
The identifier of the session.
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.
Shapes
AIAgentConfiguration
Description
A typed union that specifies the configuration based on the type of AI Agent.
Members
- answerRecommendationAIAgentConfiguration
-
- Type: AnswerRecommendationAIAgentConfiguration structure
The configuration for AI Agents of type
ANSWER_RECOMMENDATION
. - manualSearchAIAgentConfiguration
-
- Type: ManualSearchAIAgentConfiguration structure
The configuration for AI Agents of type
MANUAL_SEARCH
. - selfServiceAIAgentConfiguration
-
- Type: SelfServiceAIAgentConfiguration structure
The configuration for AI Agents of type SELF_SERVICE.
AIAgentConfigurationData
Description
A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be used for an AI Agent type on a session or assistant.
Members
- aiAgentId
-
- Required: Yes
- Type: string
The ID of the AI Agent to be configured.
AIAgentData
Description
The data for the AI Agent.
Members
- aiAgentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI agent.
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the AI Agent.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- configuration
-
- Required: Yes
- Type: AIAgentConfiguration structure
Configuration for the AI Agent.
- description
-
- Type: string
The description of the AI Agent.
- modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Agent was last modified.
- name
-
- Required: Yes
- Type: string
The name of the AI Agent.
- origin
-
- Type: string
Specifies the origin of the AI Agent.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs. - status
-
- Type: string
The status of the AI Agent.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of the AI Agent.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Agent.
AIAgentSummary
Description
The summary of the AI Agent.
Members
- aiAgentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI agent.
- aiAgentId
-
- Required: Yes
- Type: string
The identifier of the AI Agent.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- configuration
-
- Type: AIAgentConfiguration structure
The configuration for the AI Agent.
- description
-
- Type: string
The description of the AI Agent.
- modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Agent was last modified.
- name
-
- Required: Yes
- Type: string
The name of the AI Agent.
- origin
-
- Type: string
The origin of the AI Agent.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs. - status
-
- Type: string
The status of the AI Agent.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of the AI Agent.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Agent.
AIAgentVersionSummary
Description
The summary of the AI Agent version.
Members
- aiAgentSummary
-
- Type: AIAgentSummary structure
The data for the summary of the AI Agent version.
- versionNumber
-
- Type: long (int|float)
The version number for this AI Agent version.
AIGuardrailContentPolicyConfig
Description
Contains details about how to handle harmful content.
Members
- filtersConfig
-
- Required: Yes
- Type: Array of GuardrailContentFilterConfig structures
Contains the type of the content filter and how strongly it should apply to prompts and model responses.
AIGuardrailContextualGroundingPolicyConfig
Description
The policy configuration details for the AI Guardrail's contextual grounding policy.
Members
- filtersConfig
-
- Required: Yes
- Type: Array of GuardrailContextualGroundingFilterConfig structures
The filter configuration details for the AI Guardrails contextual grounding policy.
AIGuardrailData
Description
The data for the AI Guardrail
Members
- aiGuardrailArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI Guardrail.
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- blockedInputMessaging
-
- Required: Yes
- Type: string
The message to return when the AI Guardrail blocks a prompt.
- blockedOutputsMessaging
-
- Required: Yes
- Type: string
The message to return when the AI Guardrail blocks a model response.
- contentPolicyConfig
-
- Type: AIGuardrailContentPolicyConfig structure
Contains details about how to handle harmful content.
- contextualGroundingPolicyConfig
-
- Type: AIGuardrailContextualGroundingPolicyConfig structure
The policy configuration details for the AI Guardrail's contextual grounding policy.
- description
-
- Type: string
A description of the AI Guardrail.
- modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Guardrail was last modified.
- name
-
- Required: Yes
- Type: string
The name of the AI Guardrail.
- sensitiveInformationPolicyConfig
-
- Type: AIGuardrailSensitiveInformationPolicyConfig structure
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
- status
-
- Type: string
The status of the AI Guardrail.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- topicPolicyConfig
-
- Type: AIGuardrailTopicPolicyConfig structure
Contains details about topics that the AI Guardrail should identify and deny.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Guardrail.
- wordPolicyConfig
-
- Type: AIGuardrailWordPolicyConfig structure
Contains details about the word policy to configured for the AI Guardrail.
AIGuardrailSensitiveInformationPolicyConfig
Description
Contains details about PII entities and regular expressions to configure for the AI Guardrail.
Members
- piiEntitiesConfig
-
- Type: Array of GuardrailPiiEntityConfig structures
A list of PII entities to configure to the AI Guardrail.
- regexesConfig
-
- Type: Array of GuardrailRegexConfig structures
A list of regular expressions to configure to the AI Guardrail.
AIGuardrailSummary
Description
The summary of the AI Guardrail.
Members
- aiGuardrailArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI Guardrail.
- aiGuardrailId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI Guardrail.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description
-
- Type: string
A description of the AI Guardrail.
- modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Guardrail was last modified.
- name
-
- Required: Yes
- Type: string
The name of the AI Guardrail.
- status
-
- Type: string
The status of the AI Guardrail.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Guardrail.
AIGuardrailTopicPolicyConfig
Description
Contains details about topics that the AI Guardrail should identify and deny.
Members
- topicsConfig
-
- Required: Yes
- Type: Array of GuardrailTopicConfig structures
A list of policies related to topics that the AI Guardrail should deny.
AIGuardrailVersionSummary
Description
The summary of the AI Guardrail version.
Members
- aiGuardrailSummary
-
- Type: AIGuardrailSummary structure
The data for the summary of the AI Guardrail version.
- versionNumber
-
- Type: long (int|float)
The version number for this AI Guardrail version.
AIGuardrailWordPolicyConfig
Description
Contains details about the word policy to configured for the AI Guardrail.
Members
- managedWordListsConfig
-
- Type: Array of GuardrailManagedWordsConfig structures
A list of managed words to configure for the AI Guardrail.
- wordsConfig
-
- Type: Array of GuardrailWordConfig structures
A list of words to configure for the AI Guardrail.
AIPromptData
Description
The data for the AI Prompt
Members
- aiPromptArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI Prompt.
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI prompt.
- apiFormat
-
- Required: Yes
- Type: string
The API format used for this AI Prompt.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description
-
- Type: string
The description of the AI Prompt.
- modelId
-
- Required: Yes
- Type: string
The identifier of the model used for this AI Prompt. Model Ids supported are:
CLAUDE_3_HAIKU_20240307_V1
. - modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Prompt was last modified.
- name
-
- Required: Yes
- Type: string
The name of the AI Prompt
- origin
-
- Type: string
The origin of the AI Prompt.
SYSTEM
for a default AI Prompt created by Q in Connect orCUSTOMER
for an AI Prompt created by calling AI Prompt creation APIs. - status
-
- Type: string
The status of the AI Prompt.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- templateConfiguration
-
- Required: Yes
- Type: AIPromptTemplateConfiguration structure
The configuration of the prompt template for this AI Prompt.
- templateType
-
- Required: Yes
- Type: string
The type of the prompt template for this AI Prompt.
- type
-
- Required: Yes
- Type: string
The type of this AI Prompt.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Prompt.
AIPromptSummary
Description
The summary of the AI Prompt.
Members
- aiPromptArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AI Prompt.
- aiPromptId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect AI prompt.
- apiFormat
-
- Required: Yes
- Type: string
The API format used for this AI Prompt.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
- description
-
- Type: string
The description of the AI Prompt.
- modelId
-
- Required: Yes
- Type: string
The identifier of the model used for this AI Prompt. Model Ids supported are:
CLAUDE_3_HAIKU_20240307_V1
. - modifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the AI Prompt was last modified.
- name
-
- Required: Yes
- Type: string
The name of the AI Prompt.
- origin
-
- Type: string
The origin of the AI Prompt.
SYSTEM
for a default AI Prompt created by Q in Connect orCUSTOMER
for an AI Prompt created by calling AI Prompt creation APIs. - status
-
- Type: string
The status of the AI Prompt.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- templateType
-
- Required: Yes
- Type: string
The type of the prompt template for this AI Prompt.
- type
-
- Required: Yes
- Type: string
The type of this AI Prompt.
- visibilityStatus
-
- Required: Yes
- Type: string
The visibility status of the AI Prompt.
AIPromptTemplateConfiguration
Description
A typed union that specifies the configuration for a prompt template based on its type.
Members
- textFullAIPromptEditTemplateConfiguration
-
- Type: TextFullAIPromptEditTemplateConfiguration structure
The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.
AIPromptVersionSummary
Description
The summary of the AI Prompt version.
Members
- aiPromptSummary
-
- Type: AIPromptSummary structure
The date for the summary of the AI Prompt version.
- versionNumber
-
- Type: long (int|float)
The version number for this AI Prompt version.
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
- message
-
- Type: string
AgentAttributes
Description
Information about an agent.
Members
- firstName
-
- Type: string
The agent’s first name as entered in their Amazon Connect user account.
- lastName
-
- Type: string
The agent’s last name as entered in their Amazon Connect user account.
AmazonConnectGuideAssociationData
Description
Content association data for a step-by-step guide.
Members
- flowId
-
- Type: string
The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
AnswerRecommendationAIAgentConfiguration
Description
The configuration for the ANSWER_RECOMMENDATION
AI Agent type.
Members
- answerGenerationAIGuardrailId
-
- Type: string
The AI Guardrail identifier for the Answer Generation Guardrail used by the
ANSWER_RECOMMENDATION
AI Agent. - answerGenerationAIPromptId
-
- Type: string
The AI Prompt identifier for the Answer Generation prompt used by the
ANSWER_RECOMMENDATION
AI Agent. - associationConfigurations
-
- Type: Array of AssociationConfiguration structures
The association configurations for overriding behavior on this AI Agent.
- intentLabelingGenerationAIPromptId
-
- Type: string
The AI Prompt identifier for the Intent Labeling prompt used by the
ANSWER_RECOMMENDATION
AI Agent. - queryReformulationAIPromptId
-
- Type: string
The AI Prompt identifier for the Query Reformulation prompt used by the
ANSWER_RECOMMENDATION
AI Agent.
AppIntegrationsConfiguration
Description
Configuration information for Amazon AppIntegrations to automatically ingest content.
Members
- appIntegrationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
-
For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
as source fields. -
For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
as source fields. -
For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if
objectFields
is not provided, including at leastid
,title
,updated_at
, anddraft
as source fields. -
For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among
docx
,pdf
,html
,htm
, andtxt
. -
For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The
SourceURI
of your DataIntegration must use the following format:s3://your_s3_bucket_name
.The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal
app-integrations.amazonaws.com
to performs3:ListBucket
,s3:GetObject
, ands3:GetBucketLocation
against the bucket.
- objectFields
-
- Type: Array of strings
The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.
-
For Salesforce, you must include at least
Id
,ArticleNumber
,VersionNumber
,Title
,PublishStatus
, andIsDeleted
. -
For ServiceNow, you must include at least
number
,short_description
,sys_mod_count
,workflow_state
, andactive
. -
For Zendesk, you must include at least
id
,title
,updated_at
, anddraft
.
Make sure to include additional fields. These fields are indexed and used to source recommendations.
AssistantAssociationData
Description
Information about the assistant association.
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantAssociationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the assistant association.
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- associationData
-
- Required: Yes
- Type: AssistantAssociationOutputData structure
A union type that currently has a single argument, the knowledge base ID.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
AssistantAssociationInputData
Description
The data that is input into Amazon Q in Connect as a result of the assistant association.
Members
- knowledgeBaseId
-
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
AssistantAssociationOutputData
Description
The data that is output as a result of the assistant association.
Members
- knowledgeBaseAssociation
-
- Type: KnowledgeBaseAssociationData structure
The knowledge base where output data is sent.
AssistantAssociationSummary
Description
Summary information about the assistant association.
Members
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantAssociationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the assistant association.
- assistantAssociationId
-
- Required: Yes
- Type: string
The identifier of the assistant association.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- associationData
-
- Required: Yes
- Type: AssistantAssociationOutputData structure
The association data.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
AssistantCapabilityConfiguration
Description
The capability configuration for an Amazon Q in Connect assistant.
Members
- type
-
- Type: string
The type of Amazon Q in Connect assistant capability.
AssistantData
Description
The assistant data.
Members
- aiAgentConfiguration
-
- Type: Associative array of custom strings keys (AIAgentType) to AIAgentConfigurationData structures
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- capabilityConfiguration
-
- Type: AssistantCapabilityConfiguration structure
The configuration information for the Amazon Q in Connect assistant capability.
- description
-
- Type: string
The description.
- integrationConfiguration
-
- Type: AssistantIntegrationConfiguration structure
The configuration information for the Amazon Q in Connect assistant integration.
- name
-
- Required: Yes
- Type: string
The name.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,kms:Decrypt
, andkms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
- status
-
- Required: Yes
- Type: string
The status of the assistant.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of assistant.
AssistantIntegrationConfiguration
Description
The configuration information for the Amazon Q in Connect assistant integration.
Members
- topicIntegrationArn
-
- Type: string
The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.
AssistantSummary
Description
Summary information about the assistant.
Members
- aiAgentConfiguration
-
- Type: Associative array of custom strings keys (AIAgentType) to AIAgentConfigurationData structures
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is set on the Amazon Q in Connect Assistant.
- assistantArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
- assistantId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q in Connect assistant.
- capabilityConfiguration
-
- Type: AssistantCapabilityConfiguration structure
The configuration information for the Amazon Q in Connect assistant capability.
- description
-
- Type: string
The description of the assistant.
- integrationConfiguration
-
- Type: AssistantIntegrationConfiguration structure
The configuration information for the Amazon Q in Connect assistant integration.
- name
-
- Required: Yes
- Type: string
The name of the assistant.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,kms:Decrypt
, andkms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allowkms:Decrypt
,kms:GenerateDataKey*
, andkms:DescribeKey
permissions to theconnect.amazonaws.com
service principal.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
- status
-
- Required: Yes
- Type: string
The status of the assistant.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- type
-
- Required: Yes
- Type: string
The type of the assistant.
AssociationConfiguration
Description
The configuration for an Amazon Q in Connect Assistant Association.
Members
- associationConfigurationData
-
- Type: AssociationConfigurationData structure
The data of the configuration for an Amazon Q in Connect Assistant Association.
- associationId
-
- Type: string
The identifier of the association for this Association Configuration.
- associationType
-
- Type: string
The type of the association for this Association Configuration.
AssociationConfigurationData
Description
A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
Members
- knowledgeBaseAssociationConfigurationData
-
- Type: KnowledgeBaseAssociationConfigurationData structure
The data of the configuration for a
KNOWLEDGE_BASE
type Amazon Q in Connect Assistant Association.
BedrockFoundationModelConfigurationForParsing
Description
Settings for a foundation model used to parse documents for a data source.
Members
- modelArn
-
- Required: Yes
- Type: string
The ARN of the foundation model.
- parsingPrompt
-
- Type: ParsingPrompt structure
Instructions for interpreting the contents of a document.
ChunkingConfiguration
Description
Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
Members
- chunkingStrategy
-
- Required: Yes
- Type: string
Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for
NONE
, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. - fixedSizeChunkingConfiguration
-
- Type: FixedSizeChunkingConfiguration structure
Configurations for when you choose fixed-size chunking. If you set the
chunkingStrategy
asNONE
, exclude this field. - hierarchicalChunkingConfiguration
-
- Type: HierarchicalChunkingConfiguration structure
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
- semanticChunkingConfiguration
-
- Type: SemanticChunkingConfiguration structure
Settings for semantic document chunking for a data source. Semantic chunking splits a document into smaller documents based on groups of similar content derived from the text with natural language processing.
CitationSpan
Description
Contains information about where the text with a citation begins and ends in the generated output.
Members
- beginOffsetInclusive
-
- Type: int
Where the text with a citation starts in the generated output.
- endOffsetExclusive
-
- Type: int
Where the text with a citation ends in the generated output.
Configuration
Description
The configuration information of the external data source.
Members
- connectConfiguration
-
- Type: ConnectConfiguration structure
The configuration information of the Amazon Connect data source.
ConflictException
Description
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.
Members
- message
-
- Type: string
ConnectConfiguration
Description
The configuration information of the Amazon Connect data source.
Members
- instanceId
-
- Type: string
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
ContentAssociationContents
Description
The contents of a content association.
Members
- amazonConnectGuideAssociation
-
- Type: AmazonConnectGuideAssociationData structure
The data of the step-by-step guide association.
ContentAssociationData
Description
Information about the content association.
Members
- associationData
-
- Required: Yes
- Type: ContentAssociationContents structure
The content association.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- contentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentAssociationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content association.
- contentAssociationId
-
- Required: Yes
- Type: string
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
ContentAssociationSummary
Description
Summary information about a content association.
Members
- associationData
-
- Required: Yes
- Type: ContentAssociationContents structure
The content association.
- associationType
-
- Required: Yes
- Type: string
The type of association.
- contentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentAssociationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content association.
- contentAssociationId
-
- Required: Yes
- Type: string
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
ContentData
Description
Information about the content.
Members
- contentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- contentType
-
- Required: Yes
- Type: string
The media type of the content.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- linkOutUri
-
- Type: string
The URI of the content.
- metadata
-
- Required: Yes
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
- name
-
- Required: Yes
- Type: string
The name of the content.
- revisionId
-
- Required: Yes
- Type: string
The identifier of the content revision.
- status
-
- Required: Yes
- Type: string
The status of the content.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- title
-
- Required: Yes
- Type: string
The title of the content.
- url
-
- Required: Yes
- Type: string
The URL of the content.
- urlExpiry
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration time of the URL as an epoch timestamp.
ContentDataDetails
Description
Details about the content data.
Members
- rankingData
-
- Required: Yes
- Type: RankingData structure
Details about the content ranking data.
- textData
-
- Required: Yes
- Type: TextData structure
Details about the content text data.
ContentFeedbackData
Description
Information about the feedback.
Members
- generativeContentFeedbackData
-
- Type: GenerativeContentFeedbackData structure
Information about the feedback for a generative target type.
ContentReference
Description
Reference information about the content.
Members
- contentArn
-
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentId
-
- Type: string
The identifier of the content.
- knowledgeBaseArn
-
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
- referenceType
-
- Type: string
The type of reference content.
- sourceURL
-
- Type: string
The web URL of the source content.
ContentSummary
Description
Summary information about the content.
Members
- contentArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the content.
- contentId
-
- Required: Yes
- Type: string
The identifier of the content.
- contentType
-
- Required: Yes
- Type: string
The media type of the content.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.
- metadata
-
- Required: Yes
- Type: Associative array of custom strings keys (NonEmptyString) to strings
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.
- name
-
- Required: Yes
- Type: string
The name of the content.
- revisionId
-
- Required: Yes
- Type: string
The identifier of the revision of the content.
- status
-
- Required: Yes
- Type: string
The status of the content.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- title
-
- Required: Yes
- Type: string
The title of the content.
ConversationContext
Description
The conversation context to include in SendMessage.
Members
- selfServiceConversationHistory
-
- Required: Yes
- Type: Array of SelfServiceConversationHistory structures
The self service conversation history before the Amazon Q in Connect session.
ConversationState
Description
The conversation state associated to a message.
Members
- reason
-
- Type: string
The reason of the conversation state.
- status
-
- Required: Yes
- Type: string
The status of the conversation state.
CustomerProfileAttributes
Description
The customer profile attributes that are used with the message template.
Members
- accountNumber
-
- Type: string
A unique account number that you have given to the customer.
- additionalInformation
-
- Type: string
Any additional information relevant to the customer's profile.
- address1
-
- Type: string
The first line of a customer address.
- address2
-
- Type: string
The second line of a customer address.
- address3
-
- Type: string
The third line of a customer address.
- address4
-
- Type: string
The fourth line of a customer address.
- billingAddress1
-
- Type: string
The first line of a customer’s billing address.
- billingAddress2
-
- Type: string
The second line of a customer’s billing address.
- billingAddress3
-
- Type: string
The third line of a customer’s billing address.
- billingAddress4
-
- Type: string
The fourth line of a customer’s billing address.
- billingCity
-
- Type: string
The city of a customer’s billing address.
- billingCountry
-
- Type: string
The country of a customer’s billing address.
- billingCounty
-
- Type: string
The county of a customer’s billing address.
- billingPostalCode
-
- Type: string
The postal code of a customer’s billing address.
- billingProvince
-
- Type: string
The province of a customer’s billing address.
- billingState
-
- Type: string
The state of a customer’s billing address.
- birthDate
-
- Type: string
The customer's birth date.
- businessEmailAddress
-
- Type: string
The customer's business email address.
- businessName
-
- Type: string
The name of the customer's business.
- businessPhoneNumber
-
- Type: string
The customer's business phone number.
- city
-
- Type: string
The city in which a customer lives.
- country
-
- Type: string
The country in which a customer lives.
- county
-
- Type: string
The county in which a customer lives.
- custom
-
- Type: Associative array of custom strings keys (MessageTemplateAttributeKey) to strings
The custom attributes in customer profile attributes.
- emailAddress
-
- Type: string
The customer's email address, which has not been specified as a personal or business address.
- firstName
-
- Type: string
The customer's first name.
- gender
-
- Type: string
The customer's gender.
- homePhoneNumber
-
- Type: string
The customer's mobile phone number.
- lastName
-
- Type: string
The customer's last name.
- mailingAddress1
-
- Type: string
The first line of a customer’s mailing address.
- mailingAddress2
-
- Type: string
The second line of a customer’s mailing address.
- mailingAddress3
-
- Type: string
The third line of a customer’s mailing address.
- mailingAddress4
-
- Type: string
The fourth line of a customer’s mailing address.
- mailingCity
-
- Type: string
The city of a customer’s mailing address.
- mailingCountry
-
- Type: string
The country of a customer’s mailing address.
- mailingCounty
-
- Type: string
The county of a customer’s mailing address.
- mailingPostalCode
-
- Type: string
The postal code of a customer’s mailing address.
- mailingProvince
-
- Type: string
The province of a customer’s mailing address.
- mailingState
-
- Type: string
The state of a customer’s mailing address.
- middleName
-
- Type: string
The customer's middle name.
- mobilePhoneNumber
-
- Type: string
The customer's mobile phone number.
- partyType
-
- Type: string
The customer's party type.
- phoneNumber
-
- Type: string
The customer's phone number, which has not been specified as a mobile, home, or business number.
- postalCode
-
- Type: string
The postal code of a customer address.
- profileARN
-
- Type: string
The ARN of a customer profile.
- profileId
-
- Type: string
The unique identifier of a customer profile.
- province
-
- Type: string
The province in which a customer lives.
- shippingAddress1
-
- Type: string
The first line of a customer’s shipping address.
- shippingAddress2
-
- Type: string
The second line of a customer’s shipping address.
- shippingAddress3
-
- Type: string
The third line of a customer’s shipping address.
- shippingAddress4
-
- Type: string
The fourth line of a customer’s shipping address.
- shippingCity
-
- Type: string
The city of a customer’s shipping address.
- shippingCountry
-
- Type: string
The country of a customer’s shipping address.
- shippingCounty
-
- Type: string
The county of a customer’s shipping address.
- shippingPostalCode
-
- Type: string
The postal code of a customer’s shipping address.
- shippingProvince
-
- Type: string
The province of a customer’s shipping address.
- shippingState
-
- Type: string
The state of a customer’s shipping address.
- state
-
- Type: string
The state in which a customer lives.
DataDetails
Description
Details about the data.
Members
- contentData
-
- Type: ContentDataDetails structure
Details about the content data.
- generativeData
-
- Type: GenerativeDataDetails structure
Details about the generative data.
- intentDetectedData
-
- Type: IntentDetectedDataDetails structure
Details about the intent data.
- sourceContentData
-
- Type: SourceContentDataDetails structure
Details about the content data.
DataReference
Description
Reference data.
Members
- contentReference
-
- Type: ContentReference structure
Reference information about the content.
- generativeReference
-
- Type: GenerativeReference structure
Reference information about the generative content.
DataSummary
Description
Summary of the data.
Members
- details
-
- Required: Yes
- Type: DataDetails structure
Details about the data.
- reference
-
- Required: Yes
- Type: DataReference structure
Reference information about the content.
Document
Description
The document.
Members
- contentReference
-
- Required: Yes
- Type: ContentReference structure
A reference to the content resource.
- excerpt
-
- Type: DocumentText structure
The excerpt from the document.
- title
-
- Type: DocumentText structure
The title of the document.
DocumentText
Description
The text of the document.
Members
- highlights
-
- Type: Array of Highlight structures
Highlights in the document text.
- text
-
- Type: string
Text in the document.
EmailHeader
Description
The email header to include in email messages.
Members
- name
-
- Type: string
The name of the email header.
- value
-
- Type: string
The value of the email header.
EmailMessageTemplateContent
Description
The content of the message template that applies to the email channel subtype.
Members
- body
-
- Type: EmailMessageTemplateContentBody structure
The body to use in email messages.
- headers
-
- Type: Array of EmailHeader structures
The email headers to include in email messages.
- subject
-
- Type: string
The subject line, or title, to use in email messages.
EmailMessageTemplateContentBody
Description
The body to use in email messages.
Members
- html
-
- Type: MessageTemplateBodyContentProvider structure
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
- plainText
-
- Type: MessageTemplateBodyContentProvider structure
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
ExtendedMessageTemplateData
Description
The extended data of a message template.
Members
- attachments
-
- Type: Array of MessageTemplateAttachment structures
The message template attachments.
- attributeTypes
-
- Type: Array of strings
The types of attributes contain the message template.
- channelSubtype
-
- Required: Yes
- Type: string
The channel subtype this message template applies to.
- content
-
- Required: Yes
- Type: MessageTemplateContentProvider structure
The content of the message template.
- createdTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the message template was created.
- defaultAttributes
-
- Type: MessageTemplateAttributes structure
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
- description
-
- Type: string
The description of the message template.
- groupingConfiguration
-
- Type: GroupingConfiguration structure
The configuration information of the grouping of Amazon Q in Connect users.
- isActive
-
- Type: boolean
Whether the version of the message template is activated.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- language
-
- Type: string
The language code value for the language in which the quick response is written. The supported language codes include
de_DE
,en_US
,es_ES
,fr_FR
,id_ID
,it_IT
,ja_JP
,ko_KR
,pt_BR
,zh_CN
,zh_TW
- lastModifiedBy
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the user who last updated the message template data.
- lastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the message template data was last modified.
- messageTemplateArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the message template.
- messageTemplateContentSha256
-
- Required: Yes
- Type: string
The checksum value of the message template content that is referenced by the
$LATEST
qualifier. It can be returned inMessageTemplateData
orExtendedMessageTemplateData
. It’s calculated by content, language,defaultAttributes
andAttachments
of the message template. - messageTemplateId
-
- Required: Yes
- Type: string
The identifier of the message template.
- name
-
- Required: Yes
- Type: string
The name of the message template.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- versionNumber
-
- Type: long (int|float)
The version number of the message template version.
ExternalSourceConfiguration
Description
The configuration information of the external data source.
Members
- configuration
-
- Required: Yes
- Type: Configuration structure
The configuration information of the external data source.
- source
-
- Required: Yes
- Type: string
The type of the external data source.
Filter
Description
A search filter.
Members
- field
-
- Required: Yes
- Type: string
The field on which to filter.
- operator
-
- Required: Yes
- Type: string
The operator to use for comparing the field’s value with the provided value.
- value
-
- Required: Yes
- Type: string
The desired field value on which to filter.
FixedSizeChunkingConfiguration
Description
Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
as NONE
, exclude this field.
Members
- maxTokens
-
- Required: Yes
- Type: int
The maximum number of tokens to include in a chunk.
- overlapPercentage
-
- Required: Yes
- Type: int
The percentage of overlap between adjacent chunks of a data source.
GenerativeContentFeedbackData
Description
The feedback information for a generative target type.
Members
- relevance
-
- Required: Yes
- Type: string
The relevance of the feedback.
GenerativeDataDetails
Description
Details about generative data.
Members
- completion
-
- Required: Yes
- Type: string
The LLM response.
- rankingData
-
- Required: Yes
- Type: RankingData structure
Details about the generative content ranking data.
- references
-
- Required: Yes
- Type: Array of DataSummary structures
The references used to generative the LLM response.
GenerativeReference
Description
Reference information about generative content.
Members
- generationId
-
- Type: string
The identifier of the LLM model.
- modelId
-
- Type: string
The identifier of the LLM model.
GroupingConfiguration
Description
The configuration information of the grouping of Amazon Q in Connect users.
Members
- criteria
-
- Type: string
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
-
RoutingProfileArn
: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
- values
-
- Type: Array of strings
The list of values that define different groups of Amazon Q in Connect users.
-
When setting
criteria
toRoutingProfileArn
, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
GuardrailContentFilterConfig
Description
Contains filter strengths for harmful content. AI Guardrail's support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
-
Hate: Describes input prompts and model responses that discriminate, criticize, insult, denounce, or dehumanize a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
-
Insults: Describes input prompts and model responses that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
-
Sexual: Describes input prompts and model responses that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
-
Violence: Describes input prompts and model responses that includes glorification of, or threats to inflict physical pain, hurt, or injury toward a person, group, or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.
Members
- inputStrength
-
- Required: Yes
- Type: string
The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
- outputStrength
-
- Required: Yes
- Type: string
The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
- type
-
- Required: Yes
- Type: string
The harmful category that the content filter is applied to.
GuardrailContextualGroundingFilterConfig
Description
The filter configuration details for the AI Guardrail's contextual grounding filter.
Members
- threshold
-
- Required: Yes
- Type: double
The threshold details for the AI Guardrail's contextual grounding filter.
- type
-
- Required: Yes
- Type: string
The filter type for the AI Guardrail's contextual grounding filter.
GuardrailManagedWordsConfig
Description
The managed word list to configure for the AI Guardrail.
Members
- type
-
- Required: Yes
- Type: string
The managed word type to configure for the AI Guardrail.
GuardrailPiiEntityConfig
Description
The PII entity to configure for the AI Guardrail.
Members
- action
-
- Required: Yes
- Type: string
Configure AI Guardrail's action when the PII entity is detected.
- type
-
- Required: Yes
- Type: string
Configure AI Guardrail type when the PII entity is detected.
The following PIIs are used to block or mask sensitive information:
-
General
-
ADDRESS
A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.
-
AGE
An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.
-
NAME
An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn't apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.
-
EMAIL
An email address, such as marymajor@email.com.
-
PHONE
A phone number. This entity type also includes fax and pager numbers.
-
USERNAME
A user name that identifies an account, such as a login name, screen name, nick name, or handle.
-
PASSWORD
An alphanumeric string that is used as a password, such as "* very20special#pass*".
-
DRIVER_ID
The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.
-
LICENSE_PLATE
A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.
-
VEHICLE_IDENTIFICATION_NUMBER
A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.
-
-
Finance
-
REDIT_DEBIT_CARD_CVV
A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.
-
CREDIT_DEBIT_CARD_EXPIRY
The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. AI Guardrail recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.
-
CREDIT_DEBIT_CARD_NUMBER
The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.
-
PIN
A four-digit personal identification number (PIN) with which you can access your bank account.
-
INTERNATIONAL_BANK_ACCOUNT_NUMBER
An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.
-
SWIFT_CODE
A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.
SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.
-
-
IT
-
IP_ADDRESS
An IPv4 address, such as 198.51.100.0.
-
MAC_ADDRESS
A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).
-
URL
A web address, such as www.example.com.
-
AWS_ACCESS_KEY
A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
-
AWS_SECRET_KEY
A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
-
-
USA specific
-
US_BANK_ACCOUNT_NUMBER
A US bank account number, which is typically 10 to 12 digits long.
-
US_BANK_ROUTING_NUMBER
A US bank account routing number. These are typically nine digits long,
-
US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.
-
US_PASSPORT_NUMBER
A US passport number. Passport numbers range from six to nine alphanumeric characters.
-
US_SOCIAL_SECURITY_NUMBER
A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.
-
-
Canada specific
-
CA_HEALTH_NUMBER
A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.
-
CA_SOCIAL_INSURANCE_NUMBER
A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.
The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm .
-
-
UK Specific
-
UK_NATIONAL_HEALTH_SERVICE_NUMBER
A UK National Health Service Number is a 10-17 digit number, such as 485 555 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.
-
UK_NATIONAL_INSURANCE_NUMBER
A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.
The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.
-
UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.
-
-
Custom
-
Regex filter - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..
-
GuardrailRegexConfig
Description
The regular expression to configure for the AI Guardrail.
Members
- action
-
- Required: Yes
- Type: string
The AI Guardrail action to configure when matching regular expression is detected.
- description
-
- Type: string
The description of the regular expression to configure for the AI Guardrail.
- name
-
- Required: Yes
- Type: string
The name of the regular expression to configure for the AI Guardrail.
- pattern
-
- Required: Yes
- Type: string
The regular expression pattern to configure for the AI Guardrail.
GuardrailTopicConfig
Description
Details about topics for the AI Guardrail to identify and deny.
Members
- definition
-
- Required: Yes
- Type: string
A definition of the topic to deny.
- examples
-
- Type: Array of strings
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
- name
-
- Required: Yes
- Type: string
The name of the topic to deny.
- type
-
- Required: Yes
- Type: string
Specifies to deny the topic.
GuardrailWordConfig
Description
A word to configure for the AI Guardrail.
Members
- text
-
- Required: Yes
- Type: string
Text of the word configured for the AI Guardrail to block.
HierarchicalChunkingConfiguration
Description
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
Members
- levelConfigurations
-
- Required: Yes
- Type: Array of HierarchicalChunkingLevelConfiguration structures
Token settings for each layer.
- overlapTokens
-
- Required: Yes
- Type: int
The number of tokens to repeat across chunks in the same layer.
HierarchicalChunkingLevelConfiguration
Description
Token settings for each layer.
Members
- maxTokens
-
- Required: Yes
- Type: int
The maximum number of tokens that a chunk can contain in this layer.
Highlight
Description
Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
Members
- beginOffsetInclusive
-
- Type: int
The offset for the start of the highlight.
- endOffsetExclusive
-
- Type: int
The offset for the end of the highlight.
ImportJobData
Description
Summary information about the import job.
Members
- createdTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the import job was created.
- externalSourceConfiguration
-
- Type: ExternalSourceConfiguration structure
The configuration information of the external data source.
- failedRecordReport
-
- Type: string
The link to download the information of resource data that failed to be imported.
- importJobId
-
- Required: Yes
- Type: string
The identifier of the import job.
- importJobType
-
- Required: Yes
- Type: string
The type of the import job.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- lastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the import job data was last modified.
- metadata
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
The metadata fields of the imported Amazon Q in Connect resources.
- status
-
- Required: Yes
- Type: string
The status of the import job.
- uploadId
-
- Required: Yes
- Type: string
A pointer to the uploaded asset. This value is returned by StartContentUpload.
- url
-
- Required: Yes
- Type: string
The download link to the resource file that is uploaded to the import job.
- urlExpiry
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration time of the URL as an epoch timestamp.
ImportJobSummary
Description
Summary information about the import job.
Members
- createdTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the import job was created.
- externalSourceConfiguration
-
- Type: ExternalSourceConfiguration structure
The configuration information of the external source that the resource data are imported from.
- importJobId
-
- Required: Yes
- Type: string
The identifier of the import job.
- importJobType
-
- Required: Yes
- Type: string
The type of import job.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- lastModifiedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the import job was last modified.
- metadata
-
- Type: Associative array of custom strings keys (NonEmptyString) to strings
The metadata fields of the imported Amazon Q in Connect resources.
- status
-
- Required: Yes
- Type: string
The status of the import job.
- uploadId
-
- Required: Yes
- Type: string
A pointer to the uploaded asset. This value is returned by StartContentUpload.
IntentDetectedDataDetails
Description
Details about the detected intent.
Members
- intent
-
- Required: Yes
- Type: string
The detected intent.
- intentId
-
- Required: Yes
- Type: string
The identifier of the detected intent.
IntentInputData
Description
Information about the Amazon Q intent.
Members
- intentId
-
- Required: Yes
- Type: string
The identifier of the Amazon Q intent.
KnowledgeBaseAssociationConfigurationData
Description
The data of the configuration for a KNOWLEDGE_BASE
type Amazon Q in Connect Assistant Association.
Members
- contentTagFilter
-
- Type: TagFilter structure
An object that can be used to specify Tag conditions.
- maxResults
-
- Type: int
The maximum number of results to return per page.
- overrideKnowledgeBaseSearchType
-
- Type: string
The search type to be used against the Knowledge Base for this request. The values can be
SEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw text
KnowledgeBaseAssociationData
Description
Association information about the knowledge base.
Members
- knowledgeBaseArn
-
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Type: string
The identifier of the knowledge base.
KnowledgeBaseData
Description
Information about the knowledge base.
Members
- description
-
- Type: string
The description.
- ingestionFailureReasons
-
- Type: Array of strings
List of failure reasons on ingestion per file.
- ingestionStatus
-
- Type: string
Status of ingestion on data source.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- knowledgeBaseType
-
- Required: Yes
- Type: string
The type of knowledge base.
- lastContentModificationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- renderingConfiguration
-
- Type: RenderingConfiguration structure
Information about how to render the content.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,kms:Decrypt
, andkms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
- sourceConfiguration
-
- Type: SourceConfiguration structure
Source configuration information about the knowledge base.
- status
-
- Required: Yes
- Type: string
The status of the knowledge base.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- vectorIngestionConfiguration
-
- Type: VectorIngestionConfiguration structure
Contains details about how to ingest the documents in a data source.
KnowledgeBaseSummary
Description
Summary information about the knowledge base.
Members
- description
-
- Type: string
The description of the knowledge base.
- knowledgeBaseArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the knowledge base.
- knowledgeBaseId
-
- Required: Yes
- Type: string
The identifier of the knowledge base.
- knowledgeBaseType
-
- Required: Yes
- Type: string
The type of knowledge base.
- name
-
- Required: Yes
- Type: string
The name of the knowledge base.
- renderingConfiguration
-
- Type: RenderingConfiguration structure
Information about how to render the content.
- serverSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant
,kms:DescribeKey
,kms:Decrypt
, andkms:GenerateDataKey*
permissions to the IAM identity using the key to invoke Amazon Q in Connect.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
- sourceConfiguration
-
- Type: SourceConfiguration structure
Configuration information about the external data source.
- status
-
- Required: Yes
- Type: string
The status of the knowledge base summary.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource.
- vectorIngestionConfiguration
-
- Type: VectorIngestionConfiguration structure
Contains details about how to ingest the documents in a data source.
ManagedSourceConfiguration
Description
Source configuration for managed resources.
Members
- webCrawlerConfiguration
-
- Type: WebCrawlerConfiguration structure
Configuration data for web crawler data source.
ManualSearchAIAgentConfiguration
Description
The configuration for the MANUAL_SEARCH
AI Agent type.
Members
- answerGenerationAIGuardrailId
-
- Type: string
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
- answerGenerationAIPromptId
-
- Type: string
The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
- associationConfigurations
-
- Type: Array of AssociationConfiguration structures
The association configurations for overriding behavior on this AI Agent.
MessageData
Description
The message data.
Members
- text
-
- Type: TextMessage structure
The message data in text type.
MessageInput
Description
The message input.
Members
- value
-
- Required: Yes
- Type: MessageData structure
The message input value.
MessageOutput
Description
The message output.
Members
- messageId
-
- Required: Yes
- Type: string
The identifier of a message.
- participant
-
- Required: Yes
- Type: string
The participant of a message.
- timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of a message.
- value
-
- Required: Yes
- Type: MessageData structure
The value of a message data.
MessageTemplateAttachment
Description
Information about the message template attachment.
Members
- attachmentId
-
- Required: Yes
- Type: string
The identifier of the attachment file.
- contentDisposition
-
- Required: Yes
- Type: string
The presentation information for the attachment file.
- name
-
- Required: Yes
- Type: string
The name of the attachment file being uploaded. The name should include the file extension.
- uploadedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the attachment file was uploaded.
- url
-
- Required: Yes
- Type: string
A pre-signed Amazon S3 URL that can be used to download the attachment file.
- urlExpiry
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The expiration time of the pre-signed Amazon S3 URL.
MessageTemplateAttributes
Description
The attributes that are used with the message template.
Members
- agentAttributes
-
- Type: AgentAttributes structure
The agent attributes that are used with the message template.
- customAttributes
-
- Type: Associative array of custom strings keys (MessageTemplateAttributeKey) to strings
The custom attributes that are used with the message template.
- customerProfileAttributes
-
- Type: CustomerProfileAttributes structure
The customer profile attributes that are used with the message template.
- systemAttributes
-
- Type: SystemAttributes structure
The system attributes that are used with the message template.
MessageTemplateBodyContentProvider
Description
The container of the message template body.
Members
- content
-
- Type: string
The content of the message template.
MessageTemplateContentProvider
Description
The container of message template content.