aws-sdk-qconnect 1.54.0 → 1.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 347e78ceeb5eff82924b95fbf2e9dc7d4c6f9895ed5fbdad31380e6323a8132b
-  data.tar.gz: 843fd5d6380bca85de1ac47ef977e31516d4e44ad9457ca24cbb7c5918f348ba
+  metadata.gz: 49ac6e5bec752cc5b436060e105a8f1fcbb95827f82b2a8be5584a1f90b56594
+  data.tar.gz: a45cc182e824c8af3b703e91f89aff88d8bda8234bbfad42fff1449cdf6dd9dd
 SHA512:
-  metadata.gz: 664d44a4c1434538170f78a42babaa164d6594b449bf44ccdb4cc72f02a91b93d5631eb4f1f6bedfe6f734193b274a946ff08e6d5b67b9fba4099704f99fba3c
-  data.tar.gz: 7680a8ad3ab32909287672fb29481a7e1dfff539a115240b0253219cc6354eeef39b693c6bdd3720c74332ca29f0a4d919204cbea496db0d08bfaffd81eb82e5
+  metadata.gz: 5f2927b90f01fc1e31c0cab12f36b2a71a911fb98037fbd0866b96485b563c67693b321c4516a5b9b47a240c5aaf47654c4b475d7c5209237ffd76515bc81ea6
+  data.tar.gz: ce1c31854e98e771c4292ee89633df17cabc4c85452f3a5efc1a0b650a94f1e71c56fa07e6ae4c4a3dde242d614a504cad896b219aa6a4a990fbb7d626f5afe4

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.56.0 (2026-05-19)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.55.0 (2026-05-14)
+------------------
+
+* Feature - ListModels is an API that returns the available AI models for a Connect Assistant based on its region and AI prompt type.
+
 1.54.0 (2026-05-13)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.54.0
+1.56.0

data/lib/aws-sdk-qconnect/client.rb

@@ -6065,6 +6065,71 @@ module Aws::QConnect
       req.send_request(options)
     end
 
+    # Lists the models available to an Amazon Q in Connect assistant in the
+    # assistant's Amazon Web Services Region. The available models are
+    # determined by the region of the specified assistant.
+    #
+    # @option params [required, String] :assistant_id
+    #   The identifier of the Amazon Q in Connect assistant. Can be either the
+    #   ID or the ARN. URLs cannot contain the ARN. The assistant's region
+    #   determines which models are available.
+    #
+    # @option params [String] :ai_prompt_type
+    #   The type of the AI Prompt to filter models by. When specified, only
+    #   models that support the given AI Prompt type are returned.
+    #
+    # @option params [String] :model_lifecycle
+    #   The lifecycle status of models to filter by. When specified, only
+    #   models with the given lifecycle status are returned.
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of results. Use the value returned in the
+    #   previous response in the next request to retrieve the next set of
+    #   results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return per page.
+    #
+    # @return [Types::ListModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListModelsResponse#model_summaries #model_summaries} => Array<Types::ModelSummary>
+    #   * {Types::ListModelsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_models({
+    #     assistant_id: "UuidOrArn", # required
+    #     ai_prompt_type: "ANSWER_GENERATION", # accepts ANSWER_GENERATION, INTENT_LABELING_GENERATION, QUERY_REFORMULATION, SELF_SERVICE_PRE_PROCESSING, SELF_SERVICE_ANSWER_GENERATION, EMAIL_RESPONSE, EMAIL_OVERVIEW, EMAIL_GENERATIVE_ANSWER, EMAIL_QUERY_REFORMULATION, ORCHESTRATION, NOTE_TAKING, CASE_SUMMARIZATION
+    #     model_lifecycle: "ACTIVE", # accepts ACTIVE, LEGACY
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.model_summaries #=> Array
+    #   resp.model_summaries[0].model_id #=> String
+    #   resp.model_summaries[0].display_name #=> String
+    #   resp.model_summaries[0].cross_region_status #=> String, one of "NONE", "REGIONAL", "GLOBAL"
+    #   resp.model_summaries[0].supports_prompt_caching #=> Boolean
+    #   resp.model_summaries[0].supported_ai_prompt_types #=> Array
+    #   resp.model_summaries[0].supported_ai_prompt_types[0] #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION", "EMAIL_RESPONSE", "EMAIL_OVERVIEW", "EMAIL_GENERATIVE_ANSWER", "EMAIL_QUERY_REFORMULATION", "ORCHESTRATION", "NOTE_TAKING", "CASE_SUMMARIZATION"
+    #   resp.model_summaries[0].model_lifecycle #=> String, one of "ACTIVE", "LEGACY"
+    #   resp.model_summaries[0].legacy_timestamp #=> Time
+    #   resp.model_summaries[0].end_of_life_timestamp #=> Time
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListModels AWS API Documentation
+    #
+    # @overload list_models(params = {})
+    # @param [Hash] params ({})
+    def list_models(params = {}, options = {})
+      req = build_request(:list_models, params)
+      req.send_request(options)
+    end
+
     # Lists information about quick response.
     #
     # @option params [String] :next_token
@@ -9464,7 +9529,7 @@ module Aws::QConnect
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-qconnect'
-      context[:gem_version] = '1.54.0'
+      context[:gem_version] = '1.56.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-qconnect/client_api.rb

@@ -46,6 +46,7 @@ module Aws::QConnect
     AIPromptTemplateConfiguration = Shapes::UnionShape.new(name: 'AIPromptTemplateConfiguration')
     AIPromptTemplateType = Shapes::StringShape.new(name: 'AIPromptTemplateType')
     AIPromptType = Shapes::StringShape.new(name: 'AIPromptType')
+    AIPromptTypeList = Shapes::ListShape.new(name: 'AIPromptTypeList')
     AIPromptVersionSummariesList = Shapes::ListShape.new(name: 'AIPromptVersionSummariesList')
     AIPromptVersionSummary = Shapes::StructureShape.new(name: 'AIPromptVersionSummary')
     AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
@@ -156,6 +157,7 @@ module Aws::QConnect
     CreateQuickResponseResponse = Shapes::StructureShape.new(name: 'CreateQuickResponseResponse')
     CreateSessionRequest = Shapes::StructureShape.new(name: 'CreateSessionRequest')
     CreateSessionResponse = Shapes::StructureShape.new(name: 'CreateSessionResponse')
+    CrossRegionStatus = Shapes::StringShape.new(name: 'CrossRegionStatus')
     CustomAttributes = Shapes::MapShape.new(name: 'CustomAttributes')
     CustomerProfileAttributes = Shapes::StructureShape.new(name: 'CustomerProfileAttributes')
     DataDetails = Shapes::UnionShape.new(name: 'DataDetails')
@@ -351,6 +353,8 @@ module Aws::QConnect
     ListMessageTemplatesResponse = Shapes::StructureShape.new(name: 'ListMessageTemplatesResponse')
     ListMessagesRequest = Shapes::StructureShape.new(name: 'ListMessagesRequest')
     ListMessagesResponse = Shapes::StructureShape.new(name: 'ListMessagesResponse')
+    ListModelsRequest = Shapes::StructureShape.new(name: 'ListModelsRequest')
+    ListModelsResponse = Shapes::StructureShape.new(name: 'ListModelsResponse')
     ListQuickResponsesRequest = Shapes::StructureShape.new(name: 'ListQuickResponsesRequest')
     ListQuickResponsesResponse = Shapes::StructureShape.new(name: 'ListQuickResponsesResponse')
     ListSpansRequest = Shapes::StructureShape.new(name: 'ListSpansRequest')
@@ -402,6 +406,11 @@ module Aws::QConnect
     MessageTemplateVersionSummary = Shapes::StructureShape.new(name: 'MessageTemplateVersionSummary')
     MessageTemplateVersionSummaryList = Shapes::ListShape.new(name: 'MessageTemplateVersionSummaryList')
     MessageType = Shapes::StringShape.new(name: 'MessageType')
+    ModelDisplayName = Shapes::StringShape.new(name: 'ModelDisplayName')
+    ModelId = Shapes::StringShape.new(name: 'ModelId')
+    ModelLifecycle = Shapes::StringShape.new(name: 'ModelLifecycle')
+    ModelSummary = Shapes::StructureShape.new(name: 'ModelSummary')
+    ModelSummaryList = Shapes::ListShape.new(name: 'ModelSummaryList')
     Name = Shapes::StringShape.new(name: 'Name')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     NonEmptySensitiveString = Shapes::StringShape.new(name: 'NonEmptySensitiveString')
@@ -848,6 +857,8 @@ module Aws::QConnect
     AIPromptTemplateConfiguration.add_member_subclass(:unknown, Types::AIPromptTemplateConfiguration::Unknown)
     AIPromptTemplateConfiguration.struct_class = Types::AIPromptTemplateConfiguration
 
+    AIPromptTypeList.member = Shapes::ShapeRef.new(shape: AIPromptType)
+
     AIPromptVersionSummariesList.member = Shapes::ShapeRef.new(shape: AIPromptVersionSummary)
 
     AIPromptVersionSummary.add_member(:ai_prompt_summary, Shapes::ShapeRef.new(shape: AIPromptSummary, location_name: "aiPromptSummary"))
@@ -2077,6 +2088,17 @@ module Aws::QConnect
     ListMessagesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
     ListMessagesResponse.struct_class = Types::ListMessagesResponse
 
+    ListModelsRequest.add_member(:assistant_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "assistantId"))
+    ListModelsRequest.add_member(:ai_prompt_type, Shapes::ShapeRef.new(shape: AIPromptType, location: "querystring", location_name: "aiPromptType"))
+    ListModelsRequest.add_member(:model_lifecycle, Shapes::ShapeRef.new(shape: ModelLifecycle, location: "querystring", location_name: "modelLifecycle"))
+    ListModelsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
+    ListModelsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
+    ListModelsRequest.struct_class = Types::ListModelsRequest
+
+    ListModelsResponse.add_member(:model_summaries, Shapes::ShapeRef.new(shape: ModelSummaryList, required: true, location_name: "modelSummaries"))
+    ListModelsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
+    ListModelsResponse.struct_class = Types::ListModelsResponse
+
     ListQuickResponsesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NonEmptyString, location: "querystring", location_name: "nextToken"))
     ListQuickResponsesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
     ListQuickResponsesRequest.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: UuidOrArn, required: true, location: "uri", location_name: "knowledgeBaseId"))
@@ -2293,6 +2315,18 @@ module Aws::QConnect
 
     MessageTemplateVersionSummaryList.member = Shapes::ShapeRef.new(shape: MessageTemplateVersionSummary)
 
+    ModelSummary.add_member(:model_id, Shapes::ShapeRef.new(shape: ModelId, required: true, location_name: "modelId"))
+    ModelSummary.add_member(:display_name, Shapes::ShapeRef.new(shape: ModelDisplayName, required: true, location_name: "displayName"))
+    ModelSummary.add_member(:cross_region_status, Shapes::ShapeRef.new(shape: CrossRegionStatus, location_name: "crossRegionStatus"))
+    ModelSummary.add_member(:supports_prompt_caching, Shapes::ShapeRef.new(shape: Boolean, location_name: "supportsPromptCaching"))
+    ModelSummary.add_member(:supported_ai_prompt_types, Shapes::ShapeRef.new(shape: AIPromptTypeList, location_name: "supportedAIPromptTypes"))
+    ModelSummary.add_member(:model_lifecycle, Shapes::ShapeRef.new(shape: ModelLifecycle, location_name: "modelLifecycle"))
+    ModelSummary.add_member(:legacy_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "legacyTimestamp"))
+    ModelSummary.add_member(:end_of_life_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "endOfLifeTimestamp"))
+    ModelSummary.struct_class = Types::ModelSummary
+
+    ModelSummaryList.member = Shapes::ShapeRef.new(shape: ModelSummary)
+
     NoteTakingAIAgentConfiguration.add_member(:note_taking_ai_prompt_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "noteTakingAIPromptId"))
     NoteTakingAIAgentConfiguration.add_member(:note_taking_ai_guardrail_id, Shapes::ShapeRef.new(shape: UuidWithQualifier, location_name: "noteTakingAIGuardrailId"))
     NoteTakingAIAgentConfiguration.add_member(:locale, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "locale"))
@@ -4193,6 +4227,26 @@ module Aws::QConnect
         )
       end)
 
+      api.add_operation(:list_models, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListModels"
+        o.http_method = "GET"
+        o.http_request_uri = "/assistants/{assistantId}/models"
+        o.input = Shapes::ShapeRef.new(shape: ListModelsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListModelsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_quick_responses, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListQuickResponses"
         o.http_method = "GET"

data/lib/aws-sdk-qconnect/types.rb

@@ -7010,6 +7010,62 @@ module Aws::QConnect
       include Aws::Structure
     end
 
+    # @!attribute [rw] assistant_id
+    #   The identifier of the Amazon Q in Connect assistant. Can be either
+    #   the ID or the ARN. URLs cannot contain the ARN. The assistant's
+    #   region determines which models are available.
+    #   @return [String]
+    #
+    # @!attribute [rw] ai_prompt_type
+    #   The type of the AI Prompt to filter models by. When specified, only
+    #   models that support the given AI Prompt type are returned.
+    #   @return [String]
+    #
+    # @!attribute [rw] model_lifecycle
+    #   The lifecycle status of models to filter by. When specified, only
+    #   models with the given lifecycle status are returned.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   The token for the next set of results. Use the value returned in the
+    #   previous response in the next request to retrieve the next set of
+    #   results.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results to return per page.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListModelsRequest AWS API Documentation
+    #
+    class ListModelsRequest < Struct.new(
+      :assistant_id,
+      :ai_prompt_type,
+      :model_lifecycle,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] model_summaries
+    #   The summaries of the models available to the assistant.
+    #   @return [Array<Types::ModelSummary>]
+    #
+    # @!attribute [rw] next_token
+    #   If there are additional results, this is the token for the next set
+    #   of results.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ListModelsResponse AWS API Documentation
+    #
+    class ListModelsResponse < Struct.new(
+      :model_summaries,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] next_token
     #   The token for the next set of results. Use the value returned in the
     #   previous response in the next request to retrieve the next set of
@@ -7987,6 +8043,63 @@ module Aws::QConnect
       include Aws::Structure
     end
 
+    # The summary of a model available to an Amazon Q in Connect assistant.
+    #
+    # @!attribute [rw] model_id
+    #   The identifier of the model.
+    #   @return [String]
+    #
+    # @!attribute [rw] display_name
+    #   The display name of the model.
+    #   @return [String]
+    #
+    # @!attribute [rw] cross_region_status
+    #   The cross-region availability status of the model. `NONE` indicates
+    #   the model is only available in a single region, `REGIONAL` indicates
+    #   the model is available through regional inference, and `GLOBAL`
+    #   indicates the model is available through global cross-region
+    #   inference.
+    #   @return [String]
+    #
+    # @!attribute [rw] supports_prompt_caching
+    #   Whether the model supports prompt caching.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] supported_ai_prompt_types
+    #   The list of AI Prompt types that the model supports.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] model_lifecycle
+    #   The current lifecycle of the model. `ACTIVE` indicates the model is
+    #   recommended for use and `LEGACY` indicates the model is still usable
+    #   but is deprecated.
+    #   @return [String]
+    #
+    # @!attribute [rw] legacy_timestamp
+    #   The timestamp when the model lifecycle will transition from `ACTIVE`
+    #   to `LEGACY`.
+    #   @return [Time]
+    #
+    # @!attribute [rw] end_of_life_timestamp
+    #   The timestamp when the model will reach end of life and no longer be
+    #   available for use.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/ModelSummary AWS API Documentation
+    #
+    class ModelSummary < Struct.new(
+      :model_id,
+      :display_name,
+      :cross_region_status,
+      :supports_prompt_caching,
+      :supported_ai_prompt_types,
+      :model_lifecycle,
+      :legacy_timestamp,
+      :end_of_life_timestamp)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The configuration for AI Agents of type `NOTE_TAKING`.
     #
     # @!attribute [rw] note_taking_ai_prompt_id

data/lib/aws-sdk-qconnect.rb

@@ -55,7 +55,7 @@ module Aws::QConnect
   autoload :EndpointProvider, 'aws-sdk-qconnect/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-qconnect/endpoints'
 
-  GEM_VERSION = '1.54.0'
+  GEM_VERSION = '1.56.0'
 
 end