Interface QConnectClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface QConnectClient extends AwsClient
Service client for accessing Amazon Q Connect. This can be created using the staticbuilder()method.Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).
Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.
Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.
Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
activateMessageTemplate
default ActivateMessageTemplateResponse activateMessageTemplate(ActivateMessageTemplateRequest activateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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_VERSIONqualifier later to reference the version that is in active status.- Parameters:
activateMessageTemplateRequest-- Returns:
- Result of the ActivateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
activateMessageTemplate
default ActivateMessageTemplateResponse activateMessageTemplate(Consumer<ActivateMessageTemplateRequest.Builder> activateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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_VERSIONqualifier later to reference the version that is in active status.
This is a convenience which creates an instance of the
ActivateMessageTemplateRequest.Builderavoiding the need to create one manually viaActivateMessageTemplateRequest.builder()- Parameters:
activateMessageTemplateRequest- AConsumerthat will call methods onActivateMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the ActivateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIAgent
default CreateAiAgentResponse createAIAgent(CreateAiAgentRequest createAiAgentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Agent.
- Parameters:
createAiAgentRequest-- Returns:
- Result of the CreateAIAgent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIAgent
default CreateAiAgentResponse createAIAgent(Consumer<CreateAiAgentRequest.Builder> createAiAgentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Agent.
This is a convenience which creates an instance of the
CreateAiAgentRequest.Builderavoiding the need to create one manually viaCreateAiAgentRequest.builder()- Parameters:
createAiAgentRequest- AConsumerthat will call methods onCreateAiAgentRequest.Builderto create a request.- Returns:
- Result of the CreateAIAgent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIAgentVersion
default CreateAiAgentVersionResponse createAIAgentVersion(CreateAiAgentVersionRequest createAiAgentVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates and Amazon Q in Connect AI Agent version.
- Parameters:
createAiAgentVersionRequest-- Returns:
- Result of the CreateAIAgentVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIAgentVersion
default CreateAiAgentVersionResponse createAIAgentVersion(Consumer<CreateAiAgentVersionRequest.Builder> createAiAgentVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates and Amazon Q in Connect AI Agent version.
This is a convenience which creates an instance of the
CreateAiAgentVersionRequest.Builderavoiding the need to create one manually viaCreateAiAgentVersionRequest.builder()- Parameters:
createAiAgentVersionRequest- AConsumerthat will call methods onCreateAiAgentVersionRequest.Builderto create a request.- Returns:
- Result of the CreateAIAgentVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIGuardrail
default CreateAiGuardrailResponse createAIGuardrail(CreateAiGuardrailRequest createAiGuardrailRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Guardrail.
- Parameters:
createAiGuardrailRequest-- Returns:
- Result of the CreateAIGuardrail operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIGuardrail
default CreateAiGuardrailResponse createAIGuardrail(Consumer<CreateAiGuardrailRequest.Builder> createAiGuardrailRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Guardrail.
This is a convenience which creates an instance of the
CreateAiGuardrailRequest.Builderavoiding the need to create one manually viaCreateAiGuardrailRequest.builder()- Parameters:
createAiGuardrailRequest- AConsumerthat will call methods onCreateAiGuardrailRequest.Builderto create a request.- Returns:
- Result of the CreateAIGuardrail operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIGuardrailVersion
default CreateAiGuardrailVersionResponse createAIGuardrailVersion(CreateAiGuardrailVersionRequest createAiGuardrailVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Guardrail version.
- Parameters:
createAiGuardrailVersionRequest-- Returns:
- Result of the CreateAIGuardrailVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIGuardrailVersion
default CreateAiGuardrailVersionResponse createAIGuardrailVersion(Consumer<CreateAiGuardrailVersionRequest.Builder> createAiGuardrailVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Guardrail version.
This is a convenience which creates an instance of the
CreateAiGuardrailVersionRequest.Builderavoiding the need to create one manually viaCreateAiGuardrailVersionRequest.builder()- Parameters:
createAiGuardrailVersionRequest- AConsumerthat will call methods onCreateAiGuardrailVersionRequest.Builderto create a request.- Returns:
- Result of the CreateAIGuardrailVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIPrompt
default CreateAiPromptResponse createAIPrompt(CreateAiPromptRequest createAiPromptRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Prompt.
- Parameters:
createAiPromptRequest-- Returns:
- Result of the CreateAIPrompt operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIPrompt
default CreateAiPromptResponse createAIPrompt(Consumer<CreateAiPromptRequest.Builder> createAiPromptRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Prompt.
This is a convenience which creates an instance of the
CreateAiPromptRequest.Builderavoiding the need to create one manually viaCreateAiPromptRequest.builder()- Parameters:
createAiPromptRequest- AConsumerthat will call methods onCreateAiPromptRequest.Builderto create a request.- Returns:
- Result of the CreateAIPrompt operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIPromptVersion
default CreateAiPromptVersionResponse createAIPromptVersion(CreateAiPromptVersionRequest createAiPromptVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Prompt version.
- Parameters:
createAiPromptVersionRequest-- Returns:
- Result of the CreateAIPromptVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAIPromptVersion
default CreateAiPromptVersionResponse createAIPromptVersion(Consumer<CreateAiPromptVersionRequest.Builder> createAiPromptVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect AI Prompt version.
This is a convenience which creates an instance of the
CreateAiPromptVersionRequest.Builderavoiding the need to create one manually viaCreateAiPromptVersionRequest.builder()- Parameters:
createAiPromptVersionRequest- AConsumerthat will call methods onCreateAiPromptVersionRequest.Builderto create a request.- Returns:
- Result of the CreateAIPromptVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAssistant
default CreateAssistantResponse createAssistant(CreateAssistantRequest createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect assistant.
- Parameters:
createAssistantRequest-- Returns:
- Result of the CreateAssistant operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAssistant
default CreateAssistantResponse createAssistant(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect assistant.
This is a convenience which creates an instance of the
CreateAssistantRequest.Builderavoiding the need to create one manually viaCreateAssistantRequest.builder()- Parameters:
createAssistantRequest- AConsumerthat will call methods onCreateAssistantRequest.Builderto create a request.- Returns:
- Result of the CreateAssistant operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
createAssistantAssociationRequest-- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
CreateAssistantAssociationRequest.Builderavoiding the need to create one manually viaCreateAssistantAssociationRequest.builder()- Parameters:
createAssistantAssociationRequest- AConsumerthat will call methods onCreateAssistantAssociationRequest.Builderto create a request.- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createContent
default CreateContentResponse createContent(CreateContentRequest createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
- Parameters:
createContentRequest-- Returns:
- Result of the CreateContent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createContent
default CreateContentResponse createContent(Consumer<CreateContentRequest.Builder> createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
This is a convenience which creates an instance of the
CreateContentRequest.Builderavoiding the need to create one manually viaCreateContentRequest.builder()- Parameters:
createContentRequest- AConsumerthat will call methods onCreateContentRequest.Builderto create a request.- Returns:
- Result of the CreateContent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createContentAssociation
default CreateContentAssociationResponse createContentAssociation(CreateContentAssociationRequest createContentAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
createContentAssociationRequest-- Returns:
- Result of the CreateContentAssociation operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createContentAssociation
default CreateContentAssociationResponse createContentAssociation(Consumer<CreateContentAssociationRequest.Builder> createContentAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
CreateContentAssociationRequest.Builderavoiding the need to create one manually viaCreateContentAssociationRequest.builder()- Parameters:
createContentAssociationRequest- AConsumerthat will call methods onCreateContentAssociationRequest.Builderto create a request.- Returns:
- Result of the CreateContentAssociation operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
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
InvalidRequestExceptionerror.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.
- Parameters:
createKnowledgeBaseRequest-- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
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
InvalidRequestExceptionerror.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.
This is a convenience which creates an instance of the
CreateKnowledgeBaseRequest.Builderavoiding the need to create one manually viaCreateKnowledgeBaseRequest.builder()- Parameters:
createKnowledgeBaseRequest- AConsumerthat will call methods onCreateKnowledgeBaseRequest.Builderto create a request.- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createMessageTemplate
default CreateMessageTemplateResponse createMessageTemplate(CreateMessageTemplateRequest createMessageTemplateRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier to reference the created message template.- Parameters:
createMessageTemplateRequest-- Returns:
- Result of the CreateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMessageTemplate
default CreateMessageTemplateResponse createMessageTemplate(Consumer<CreateMessageTemplateRequest.Builder> createMessageTemplateRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier to reference the created message template.
This is a convenience which creates an instance of the
CreateMessageTemplateRequest.Builderavoiding the need to create one manually viaCreateMessageTemplateRequest.builder()- Parameters:
createMessageTemplateRequest- AConsumerthat will call methods onCreateMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMessageTemplateAttachment
default CreateMessageTemplateAttachmentResponse createMessageTemplateAttachment(CreateMessageTemplateAttachmentRequest createMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier. 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.- Parameters:
createMessageTemplateAttachmentRequest-- Returns:
- Result of the CreateMessageTemplateAttachment operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMessageTemplateAttachment
default CreateMessageTemplateAttachmentResponse createMessageTemplateAttachment(Consumer<CreateMessageTemplateAttachmentRequest.Builder> createMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier. 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.
This is a convenience which creates an instance of the
CreateMessageTemplateAttachmentRequest.Builderavoiding the need to create one manually viaCreateMessageTemplateAttachmentRequest.builder()- Parameters:
createMessageTemplateAttachmentRequest- AConsumerthat will call methods onCreateMessageTemplateAttachmentRequest.Builderto create a request.- Returns:
- Result of the CreateMessageTemplateAttachment operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMessageTemplateVersion
default CreateMessageTemplateVersionResponse createMessageTemplateVersion(CreateMessageTemplateVersionRequest createMessageTemplateVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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 suppliedmessageTemplateContentSha256is different from themessageTemplateContentSha256of the message template with$LATESTqualifier. If multipleCreateMessageTemplateVersionrequests 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.- Parameters:
createMessageTemplateVersionRequest-- Returns:
- Result of the CreateMessageTemplateVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createMessageTemplateVersion
default CreateMessageTemplateVersionResponse createMessageTemplateVersion(Consumer<CreateMessageTemplateVersionRequest.Builder> createMessageTemplateVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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 suppliedmessageTemplateContentSha256is different from themessageTemplateContentSha256of the message template with$LATESTqualifier. If multipleCreateMessageTemplateVersionrequests 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.
This is a convenience which creates an instance of the
CreateMessageTemplateVersionRequest.Builderavoiding the need to create one manually viaCreateMessageTemplateVersionRequest.builder()- Parameters:
createMessageTemplateVersionRequest- AConsumerthat will call methods onCreateMessageTemplateVersionRequest.Builderto create a request.- Returns:
- Result of the CreateMessageTemplateVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createQuickResponse
default CreateQuickResponseResponse createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect quick response.
- Parameters:
createQuickResponseRequest-- Returns:
- Result of the CreateQuickResponse operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createQuickResponse
default CreateQuickResponseResponse createQuickResponse(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Creates an Amazon Q in Connect quick response.
This is a convenience which creates an instance of the
CreateQuickResponseRequest.Builderavoiding the need to create one manually viaCreateQuickResponseRequest.builder()- Parameters:
createQuickResponseRequest- AConsumerthat will call methods onCreateQuickResponseRequest.Builderto create a request.- Returns:
- Result of the CreateQuickResponse operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createSession
default CreateSessionResponse createSession(CreateSessionRequest createSessionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
createSessionRequest-- Returns:
- Result of the CreateSession operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createSession
default CreateSessionResponse createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
CreateSessionRequest.Builderavoiding the need to create one manually viaCreateSessionRequest.builder()- Parameters:
createSessionRequest- AConsumerthat will call methods onCreateSessionRequest.Builderto create a request.- Returns:
- Result of the CreateSession operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deactivateMessageTemplate
default DeactivateMessageTemplateResponse deactivateMessageTemplate(DeactivateMessageTemplateRequest deactivateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the
$ACTIVE_VERSIONqualifier to reference the version in active status.- Parameters:
deactivateMessageTemplateRequest-- Returns:
- Result of the DeactivateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deactivateMessageTemplate
default DeactivateMessageTemplateResponse deactivateMessageTemplate(Consumer<DeactivateMessageTemplateRequest.Builder> deactivateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the
$ACTIVE_VERSIONqualifier to reference the version in active status.
This is a convenience which creates an instance of the
DeactivateMessageTemplateRequest.Builderavoiding the need to create one manually viaDeactivateMessageTemplateRequest.builder()- Parameters:
deactivateMessageTemplateRequest- AConsumerthat will call methods onDeactivateMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the DeactivateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIAgent
default DeleteAiAgentResponse deleteAIAgent(DeleteAiAgentRequest deleteAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Agent.
- Parameters:
deleteAiAgentRequest-- Returns:
- Result of the DeleteAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIAgent
default DeleteAiAgentResponse deleteAIAgent(Consumer<DeleteAiAgentRequest.Builder> deleteAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Agent.
This is a convenience which creates an instance of the
DeleteAiAgentRequest.Builderavoiding the need to create one manually viaDeleteAiAgentRequest.builder()- Parameters:
deleteAiAgentRequest- AConsumerthat will call methods onDeleteAiAgentRequest.Builderto create a request.- Returns:
- Result of the DeleteAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIAgentVersion
default DeleteAiAgentVersionResponse deleteAIAgentVersion(DeleteAiAgentVersionRequest deleteAiAgentVersionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Agent Version.
- Parameters:
deleteAiAgentVersionRequest-- Returns:
- Result of the DeleteAIAgentVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIAgentVersion
default DeleteAiAgentVersionResponse deleteAIAgentVersion(Consumer<DeleteAiAgentVersionRequest.Builder> deleteAiAgentVersionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Agent Version.
This is a convenience which creates an instance of the
DeleteAiAgentVersionRequest.Builderavoiding the need to create one manually viaDeleteAiAgentVersionRequest.builder()- Parameters:
deleteAiAgentVersionRequest- AConsumerthat will call methods onDeleteAiAgentVersionRequest.Builderto create a request.- Returns:
- Result of the DeleteAIAgentVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIGuardrail
default DeleteAiGuardrailResponse deleteAIGuardrail(DeleteAiGuardrailRequest deleteAiGuardrailRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Guardrail.
- Parameters:
deleteAiGuardrailRequest-- Returns:
- Result of the DeleteAIGuardrail operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIGuardrail
default DeleteAiGuardrailResponse deleteAIGuardrail(Consumer<DeleteAiGuardrailRequest.Builder> deleteAiGuardrailRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Guardrail.
This is a convenience which creates an instance of the
DeleteAiGuardrailRequest.Builderavoiding the need to create one manually viaDeleteAiGuardrailRequest.builder()- Parameters:
deleteAiGuardrailRequest- AConsumerthat will call methods onDeleteAiGuardrailRequest.Builderto create a request.- Returns:
- Result of the DeleteAIGuardrail operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIGuardrailVersion
default DeleteAiGuardrailVersionResponse deleteAIGuardrailVersion(DeleteAiGuardrailVersionRequest deleteAiGuardrailVersionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Delete and Amazon Q in Connect AI Guardrail version.
- Parameters:
deleteAiGuardrailVersionRequest-- Returns:
- Result of the DeleteAIGuardrailVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIGuardrailVersion
default DeleteAiGuardrailVersionResponse deleteAIGuardrailVersion(Consumer<DeleteAiGuardrailVersionRequest.Builder> deleteAiGuardrailVersionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Delete and Amazon Q in Connect AI Guardrail version.
This is a convenience which creates an instance of the
DeleteAiGuardrailVersionRequest.Builderavoiding the need to create one manually viaDeleteAiGuardrailVersionRequest.builder()- Parameters:
deleteAiGuardrailVersionRequest- AConsumerthat will call methods onDeleteAiGuardrailVersionRequest.Builderto create a request.- Returns:
- Result of the DeleteAIGuardrailVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIPrompt
default DeleteAiPromptResponse deleteAIPrompt(DeleteAiPromptRequest deleteAiPromptRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Prompt.
- Parameters:
deleteAiPromptRequest-- Returns:
- Result of the DeleteAIPrompt operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIPrompt
default DeleteAiPromptResponse deleteAIPrompt(Consumer<DeleteAiPromptRequest.Builder> deleteAiPromptRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes an Amazon Q in Connect AI Prompt.
This is a convenience which creates an instance of the
DeleteAiPromptRequest.Builderavoiding the need to create one manually viaDeleteAiPromptRequest.builder()- Parameters:
deleteAiPromptRequest- AConsumerthat will call methods onDeleteAiPromptRequest.Builderto create a request.- Returns:
- Result of the DeleteAIPrompt operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIPromptVersion
default DeleteAiPromptVersionResponse deleteAIPromptVersion(DeleteAiPromptVersionRequest deleteAiPromptVersionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Delete and Amazon Q in Connect AI Prompt version.
- Parameters:
deleteAiPromptVersionRequest-- Returns:
- Result of the DeleteAIPromptVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAIPromptVersion
default DeleteAiPromptVersionResponse deleteAIPromptVersion(Consumer<DeleteAiPromptVersionRequest.Builder> deleteAiPromptVersionRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Delete and Amazon Q in Connect AI Prompt version.
This is a convenience which creates an instance of the
DeleteAiPromptVersionRequest.Builderavoiding the need to create one manually viaDeleteAiPromptVersionRequest.builder()- Parameters:
deleteAiPromptVersionRequest- AConsumerthat will call methods onDeleteAiPromptVersionRequest.Builderto create a request.- Returns:
- Result of the DeleteAIPromptVersion operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(DeleteAssistantRequest deleteAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes an assistant.
- Parameters:
deleteAssistantRequest-- Returns:
- Result of the DeleteAssistant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes an assistant.
This is a convenience which creates an instance of the
DeleteAssistantRequest.Builderavoiding the need to create one manually viaDeleteAssistantRequest.builder()- Parameters:
deleteAssistantRequest- AConsumerthat will call methods onDeleteAssistantRequest.Builderto create a request.- Returns:
- Result of the DeleteAssistant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes an assistant association.
- Parameters:
deleteAssistantAssociationRequest-- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes an assistant association.
This is a convenience which creates an instance of the
DeleteAssistantAssociationRequest.Builderavoiding the need to create one manually viaDeleteAssistantAssociationRequest.builder()- Parameters:
deleteAssistantAssociationRequest- AConsumerthat will call methods onDeleteAssistantAssociationRequest.Builderto create a request.- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContent
default DeleteContentResponse deleteContent(DeleteContentRequest deleteContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes the content.
- Parameters:
deleteContentRequest-- Returns:
- Result of the DeleteContent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContent
default DeleteContentResponse deleteContent(Consumer<DeleteContentRequest.Builder> deleteContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes the content.
This is a convenience which creates an instance of the
DeleteContentRequest.Builderavoiding the need to create one manually viaDeleteContentRequest.builder()- Parameters:
deleteContentRequest- AConsumerthat will call methods onDeleteContentRequest.Builderto create a request.- Returns:
- Result of the DeleteContent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContentAssociation
default DeleteContentAssociationResponse deleteContentAssociation(DeleteContentAssociationRequest deleteContentAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
deleteContentAssociationRequest-- Returns:
- Result of the DeleteContentAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContentAssociation
default DeleteContentAssociationResponse deleteContentAssociation(Consumer<DeleteContentAssociationRequest.Builder> deleteContentAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
DeleteContentAssociationRequest.Builderavoiding the need to create one manually viaDeleteContentAssociationRequest.builder()- Parameters:
deleteContentAssociationRequest- AConsumerthat will call methods onDeleteContentAssociationRequest.Builderto create a request.- Returns:
- Result of the DeleteContentAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImportJob
default DeleteImportJobResponse deleteImportJob(DeleteImportJobRequest deleteImportJobRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes the quick response import job.
- Parameters:
deleteImportJobRequest-- Returns:
- Result of the DeleteImportJob operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteImportJob
default DeleteImportJobResponse deleteImportJob(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes the quick response import job.
This is a convenience which creates an instance of the
DeleteImportJobRequest.Builderavoiding the need to create one manually viaDeleteImportJobRequest.builder()- Parameters:
deleteImportJobRequest- AConsumerthat will call methods onDeleteImportJobRequest.Builderto create a request.- Returns:
- Result of the DeleteImportJob operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
deleteKnowledgeBaseRequest-- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
DeleteKnowledgeBaseRequest.Builderavoiding the need to create one manually viaDeleteKnowledgeBaseRequest.builder()- Parameters:
deleteKnowledgeBaseRequest- AConsumerthat will call methods onDeleteKnowledgeBaseRequest.Builderto create a request.- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMessageTemplate
default DeleteMessageTemplateResponse deleteMessageTemplate(DeleteMessageTemplateRequest deleteMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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.- Parameters:
deleteMessageTemplateRequest-- Returns:
- Result of the DeleteMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMessageTemplate
default DeleteMessageTemplateResponse deleteMessageTemplate(Consumer<DeleteMessageTemplateRequest.Builder> deleteMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
DeleteMessageTemplateRequest.Builderavoiding the need to create one manually viaDeleteMessageTemplateRequest.builder()- Parameters:
deleteMessageTemplateRequest- AConsumerthat will call methods onDeleteMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMessageTemplateAttachment
default DeleteMessageTemplateAttachmentResponse deleteMessageTemplateAttachment(DeleteMessageTemplateAttachmentRequest deleteMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes the attachment file from the Amazon Q in Connect message template that is referenced by
$LATESTqualifier. Attachments on available message template versions will remain unchanged.- Parameters:
deleteMessageTemplateAttachmentRequest-- Returns:
- Result of the DeleteMessageTemplateAttachment operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteMessageTemplateAttachment
default DeleteMessageTemplateAttachmentResponse deleteMessageTemplateAttachment(Consumer<DeleteMessageTemplateAttachmentRequest.Builder> deleteMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Deletes the attachment file from the Amazon Q in Connect message template that is referenced by
$LATESTqualifier. Attachments on available message template versions will remain unchanged.
This is a convenience which creates an instance of the
DeleteMessageTemplateAttachmentRequest.Builderavoiding the need to create one manually viaDeleteMessageTemplateAttachmentRequest.builder()- Parameters:
deleteMessageTemplateAttachmentRequest- AConsumerthat will call methods onDeleteMessageTemplateAttachmentRequest.Builderto create a request.- Returns:
- Result of the DeleteMessageTemplateAttachment operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteQuickResponse
default DeleteQuickResponseResponse deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes a quick response.
- Parameters:
deleteQuickResponseRequest-- Returns:
- Result of the DeleteQuickResponse operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteQuickResponse
default DeleteQuickResponseResponse deleteQuickResponse(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deletes a quick response.
This is a convenience which creates an instance of the
DeleteQuickResponseRequest.Builderavoiding the need to create one manually viaDeleteQuickResponseRequest.builder()- Parameters:
deleteQuickResponseRequest- AConsumerthat will call methods onDeleteQuickResponseRequest.Builderto create a request.- Returns:
- Result of the DeleteQuickResponse operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAIAgent
default GetAiAgentResponse getAIAgent(GetAiAgentRequest getAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Gets an Amazon Q in Connect AI Agent.
- Parameters:
getAiAgentRequest-- Returns:
- Result of the GetAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAIAgent
default GetAiAgentResponse getAIAgent(Consumer<GetAiAgentRequest.Builder> getAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Gets an Amazon Q in Connect AI Agent.
This is a convenience which creates an instance of the
GetAiAgentRequest.Builderavoiding the need to create one manually viaGetAiAgentRequest.builder()- Parameters:
getAiAgentRequest- AConsumerthat will call methods onGetAiAgentRequest.Builderto create a request.- Returns:
- Result of the GetAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAIGuardrail
default GetAiGuardrailResponse getAIGuardrail(GetAiGuardrailRequest getAiGuardrailRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Gets the Amazon Q in Connect AI Guardrail.
- Parameters:
getAiGuardrailRequest-- Returns:
- Result of the GetAIGuardrail operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAIGuardrail
default GetAiGuardrailResponse getAIGuardrail(Consumer<GetAiGuardrailRequest.Builder> getAiGuardrailRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Gets the Amazon Q in Connect AI Guardrail.
This is a convenience which creates an instance of the
GetAiGuardrailRequest.Builderavoiding the need to create one manually viaGetAiGuardrailRequest.builder()- Parameters:
getAiGuardrailRequest- AConsumerthat will call methods onGetAiGuardrailRequest.Builderto create a request.- Returns:
- Result of the GetAIGuardrail operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAIPrompt
default GetAiPromptResponse getAIPrompt(GetAiPromptRequest getAiPromptRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Gets and Amazon Q in Connect AI Prompt.
- Parameters:
getAiPromptRequest-- Returns:
- Result of the GetAIPrompt operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAIPrompt
default GetAiPromptResponse getAIPrompt(Consumer<GetAiPromptRequest.Builder> getAiPromptRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Gets and Amazon Q in Connect AI Prompt.
This is a convenience which creates an instance of the
GetAiPromptRequest.Builderavoiding the need to create one manually viaGetAiPromptRequest.builder()- Parameters:
getAiPromptRequest- AConsumerthat will call methods onGetAiPromptRequest.Builderto create a request.- Returns:
- Result of the GetAIPrompt operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistant
default GetAssistantResponse getAssistant(GetAssistantRequest getAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information about an assistant.
- Parameters:
getAssistantRequest-- Returns:
- Result of the GetAssistant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistant
default GetAssistantResponse getAssistant(Consumer<GetAssistantRequest.Builder> getAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information about an assistant.
This is a convenience which creates an instance of the
GetAssistantRequest.Builderavoiding the need to create one manually viaGetAssistantRequest.builder()- Parameters:
getAssistantRequest- AConsumerthat will call methods onGetAssistantRequest.Builderto create a request.- Returns:
- Result of the GetAssistant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information about an assistant association.
- Parameters:
getAssistantAssociationRequest-- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information about an assistant association.
This is a convenience which creates an instance of the
GetAssistantAssociationRequest.Builderavoiding the need to create one manually viaGetAssistantAssociationRequest.builder()- Parameters:
getAssistantAssociationRequest- AConsumerthat will call methods onGetAssistantAssociationRequest.Builderto create a request.- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContent
default GetContentResponse getContent(GetContentRequest getContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves content, including a pre-signed URL to download the content.
- Parameters:
getContentRequest-- Returns:
- Result of the GetContent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContent
default GetContentResponse getContent(Consumer<GetContentRequest.Builder> getContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves content, including a pre-signed URL to download the content.
This is a convenience which creates an instance of the
GetContentRequest.Builderavoiding the need to create one manually viaGetContentRequest.builder()- Parameters:
getContentRequest- AConsumerthat will call methods onGetContentRequest.Builderto create a request.- Returns:
- Result of the GetContent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContentAssociation
default GetContentAssociationResponse getContentAssociation(GetContentAssociationRequest getContentAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
getContentAssociationRequest-- Returns:
- Result of the GetContentAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContentAssociation
default GetContentAssociationResponse getContentAssociation(Consumer<GetContentAssociationRequest.Builder> getContentAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
GetContentAssociationRequest.Builderavoiding the need to create one manually viaGetContentAssociationRequest.builder()- Parameters:
getContentAssociationRequest- AConsumerthat will call methods onGetContentAssociationRequest.Builderto create a request.- Returns:
- Result of the GetContentAssociation operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContentSummary
default GetContentSummaryResponse getContentSummary(GetContentSummaryRequest getContentSummaryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves summary information about the content.
- Parameters:
getContentSummaryRequest-- Returns:
- Result of the GetContentSummary operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContentSummary
default GetContentSummaryResponse getContentSummary(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves summary information about the content.
This is a convenience which creates an instance of the
GetContentSummaryRequest.Builderavoiding the need to create one manually viaGetContentSummaryRequest.builder()- Parameters:
getContentSummaryRequest- AConsumerthat will call methods onGetContentSummaryRequest.Builderto create a request.- Returns:
- Result of the GetContentSummary operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getImportJob
default GetImportJobResponse getImportJob(GetImportJobRequest getImportJobRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves the started import job.
- Parameters:
getImportJobRequest-- Returns:
- Result of the GetImportJob operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getImportJob
default GetImportJobResponse getImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves the started import job.
This is a convenience which creates an instance of the
GetImportJobRequest.Builderavoiding the need to create one manually viaGetImportJobRequest.builder()- Parameters:
getImportJobRequest- AConsumerthat will call methods onGetImportJobRequest.Builderto create a request.- Returns:
- Result of the GetImportJob operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information about the knowledge base.
- Parameters:
getKnowledgeBaseRequest-- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information about the knowledge base.
This is a convenience which creates an instance of the
GetKnowledgeBaseRequest.Builderavoiding the need to create one manually viaGetKnowledgeBaseRequest.builder()- Parameters:
getKnowledgeBaseRequest- AConsumerthat will call methods onGetKnowledgeBaseRequest.Builderto create a request.- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMessageTemplate
default GetMessageTemplateResponse getMessageTemplate(GetMessageTemplateRequest getMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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$LATESTis assumed implicitly.- Parameters:
getMessageTemplateRequest-- Returns:
- Result of the GetMessageTemplate operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getMessageTemplate
default GetMessageTemplateResponse getMessageTemplate(Consumer<GetMessageTemplateRequest.Builder> getMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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$LATESTis assumed implicitly.
This is a convenience which creates an instance of the
GetMessageTemplateRequest.Builderavoiding the need to create one manually viaGetMessageTemplateRequest.builder()- Parameters:
getMessageTemplateRequest- AConsumerthat will call methods onGetMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the GetMessageTemplate operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getNextMessage
default GetNextMessageResponse getNextMessage(GetNextMessageRequest getNextMessageRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves next message on an Amazon Q in Connect session.
- Parameters:
getNextMessageRequest-- Returns:
- Result of the GetNextMessage operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getNextMessage
default GetNextMessageResponse getNextMessage(Consumer<GetNextMessageRequest.Builder> getNextMessageRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves next message on an Amazon Q in Connect session.
This is a convenience which creates an instance of the
GetNextMessageRequest.Builderavoiding the need to create one manually viaGetNextMessageRequest.builder()- Parameters:
getNextMessageRequest- AConsumerthat will call methods onGetNextMessageRequest.Builderto create a request.- Returns:
- Result of the GetNextMessage operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getQuickResponse
default GetQuickResponseResponse getQuickResponse(GetQuickResponseRequest getQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves the quick response.
- Parameters:
getQuickResponseRequest-- Returns:
- Result of the GetQuickResponse operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getQuickResponse
default GetQuickResponseResponse getQuickResponse(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves the quick response.
This is a convenience which creates an instance of the
GetQuickResponseRequest.Builderavoiding the need to create one manually viaGetQuickResponseRequest.builder()- Parameters:
getQuickResponseRequest- AConsumerthat will call methods onGetQuickResponseRequest.Builderto create a request.- Returns:
- Result of the GetQuickResponse operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendations
@Deprecated default GetRecommendationsResponse getRecommendations(GetRecommendationsRequest getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deprecated.GetRecommendations 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 Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.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
waitTimeSecondsparameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.- Parameters:
getRecommendationsRequest-- Returns:
- Result of the GetRecommendations operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendations
@Deprecated default GetRecommendationsResponse getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deprecated.GetRecommendations 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 Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.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
waitTimeSecondsparameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
This is a convenience which creates an instance of the
GetRecommendationsRequest.Builderavoiding the need to create one manually viaGetRecommendationsRequest.builder()- Parameters:
getRecommendationsRequest- AConsumerthat will call methods onGetRecommendationsRequest.Builderto create a request.- Returns:
- Result of the GetRecommendations operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSession
default GetSessionResponse getSession(GetSessionRequest getSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information for a specified session.
- Parameters:
getSessionRequest-- Returns:
- Result of the GetSession operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getSession
default GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Retrieves information for a specified session.
This is a convenience which creates an instance of the
GetSessionRequest.Builderavoiding the need to create one manually viaGetSessionRequest.builder()- Parameters:
getSessionRequest- AConsumerthat will call methods onGetSessionRequest.Builderto create a request.- Returns:
- Result of the GetSession operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgentVersions
default ListAiAgentVersionsResponse listAIAgentVersions(ListAiAgentVersionsRequest listAiAgentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
List AI Agent versions.
- Parameters:
listAiAgentVersionsRequest-- Returns:
- Result of the ListAIAgentVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgentVersions
default ListAiAgentVersionsResponse listAIAgentVersions(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
List AI Agent versions.
This is a convenience which creates an instance of the
ListAiAgentVersionsRequest.Builderavoiding the need to create one manually viaListAiAgentVersionsRequest.builder()- Parameters:
listAiAgentVersionsRequest- AConsumerthat will call methods onListAiAgentVersionsRequest.Builderto create a request.- Returns:
- Result of the ListAIAgentVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgentVersionsPaginator
default ListAIAgentVersionsIterable listAIAgentVersionsPaginator(ListAiAgentVersionsRequest listAiAgentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client .listAIAgentVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)operation.- Parameters:
listAiAgentVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgentVersionsPaginator
default ListAIAgentVersionsIterable listAIAgentVersionsPaginator(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client .listAIAgentVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)operation.
This is a convenience which creates an instance of the
ListAiAgentVersionsRequest.Builderavoiding the need to create one manually viaListAiAgentVersionsRequest.builder()- Parameters:
listAiAgentVersionsRequest- AConsumerthat will call methods onListAiAgentVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgents
default ListAiAgentsResponse listAIAgents(ListAiAgentsRequest listAiAgentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists AI Agents.
- Parameters:
listAiAgentsRequest-- Returns:
- Result of the ListAIAgents operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgents
default ListAiAgentsResponse listAIAgents(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists AI Agents.
This is a convenience which creates an instance of the
ListAiAgentsRequest.Builderavoiding the need to create one manually viaListAiAgentsRequest.builder()- Parameters:
listAiAgentsRequest- AConsumerthat will call methods onListAiAgentsRequest.Builderto create a request.- Returns:
- Result of the ListAIAgents operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgentsPaginator
default ListAIAgentsIterable listAIAgentsPaginator(ListAiAgentsRequest listAiAgentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)operation.- Parameters:
listAiAgentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIAgentsPaginator
default ListAIAgentsIterable listAIAgentsPaginator(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)operation.
This is a convenience which creates an instance of the
ListAiAgentsRequest.Builderavoiding the need to create one manually viaListAiAgentsRequest.builder()- Parameters:
listAiAgentsRequest- AConsumerthat will call methods onListAiAgentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrailVersions
default ListAiGuardrailVersionsResponse listAIGuardrailVersions(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists AI Guardrail versions.
- Parameters:
listAiGuardrailVersionsRequest-- Returns:
- Result of the ListAIGuardrailVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrailVersions
default ListAiGuardrailVersionsResponse listAIGuardrailVersions(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists AI Guardrail versions.
This is a convenience which creates an instance of the
ListAiGuardrailVersionsRequest.Builderavoiding the need to create one manually viaListAiGuardrailVersionsRequest.builder()- Parameters:
listAiGuardrailVersionsRequest- AConsumerthat will call methods onListAiGuardrailVersionsRequest.Builderto create a request.- Returns:
- Result of the ListAIGuardrailVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrailVersionsPaginator
default ListAIGuardrailVersionsIterable listAIGuardrailVersionsPaginator(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client .listAIGuardrailVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)operation.- Parameters:
listAiGuardrailVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrailVersionsPaginator
default ListAIGuardrailVersionsIterable listAIGuardrailVersionsPaginator(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client .listAIGuardrailVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)operation.
This is a convenience which creates an instance of the
ListAiGuardrailVersionsRequest.Builderavoiding the need to create one manually viaListAiGuardrailVersionsRequest.builder()- Parameters:
listAiGuardrailVersionsRequest- AConsumerthat will call methods onListAiGuardrailVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrails
default ListAiGuardrailsResponse listAIGuardrails(ListAiGuardrailsRequest listAiGuardrailsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists the AI Guardrails available on the Amazon Q in Connect assistant.
- Parameters:
listAiGuardrailsRequest-- Returns:
- Result of the ListAIGuardrails operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrails
default ListAiGuardrailsResponse listAIGuardrails(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists the AI Guardrails available on the Amazon Q in Connect assistant.
This is a convenience which creates an instance of the
ListAiGuardrailsRequest.Builderavoiding the need to create one manually viaListAiGuardrailsRequest.builder()- Parameters:
listAiGuardrailsRequest- AConsumerthat will call methods onListAiGuardrailsRequest.Builderto create a request.- Returns:
- Result of the ListAIGuardrails operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrailsPaginator
default ListAIGuardrailsIterable listAIGuardrailsPaginator(ListAiGuardrailsRequest listAiGuardrailsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client .listAIGuardrailsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)operation.- Parameters:
listAiGuardrailsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIGuardrailsPaginator
default ListAIGuardrailsIterable listAIGuardrailsPaginator(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client .listAIGuardrailsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)operation.
This is a convenience which creates an instance of the
ListAiGuardrailsRequest.Builderavoiding the need to create one manually viaListAiGuardrailsRequest.builder()- Parameters:
listAiGuardrailsRequest- AConsumerthat will call methods onListAiGuardrailsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPromptVersions
default ListAiPromptVersionsResponse listAIPromptVersions(ListAiPromptVersionsRequest listAiPromptVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists AI Prompt versions.
- Parameters:
listAiPromptVersionsRequest-- Returns:
- Result of the ListAIPromptVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPromptVersions
default ListAiPromptVersionsResponse listAIPromptVersions(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists AI Prompt versions.
This is a convenience which creates an instance of the
ListAiPromptVersionsRequest.Builderavoiding the need to create one manually viaListAiPromptVersionsRequest.builder()- Parameters:
listAiPromptVersionsRequest- AConsumerthat will call methods onListAiPromptVersionsRequest.Builderto create a request.- Returns:
- Result of the ListAIPromptVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPromptVersionsPaginator
default ListAIPromptVersionsIterable listAIPromptVersionsPaginator(ListAiPromptVersionsRequest listAiPromptVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client .listAIPromptVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)operation.- Parameters:
listAiPromptVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPromptVersionsPaginator
default ListAIPromptVersionsIterable listAIPromptVersionsPaginator(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client .listAIPromptVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)operation.
This is a convenience which creates an instance of the
ListAiPromptVersionsRequest.Builderavoiding the need to create one manually viaListAiPromptVersionsRequest.builder()- Parameters:
listAiPromptVersionsRequest- AConsumerthat will call methods onListAiPromptVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPrompts
default ListAiPromptsResponse listAIPrompts(ListAiPromptsRequest listAiPromptsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists the AI Prompts available on the Amazon Q in Connect assistant.
- Parameters:
listAiPromptsRequest-- Returns:
- Result of the ListAIPrompts operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPrompts
default ListAiPromptsResponse listAIPrompts(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists the AI Prompts available on the Amazon Q in Connect assistant.
This is a convenience which creates an instance of the
ListAiPromptsRequest.Builderavoiding the need to create one manually viaListAiPromptsRequest.builder()- Parameters:
listAiPromptsRequest- AConsumerthat will call methods onListAiPromptsRequest.Builderto create a request.- Returns:
- Result of the ListAIPrompts operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPromptsPaginator
default ListAIPromptsIterable listAIPromptsPaginator(ListAiPromptsRequest listAiPromptsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)operation.- Parameters:
listAiPromptsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAIPromptsPaginator
default ListAIPromptsIterable listAIPromptsPaginator(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)operation.
This is a convenience which creates an instance of the
ListAiPromptsRequest.Builderavoiding the need to create one manually viaListAiPromptsRequest.builder()- Parameters:
listAiPromptsRequest- AConsumerthat will call methods onListAiPromptsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists information about assistant associations.
- Parameters:
listAssistantAssociationsRequest-- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists information about assistant associations.
This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builderavoiding the need to create one manually viaListAssistantAssociationsRequest.builder()- Parameters:
listAssistantAssociationsRequest- AConsumerthat will call methods onListAssistantAssociationsRequest.Builderto create a request.- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)operation.- Parameters:
listAssistantAssociationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)operation.
This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builderavoiding the need to create one manually viaListAssistantAssociationsRequest.builder()- Parameters:
listAssistantAssociationsRequest- AConsumerthat will call methods onListAssistantAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistants
default ListAssistantsResponse listAssistants(ListAssistantsRequest listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Lists information about assistants.
- Parameters:
listAssistantsRequest-- Returns:
- Result of the ListAssistants operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistants
default ListAssistantsResponse listAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Lists information about assistants.
This is a convenience which creates an instance of the
ListAssistantsRequest.Builderavoiding the need to create one manually viaListAssistantsRequest.builder()- Parameters:
listAssistantsRequest- AConsumerthat will call methods onListAssistantsRequest.Builderto create a request.- Returns:
- Result of the ListAssistants operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(ListAssistantsRequest listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client .listAssistantsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)operation.- Parameters:
listAssistantsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client .listAssistantsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)operation.
This is a convenience which creates an instance of the
ListAssistantsRequest.Builderavoiding the need to create one manually viaListAssistantsRequest.builder()- Parameters:
listAssistantsRequest- AConsumerthat will call methods onListAssistantsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContentAssociations
default ListContentAssociationsResponse listContentAssociations(ListContentAssociationsRequest listContentAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
listContentAssociationsRequest-- Returns:
- Result of the ListContentAssociations operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContentAssociations
default ListContentAssociationsResponse listContentAssociations(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
ListContentAssociationsRequest.Builderavoiding the need to create one manually viaListContentAssociationsRequest.builder()- Parameters:
listContentAssociationsRequest- AConsumerthat will call methods onListContentAssociationsRequest.Builderto create a request.- Returns:
- Result of the ListContentAssociations operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContentAssociationsPaginator
default ListContentAssociationsIterable listContentAssociationsPaginator(ListContentAssociationsRequest listContentAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client .listContentAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)operation.- Parameters:
listContentAssociationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContentAssociationsPaginator
default ListContentAssociationsIterable listContentAssociationsPaginator(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client .listContentAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)operation.
This is a convenience which creates an instance of the
ListContentAssociationsRequest.Builderavoiding the need to create one manually viaListContentAssociationsRequest.builder()- Parameters:
listContentAssociationsRequest- AConsumerthat will call methods onListContentAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContents
default ListContentsResponse listContents(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists the content.
- Parameters:
listContentsRequest-- Returns:
- Result of the ListContents operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContents
default ListContentsResponse listContents(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists the content.
This is a convenience which creates an instance of the
ListContentsRequest.Builderavoiding the need to create one manually viaListContentsRequest.builder()- Parameters:
listContentsRequest- AConsumerthat will call methods onListContentsRequest.Builderto create a request.- Returns:
- Result of the ListContents operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)operation.- Parameters:
listContentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)operation.
This is a convenience which creates an instance of the
ListContentsRequest.Builderavoiding the need to create one manually viaListContentsRequest.builder()- Parameters:
listContentsRequest- AConsumerthat will call methods onListContentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImportJobs
default ListImportJobsResponse listImportJobs(ListImportJobsRequest listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Lists information about import jobs.
- Parameters:
listImportJobsRequest-- Returns:
- Result of the ListImportJobs operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImportJobs
default ListImportJobsResponse listImportJobs(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Lists information about import jobs.
This is a convenience which creates an instance of the
ListImportJobsRequest.Builderavoiding the need to create one manually viaListImportJobsRequest.builder()- Parameters:
listImportJobsRequest- AConsumerthat will call methods onListImportJobsRequest.Builderto create a request.- Returns:
- Result of the ListImportJobs operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImportJobsPaginator
default ListImportJobsIterable listImportJobsPaginator(ListImportJobsRequest listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client .listImportJobsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)operation.- Parameters:
listImportJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listImportJobsPaginator
default ListImportJobsIterable listImportJobsPaginator(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client .listImportJobsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListImportJobsRequest.Builderavoiding the need to create one manually viaListImportJobsRequest.builder()- Parameters:
listImportJobsRequest- AConsumerthat will call methods onListImportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Lists the knowledge bases.
- Parameters:
listKnowledgeBasesRequest-- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
Lists the knowledge bases.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto create a request.- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)operation.- Parameters:
listKnowledgeBasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)operation.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ValidationException- The input fails to satisfy the constraints specified by a service.AccessDeniedException- You do not have sufficient access to perform this action.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplateVersions
default ListMessageTemplateVersionsResponse listMessageTemplateVersions(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists all the available versions for the specified Amazon Q in Connect message template.
- Parameters:
listMessageTemplateVersionsRequest-- Returns:
- Result of the ListMessageTemplateVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplateVersions
default ListMessageTemplateVersionsResponse listMessageTemplateVersions(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists all the available versions for the specified Amazon Q in Connect message template.
This is a convenience which creates an instance of the
ListMessageTemplateVersionsRequest.Builderavoiding the need to create one manually viaListMessageTemplateVersionsRequest.builder()- Parameters:
listMessageTemplateVersionsRequest- AConsumerthat will call methods onListMessageTemplateVersionsRequest.Builderto create a request.- Returns:
- Result of the ListMessageTemplateVersions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplateVersionsPaginator
default ListMessageTemplateVersionsIterable listMessageTemplateVersionsPaginator(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client .listMessageTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)operation.- Parameters:
listMessageTemplateVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplateVersionsPaginator
default ListMessageTemplateVersionsIterable listMessageTemplateVersionsPaginator(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client .listMessageTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)operation.
This is a convenience which creates an instance of the
ListMessageTemplateVersionsRequest.Builderavoiding the need to create one manually viaListMessageTemplateVersionsRequest.builder()- Parameters:
listMessageTemplateVersionsRequest- AConsumerthat will call methods onListMessageTemplateVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplates
default ListMessageTemplatesResponse listMessageTemplates(ListMessageTemplatesRequest listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
- Parameters:
listMessageTemplatesRequest-- Returns:
- Result of the ListMessageTemplates operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplates
default ListMessageTemplatesResponse listMessageTemplates(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
This is a convenience which creates an instance of the
ListMessageTemplatesRequest.Builderavoiding the need to create one manually viaListMessageTemplatesRequest.builder()- Parameters:
listMessageTemplatesRequest- AConsumerthat will call methods onListMessageTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListMessageTemplates operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplatesPaginator
default ListMessageTemplatesIterable listMessageTemplatesPaginator(ListMessageTemplatesRequest listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client .listMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)operation.- Parameters:
listMessageTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessageTemplatesPaginator
default ListMessageTemplatesIterable listMessageTemplatesPaginator(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client .listMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)operation.
This is a convenience which creates an instance of the
ListMessageTemplatesRequest.Builderavoiding the need to create one manually viaListMessageTemplatesRequest.builder()- Parameters:
listMessageTemplatesRequest- AConsumerthat will call methods onListMessageTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessages
default ListMessagesResponse listMessages(ListMessagesRequest listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists messages on an Amazon Q in Connect session.
- Parameters:
listMessagesRequest-- Returns:
- Result of the ListMessages operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessages
default ListMessagesResponse listMessages(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists messages on an Amazon Q in Connect session.
This is a convenience which creates an instance of the
ListMessagesRequest.Builderavoiding the need to create one manually viaListMessagesRequest.builder()- Parameters:
listMessagesRequest- AConsumerthat will call methods onListMessagesRequest.Builderto create a request.- Returns:
- Result of the ListMessages operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessagesPaginator
default ListMessagesIterable listMessagesPaginator(ListMessagesRequest listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)operation.- Parameters:
listMessagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listMessagesPaginator
default ListMessagesIterable listMessagesPaginator(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)operation.
This is a convenience which creates an instance of the
ListMessagesRequest.Builderavoiding the need to create one manually viaListMessagesRequest.builder()- Parameters:
listMessagesRequest- AConsumerthat will call methods onListMessagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listQuickResponses
default ListQuickResponsesResponse listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists information about quick response.
- Parameters:
listQuickResponsesRequest-- Returns:
- Result of the ListQuickResponses operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listQuickResponses
default ListQuickResponsesResponse listQuickResponses(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists information about quick response.
This is a convenience which creates an instance of the
ListQuickResponsesRequest.Builderavoiding the need to create one manually viaListQuickResponsesRequest.builder()- Parameters:
listQuickResponsesRequest- AConsumerthat will call methods onListQuickResponsesRequest.Builderto create a request.- Returns:
- Result of the ListQuickResponses operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listQuickResponsesPaginator
default ListQuickResponsesIterable listQuickResponsesPaginator(ListQuickResponsesRequest listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client .listQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListQuickResponsesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)operation.- Parameters:
listQuickResponsesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listQuickResponsesPaginator
default ListQuickResponsesIterable listQuickResponsesPaginator(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client .listQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListQuickResponsesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)operation.
This is a convenience which creates an instance of the
ListQuickResponsesRequest.Builderavoiding the need to create one manually viaListQuickResponsesRequest.builder()- Parameters:
listQuickResponsesRequest- AConsumerthat will call methods onListQuickResponsesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Lists the tags for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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
waitTimeSecondsinput for long-polling behavior and avoiding duplicate recommendations.- Parameters:
notifyRecommendationsReceivedRequest-- Returns:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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
waitTimeSecondsinput for long-polling behavior and avoiding duplicate recommendations.
This is a convenience which creates an instance of the
NotifyRecommendationsReceivedRequest.Builderavoiding the need to create one manually viaNotifyRecommendationsReceivedRequest.builder()- Parameters:
notifyRecommendationsReceivedRequest- AConsumerthat will call methods onNotifyRecommendationsReceivedRequest.Builderto create a request.- Returns:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putFeedback
default PutFeedbackResponse putFeedback(PutFeedbackRequest putFeedbackRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
- Parameters:
putFeedbackRequest-- Returns:
- Result of the PutFeedback operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putFeedback
default PutFeedbackResponse putFeedback(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
This is a convenience which creates an instance of the
PutFeedbackRequest.Builderavoiding the need to create one manually viaPutFeedbackRequest.builder()- Parameters:
putFeedbackRequest- AConsumerthat will call methods onPutFeedbackRequest.Builderto create a request.- Returns:
- Result of the PutFeedback operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistant
@Deprecated default QueryAssistantResponse queryAssistant(QueryAssistantRequest queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deprecated.QueryAssistant 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 Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.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.
- Parameters:
queryAssistantRequest-- Returns:
- Result of the QueryAssistant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistant
@Deprecated default QueryAssistantResponse queryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deprecated.QueryAssistant 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 Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.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.
This is a convenience which creates an instance of the
QueryAssistantRequest.Builderavoiding the need to create one manually viaQueryAssistantRequest.builder()- Parameters:
queryAssistantRequest- AConsumerthat will call methods onQueryAssistantRequest.Builderto create a request.- Returns:
- Result of the QueryAssistant operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistantPaginator
@Deprecated default QueryAssistantIterable queryAssistantPaginator(QueryAssistantRequest queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deprecated.QueryAssistant 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 Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This is a variant of
queryAssistant(software.amazon.awssdk.services.qconnect.model.QueryAssistantRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client .queryAssistantPaginator(request); for (software.amazon.awssdk.services.qconnect.model.QueryAssistantResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryAssistant(software.amazon.awssdk.services.qconnect.model.QueryAssistantRequest)operation.- Parameters:
queryAssistantRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistantPaginator
@Deprecated default QueryAssistantIterable queryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Deprecated.QueryAssistant 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 Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This is a variant of
queryAssistant(software.amazon.awssdk.services.qconnect.model.QueryAssistantRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client .queryAssistantPaginator(request); for (software.amazon.awssdk.services.qconnect.model.QueryAssistantResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryAssistant(software.amazon.awssdk.services.qconnect.model.QueryAssistantRequest)operation.
This is a convenience which creates an instance of the
QueryAssistantRequest.Builderavoiding the need to create one manually viaQueryAssistantRequest.builder()- Parameters:
queryAssistantRequest- AConsumerthat will call methods onQueryAssistantRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeAssistantAIAgent
default RemoveAssistantAiAgentResponse removeAssistantAIAgent(RemoveAssistantAiAgentRequest removeAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
- Parameters:
removeAssistantAiAgentRequest-- Returns:
- Result of the RemoveAssistantAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeAssistantAIAgent
default RemoveAssistantAiAgentResponse removeAssistantAIAgent(Consumer<RemoveAssistantAiAgentRequest.Builder> removeAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Removes the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
This is a convenience which creates an instance of the
RemoveAssistantAiAgentRequest.Builderavoiding the need to create one manually viaRemoveAssistantAiAgentRequest.builder()- Parameters:
removeAssistantAiAgentRequest- AConsumerthat will call methods onRemoveAssistantAiAgentRequest.Builderto create a request.- Returns:
- Result of the RemoveAssistantAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Removes a URI template from a knowledge base.
- Parameters:
removeKnowledgeBaseTemplateUriRequest-- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Removes a URI template from a knowledge base.
This is a convenience which creates an instance of the
RemoveKnowledgeBaseTemplateUriRequest.Builderavoiding the need to create one manually viaRemoveKnowledgeBaseTemplateUriRequest.builder()- Parameters:
removeKnowledgeBaseTemplateUriRequest- AConsumerthat will call methods onRemoveKnowledgeBaseTemplateUriRequest.Builderto create a request.- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
renderMessageTemplate
default RenderMessageTemplateResponse renderMessageTemplate(RenderMessageTemplateRequest renderMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
renderMessageTemplateRequest-- Returns:
- Result of the RenderMessageTemplate operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
renderMessageTemplate
default RenderMessageTemplateResponse renderMessageTemplate(Consumer<RenderMessageTemplateRequest.Builder> renderMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
RenderMessageTemplateRequest.Builderavoiding the need to create one manually viaRenderMessageTemplateRequest.builder()- Parameters:
renderMessageTemplateRequest- AConsumerthat will call methods onRenderMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the RenderMessageTemplate operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchContent
default SearchContentResponse searchContent(SearchContentRequest searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
- Parameters:
searchContentRequest-- Returns:
- Result of the SearchContent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchContent
default SearchContentResponse searchContent(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
This is a convenience which creates an instance of the
SearchContentRequest.Builderavoiding the need to create one manually viaSearchContentRequest.builder()- Parameters:
searchContentRequest- AConsumerthat will call methods onSearchContentRequest.Builderto create a request.- Returns:
- Result of the SearchContent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(SearchContentRequest searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchContentResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)operation.- Parameters:
searchContentRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchContentResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)operation.
This is a convenience which creates an instance of the
SearchContentRequest.Builderavoiding the need to create one manually viaSearchContentRequest.builder()- Parameters:
searchContentRequest- AConsumerthat will call methods onSearchContentRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchMessageTemplates
default SearchMessageTemplatesResponse searchMessageTemplates(SearchMessageTemplatesRequest searchMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Searches for Amazon Q in Connect message templates in the specified knowledge base.
- Parameters:
searchMessageTemplatesRequest-- Returns:
- Result of the SearchMessageTemplates operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchMessageTemplates
default SearchMessageTemplatesResponse searchMessageTemplates(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Searches for Amazon Q in Connect message templates in the specified knowledge base.
This is a convenience which creates an instance of the
SearchMessageTemplatesRequest.Builderavoiding the need to create one manually viaSearchMessageTemplatesRequest.builder()- Parameters:
searchMessageTemplatesRequest- AConsumerthat will call methods onSearchMessageTemplatesRequest.Builderto create a request.- Returns:
- Result of the SearchMessageTemplates operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchMessageTemplatesPaginator
default SearchMessageTemplatesIterable searchMessageTemplatesPaginator(SearchMessageTemplatesRequest searchMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client .searchMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)operation.- Parameters:
searchMessageTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchMessageTemplatesPaginator
default SearchMessageTemplatesIterable searchMessageTemplatesPaginator(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client .searchMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)operation.
This is a convenience which creates an instance of the
SearchMessageTemplatesRequest.Builderavoiding the need to create one manually viaSearchMessageTemplatesRequest.builder()- Parameters:
searchMessageTemplatesRequest- AConsumerthat will call methods onSearchMessageTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchQuickResponses
default SearchQuickResponsesResponse searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
- Parameters:
searchQuickResponsesRequest-- Returns:
- Result of the SearchQuickResponses operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchQuickResponses
default SearchQuickResponsesResponse searchQuickResponses(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
This is a convenience which creates an instance of the
SearchQuickResponsesRequest.Builderavoiding the need to create one manually viaSearchQuickResponsesRequest.builder()- Parameters:
searchQuickResponsesRequest- AConsumerthat will call methods onSearchQuickResponsesRequest.Builderto create a request.- Returns:
- Result of the SearchQuickResponses operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchQuickResponsesPaginator
default SearchQuickResponsesIterable searchQuickResponsesPaginator(SearchQuickResponsesRequest searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client .searchQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)operation.- Parameters:
searchQuickResponsesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchQuickResponsesPaginator
default SearchQuickResponsesIterable searchQuickResponsesPaginator(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client .searchQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)operation.
This is a convenience which creates an instance of the
SearchQuickResponsesRequest.Builderavoiding the need to create one manually viaSearchQuickResponsesRequest.builder()- Parameters:
searchQuickResponsesRequest- AConsumerthat will call methods onSearchQuickResponsesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessions
default SearchSessionsResponse searchSessions(SearchSessionsRequest searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Searches for sessions.
- Parameters:
searchSessionsRequest-- Returns:
- Result of the SearchSessions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessions
default SearchSessionsResponse searchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Searches for sessions.
This is a convenience which creates an instance of the
SearchSessionsRequest.Builderavoiding the need to create one manually viaSearchSessionsRequest.builder()- Parameters:
searchSessionsRequest- AConsumerthat will call methods onSearchSessionsRequest.Builderto create a request.- Returns:
- Result of the SearchSessions operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(SearchSessionsRequest searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client .searchSessionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)operation.- Parameters:
searchSessionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
This is a variant of
searchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client .searchSessionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)operation.
This is a convenience which creates an instance of the
SearchSessionsRequest.Builderavoiding the need to create one manually viaSearchSessionsRequest.builder()- Parameters:
searchSessionsRequest- AConsumerthat will call methods onSearchSessionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
sendMessage
default SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws RequestTimeoutException, ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Submits a message to the Amazon Q in Connect session.
- Parameters:
sendMessageRequest-- Returns:
- Result of the SendMessage operation returned by the service.
- Throws:
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 aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
sendMessage
default SendMessageResponse sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest) throws RequestTimeoutException, ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Submits a message to the Amazon Q in Connect session.
This is a convenience which creates an instance of the
SendMessageRequest.Builderavoiding the need to create one manually viaSendMessageRequest.builder()- Parameters:
sendMessageRequest- AConsumerthat will call methods onSendMessageRequest.Builderto create a request.- Returns:
- Result of the SendMessage operation returned by the service.
- Throws:
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 aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startContentUpload
default StartContentUploadResponse startContentUpload(StartContentUploadRequest startContentUploadRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
startContentUploadRequest-- Returns:
- Result of the StartContentUpload operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startContentUpload
default StartContentUploadResponse startContentUpload(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
StartContentUploadRequest.Builderavoiding the need to create one manually viaStartContentUploadRequest.builder()- Parameters:
startContentUploadRequest- AConsumerthat will call methods onStartContentUploadRequest.Builderto create a request.- Returns:
- Result of the StartContentUpload operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startImportJob
default StartImportJobResponse startImportJob(StartImportJobRequest startImportJobRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
startImportJobRequest-- Returns:
- Result of the StartImportJob operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
startImportJob
default StartImportJobResponse startImportJob(Consumer<StartImportJobRequest.Builder> startImportJobRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
StartImportJobRequest.Builderavoiding the need to create one manually viaStartImportJobRequest.builder()- Parameters:
startImportJobRequest- AConsumerthat will call methods onStartImportJobRequest.Builderto create a request.- Returns:
- Result of the StartImportJob operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Adds the specified tags to the specified resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Adds the specified tags to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Removes the specified tags from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Removes the specified tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAIAgent
default UpdateAiAgentResponse updateAIAgent(UpdateAiAgentRequest updateAiAgentRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates an AI Agent.
- Parameters:
updateAiAgentRequest-- Returns:
- Result of the UpdateAIAgent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAIAgent
default UpdateAiAgentResponse updateAIAgent(Consumer<UpdateAiAgentRequest.Builder> updateAiAgentRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates an AI Agent.
This is a convenience which creates an instance of the
UpdateAiAgentRequest.Builderavoiding the need to create one manually viaUpdateAiAgentRequest.builder()- Parameters:
updateAiAgentRequest- AConsumerthat will call methods onUpdateAiAgentRequest.Builderto create a request.- Returns:
- Result of the UpdateAIAgent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAIGuardrail
default UpdateAiGuardrailResponse updateAIGuardrail(UpdateAiGuardrailRequest updateAiGuardrailRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates an AI Guardrail.
- Parameters:
updateAiGuardrailRequest-- Returns:
- Result of the UpdateAIGuardrail operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAIGuardrail
default UpdateAiGuardrailResponse updateAIGuardrail(Consumer<UpdateAiGuardrailRequest.Builder> updateAiGuardrailRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates an AI Guardrail.
This is a convenience which creates an instance of the
UpdateAiGuardrailRequest.Builderavoiding the need to create one manually viaUpdateAiGuardrailRequest.builder()- Parameters:
updateAiGuardrailRequest- AConsumerthat will call methods onUpdateAiGuardrailRequest.Builderto create a request.- Returns:
- Result of the UpdateAIGuardrail operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAIPrompt
default UpdateAiPromptResponse updateAIPrompt(UpdateAiPromptRequest updateAiPromptRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates an AI Prompt.
- Parameters:
updateAiPromptRequest-- Returns:
- Result of the UpdateAIPrompt operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAIPrompt
default UpdateAiPromptResponse updateAIPrompt(Consumer<UpdateAiPromptRequest.Builder> updateAiPromptRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates an AI Prompt.
This is a convenience which creates an instance of the
UpdateAiPromptRequest.Builderavoiding the need to create one manually viaUpdateAiPromptRequest.builder()- Parameters:
updateAiPromptRequest- AConsumerthat will call methods onUpdateAiPromptRequest.Builderto create a request.- Returns:
- Result of the UpdateAIPrompt operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAssistantAIAgent
default UpdateAssistantAiAgentResponse updateAssistantAIAgent(UpdateAssistantAiAgentRequest updateAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
- Parameters:
updateAssistantAiAgentRequest-- Returns:
- Result of the UpdateAssistantAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAssistantAIAgent
default UpdateAssistantAiAgentResponse updateAssistantAIAgent(Consumer<UpdateAssistantAiAgentRequest.Builder> updateAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
Updates the AI Agent that is set for use by defafult on an Amazon Q in Connect Assistant.
This is a convenience which creates an instance of the
UpdateAssistantAiAgentRequest.Builderavoiding the need to create one manually viaUpdateAssistantAiAgentRequest.builder()- Parameters:
updateAssistantAiAgentRequest- AConsumerthat will call methods onUpdateAssistantAiAgentRequest.Builderto create a request.- Returns:
- Result of the UpdateAssistantAIAgent operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateContent
default UpdateContentResponse updateContent(UpdateContentRequest updateContentRequest) throws ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Updates information about the content.
- Parameters:
updateContentRequest-- Returns:
- Result of the UpdateContent operation returned by the service.
- Throws:
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 providedrevisionIddoes not match, indicating the content has been modified since it was last read.ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateContent
default UpdateContentResponse updateContent(Consumer<UpdateContentRequest.Builder> updateContentRequest) throws ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Updates information about the content.
This is a convenience which creates an instance of the
UpdateContentRequest.Builderavoiding the need to create one manually viaUpdateContentRequest.builder()- Parameters:
updateContentRequest- AConsumerthat will call methods onUpdateContentRequest.Builderto create a request.- Returns:
- Result of the UpdateContent operation returned by the service.
- Throws:
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 providedrevisionIddoes not match, indicating the content has been modified since it was last read.ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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 anIdvalue, and you can set the template URI tohttps://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.- Parameters:
updateKnowledgeBaseTemplateUriRequest-- Returns:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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 anIdvalue, and you can set the template URI tohttps://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
This is a convenience which creates an instance of the
UpdateKnowledgeBaseTemplateUriRequest.Builderavoiding the need to create one manually viaUpdateKnowledgeBaseTemplateUriRequest.builder()- Parameters:
updateKnowledgeBaseTemplateUriRequest- AConsumerthat will call methods onUpdateKnowledgeBaseTemplateUriRequest.Builderto create a request.- Returns:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMessageTemplate
default UpdateMessageTemplateResponse updateMessageTemplate(UpdateMessageTemplateRequest updateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier. Any modification will only apply to the message template that is referenced by the$LATESTqualifier. The fields for all available versions will remain unchanged.- Parameters:
updateMessageTemplateRequest-- Returns:
- Result of the UpdateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMessageTemplate
default UpdateMessageTemplateResponse updateMessageTemplate(Consumer<UpdateMessageTemplateRequest.Builder> updateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier. Any modification will only apply to the message template that is referenced by the$LATESTqualifier. The fields for all available versions will remain unchanged.
This is a convenience which creates an instance of the
UpdateMessageTemplateRequest.Builderavoiding the need to create one manually viaUpdateMessageTemplateRequest.builder()- Parameters:
updateMessageTemplateRequest- AConsumerthat will call methods onUpdateMessageTemplateRequest.Builderto create a request.- Returns:
- Result of the UpdateMessageTemplate operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMessageTemplateMetadata
default UpdateMessageTemplateMetadataResponse updateMessageTemplateMetadata(UpdateMessageTemplateMetadataRequest updateMessageTemplateMetadataRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.- Parameters:
updateMessageTemplateMetadataRequest-- Returns:
- Result of the UpdateMessageTemplateMetadata operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateMessageTemplateMetadata
default UpdateMessageTemplateMetadataResponse updateMessageTemplateMetadata(Consumer<UpdateMessageTemplateMetadataRequest.Builder> updateMessageTemplateMetadataRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException
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
$LATESTqualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
This is a convenience which creates an instance of the
UpdateMessageTemplateMetadataRequest.Builderavoiding the need to create one manually viaUpdateMessageTemplateMetadataRequest.builder()- Parameters:
updateMessageTemplateMetadataRequest- AConsumerthat will call methods onUpdateMessageTemplateMetadataRequest.Builderto create a request.- Returns:
- Result of the UpdateMessageTemplateMetadata operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateQuickResponse
default UpdateQuickResponseResponse updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest) throws ConflictException, ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Updates an existing Amazon Q in Connect quick response.
- Parameters:
updateQuickResponseRequest-- Returns:
- Result of the UpdateQuickResponse operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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 providedrevisionIddoes not match, indicating the content has been modified since it was last read.ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateQuickResponse
default UpdateQuickResponseResponse updateQuickResponse(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest) throws ConflictException, ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Updates an existing Amazon Q in Connect quick response.
This is a convenience which creates an instance of the
UpdateQuickResponseRequest.Builderavoiding the need to create one manually viaUpdateQuickResponseRequest.builder()- Parameters:
updateQuickResponseRequest- AConsumerthat will call methods onUpdateQuickResponseRequest.Builderto create a request.- Returns:
- Result of the UpdateQuickResponse operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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 providedrevisionIddoes not match, indicating the content has been modified since it was last read.ResourceNotFoundException- The specified resource does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSession
default UpdateSessionResponse updateSession(UpdateSessionRequest updateSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
- Parameters:
updateSessionRequest-- Returns:
- Result of the UpdateSession operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSession
default UpdateSessionResponse updateSession(Consumer<UpdateSessionRequest.Builder> updateSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
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.
This is a convenience which creates an instance of the
UpdateSessionRequest.Builderavoiding the need to create one manually viaUpdateSessionRequest.builder()- Parameters:
updateSessionRequest- AConsumerthat will call methods onUpdateSessionRequest.Builderto create a request.- Returns:
- Result of the UpdateSession operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSessionData
default UpdateSessionDataResponse updateSessionData(UpdateSessionDataRequest updateSessionDataRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Updates the data stored on an Amazon Q in Connect Session.
- Parameters:
updateSessionDataRequest-- Returns:
- Result of the UpdateSessionData operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateSessionData
default UpdateSessionDataResponse updateSessionData(Consumer<UpdateSessionDataRequest.Builder> updateSessionDataRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException
Updates the data stored on an Amazon Q in Connect Session.
This is a convenience which creates an instance of the
UpdateSessionDataRequest.Builderavoiding the need to create one manually viaUpdateSessionDataRequest.builder()- Parameters:
updateSessionDataRequest- AConsumerthat will call methods onUpdateSessionDataRequest.Builderto create a request.- Returns:
- Result of the UpdateSessionData operation returned by the service.
- Throws:
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.QConnectException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static QConnectClient create()
Create aQConnectClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static QConnectClientBuilder builder()
Create a builder that can be used to configure and create aQConnectClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default QConnectServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-