aws-sdk-bedrockagent 1.86.0 → 1.88.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagent/client.rb +412 -3
- data/lib/aws-sdk-bedrockagent/client_api.rb +260 -0
- data/lib/aws-sdk-bedrockagent/types.rb +615 -0
- data/lib/aws-sdk-bedrockagent.rb +1 -1
- data/sig/client.rbs +128 -0
- data/sig/errors.rbs +7 -7
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +150 -0
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bcdcca3dcc8e89fb7574c71384595a68b268b576ffa9d6333bcb50de6db1dc12
|
|
4
|
+
data.tar.gz: ddd9e79d4d977e1cd716c596af223efd3286b57efc0e67c558b67ff2e68d6243
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: eb3de603056fcad08466f50a7229a82648a82a7e27dffb9690d3c9ef90ee3707e945b417f49a771fe26df41721530fdb8d6766cfeaba93e7791b782a87d114f4
|
|
7
|
+
data.tar.gz: 2c8d87b34b3dae2c3fc5ac7e2d8dc748fcde7df624ac35a5067fd6ecbae142ce4b3a72737adde1aefbbd62d154bb9cf427f02b6ae0cc53e1788ae969a60e3451
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.88.0 (2026-10-20)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
8
|
+
|
|
9
|
+
1.87.0 (2026-10-19)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Adds Retrieval Instructions for Amazon Bedrock Knowledge Bases. Create, get, update, delete, list, and version customer-authored instructions that guide how a knowledge base retrieves and answers, with content review before use.
|
|
13
|
+
|
|
4
14
|
1.86.0 (2026-10-01)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.88.0
|
|
@@ -199,13 +199,20 @@ module Aws::BedrockAgent
|
|
|
199
199
|
# the required types.
|
|
200
200
|
#
|
|
201
201
|
# @option options [Boolean] :correct_clock_skew (true)
|
|
202
|
-
# Used only in `standard` and `adaptive` retry modes. Specifies whether
|
|
203
|
-
# a clock skew correction and retry requests with skewed client
|
|
202
|
+
# Used only in `standard` and `adaptive` retry modes. Specifies whether
|
|
203
|
+
# to apply a clock skew correction and retry requests with skewed client
|
|
204
|
+
# clocks. Takes effect only when `disable_clock_skew_correction` is not set.
|
|
204
205
|
#
|
|
205
206
|
# @option options [String] :defaults_mode ("legacy")
|
|
206
207
|
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
207
208
|
# accepted modes and the configuration defaults that are included.
|
|
208
209
|
#
|
|
210
|
+
# @option options [Boolean] :disable_clock_skew_correction
|
|
211
|
+
# Used only in `standard` and `adaptive` retry modes. When `true`, the
|
|
212
|
+
# SDK does not apply a clock skew correction, does not update its stored
|
|
213
|
+
# skew from responses, and does not retry clock skew errors. Clock skew
|
|
214
|
+
# correction is enabled by default.
|
|
215
|
+
#
|
|
209
216
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
210
217
|
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
|
211
218
|
#
|
|
@@ -3037,6 +3044,138 @@ module Aws::BedrockAgent
|
|
|
3037
3044
|
req.send_request(options)
|
|
3038
3045
|
end
|
|
3039
3046
|
|
|
3047
|
+
# Creates a new retrieval instruction. The retrieval instruction is
|
|
3048
|
+
# usable once its status becomes ACTIVE. Use GetRetrievalInstruction to
|
|
3049
|
+
# check whether it is ready.
|
|
3050
|
+
#
|
|
3051
|
+
# @option params [String] :client_token
|
|
3052
|
+
# A caller-supplied token that makes a retried create return the
|
|
3053
|
+
# existing resource rather than a second one. The window is 8 hours.
|
|
3054
|
+
#
|
|
3055
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
3056
|
+
# not need to pass this option.**
|
|
3057
|
+
#
|
|
3058
|
+
# @option params [required, String] :name
|
|
3059
|
+
# Specifies the name of the retrieval instruction.
|
|
3060
|
+
#
|
|
3061
|
+
# @option params [required, Types::RetrievalInstructionContent] :instruction
|
|
3062
|
+
# The instruction content, as a set of named fields. Get does not return
|
|
3063
|
+
# this field until the create review passes.
|
|
3064
|
+
#
|
|
3065
|
+
# @option params [String] :description
|
|
3066
|
+
# Specifies a description of the retrieval instruction.
|
|
3067
|
+
#
|
|
3068
|
+
# @option params [String] :customer_encryption_key_arn
|
|
3069
|
+
# The Amazon Resource Name (ARN) of a customer managed AWS Key
|
|
3070
|
+
# Management Service (AWS KMS) key used to encrypt the instruction
|
|
3071
|
+
# content at rest. If you omit it, the service uses an AWS owned key.
|
|
3072
|
+
# You fix the key at create and cannot change it later.
|
|
3073
|
+
#
|
|
3074
|
+
# @option params [Hash<String,String>] :tags
|
|
3075
|
+
# Tags for the retrieval instruction.
|
|
3076
|
+
#
|
|
3077
|
+
# @return [Types::CreateRetrievalInstructionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3078
|
+
#
|
|
3079
|
+
# * {Types::CreateRetrievalInstructionResponse#retrieval_instruction_id #retrieval_instruction_id} => String
|
|
3080
|
+
# * {Types::CreateRetrievalInstructionResponse#retrieval_instruction_arn #retrieval_instruction_arn} => String
|
|
3081
|
+
# * {Types::CreateRetrievalInstructionResponse#name #name} => String
|
|
3082
|
+
# * {Types::CreateRetrievalInstructionResponse#status #status} => String
|
|
3083
|
+
# * {Types::CreateRetrievalInstructionResponse#last_transition_status #last_transition_status} => String
|
|
3084
|
+
# * {Types::CreateRetrievalInstructionResponse#created_at #created_at} => Time
|
|
3085
|
+
# * {Types::CreateRetrievalInstructionResponse#updated_at #updated_at} => Time
|
|
3086
|
+
#
|
|
3087
|
+
# @example Request syntax with placeholder values
|
|
3088
|
+
#
|
|
3089
|
+
# resp = client.create_retrieval_instruction({
|
|
3090
|
+
# client_token: "ClientToken",
|
|
3091
|
+
# name: "RetrievalInstructionName", # required
|
|
3092
|
+
# instruction: { # required
|
|
3093
|
+
# retrieval_guidance: "RetrievalInstructionFieldText",
|
|
3094
|
+
# persona: "RetrievalInstructionFieldText",
|
|
3095
|
+
# answer_format: "RetrievalInstructionFieldText",
|
|
3096
|
+
# answer_policy: "RetrievalInstructionFieldText",
|
|
3097
|
+
# },
|
|
3098
|
+
# description: "RetrievalInstructionDescription",
|
|
3099
|
+
# customer_encryption_key_arn: "KmsKeyArn",
|
|
3100
|
+
# tags: {
|
|
3101
|
+
# "TagKey" => "TagValue",
|
|
3102
|
+
# },
|
|
3103
|
+
# })
|
|
3104
|
+
#
|
|
3105
|
+
# @example Response structure
|
|
3106
|
+
#
|
|
3107
|
+
# resp.retrieval_instruction_id #=> String
|
|
3108
|
+
# resp.retrieval_instruction_arn #=> String
|
|
3109
|
+
# resp.name #=> String
|
|
3110
|
+
# resp.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
3111
|
+
# resp.last_transition_status #=> String, one of "CREATING", "UPDATING", "CREATE_SUCCESSFUL", "CREATE_FAILED", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
|
3112
|
+
# resp.created_at #=> Time
|
|
3113
|
+
# resp.updated_at #=> Time
|
|
3114
|
+
#
|
|
3115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateRetrievalInstruction AWS API Documentation
|
|
3116
|
+
#
|
|
3117
|
+
# @overload create_retrieval_instruction(params = {})
|
|
3118
|
+
# @param [Hash] params ({})
|
|
3119
|
+
def create_retrieval_instruction(params = {}, options = {})
|
|
3120
|
+
req = build_request(:create_retrieval_instruction, params)
|
|
3121
|
+
req.send_request(options)
|
|
3122
|
+
end
|
|
3123
|
+
|
|
3124
|
+
# Creates an immutable numbered version from the retrieval
|
|
3125
|
+
# instruction's current reviewed content. The service creates the
|
|
3126
|
+
# version synchronously.
|
|
3127
|
+
#
|
|
3128
|
+
# The service numbers versions from 1 and assigns them in order, never
|
|
3129
|
+
# reusing a number.
|
|
3130
|
+
#
|
|
3131
|
+
# @option params [required, String] :retrieval_instruction_id
|
|
3132
|
+
# The identifier of the retrieval instruction to version.
|
|
3133
|
+
#
|
|
3134
|
+
# @option params [String] :description
|
|
3135
|
+
# A description of this version. Independent of the retrieval
|
|
3136
|
+
# instruction's own description.
|
|
3137
|
+
#
|
|
3138
|
+
# @option params [String] :client_token
|
|
3139
|
+
# A caller-supplied token that makes a retried call return the version
|
|
3140
|
+
# created by the first call rather than a second version. The window is
|
|
3141
|
+
# 8 hours.
|
|
3142
|
+
#
|
|
3143
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
3144
|
+
# not need to pass this option.**
|
|
3145
|
+
#
|
|
3146
|
+
# @return [Types::CreateRetrievalInstructionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3147
|
+
#
|
|
3148
|
+
# * {Types::CreateRetrievalInstructionVersionResponse#retrieval_instruction_id #retrieval_instruction_id} => String
|
|
3149
|
+
# * {Types::CreateRetrievalInstructionVersionResponse#retrieval_instruction_arn #retrieval_instruction_arn} => String
|
|
3150
|
+
# * {Types::CreateRetrievalInstructionVersionResponse#version #version} => String
|
|
3151
|
+
# * {Types::CreateRetrievalInstructionVersionResponse#created_at #created_at} => Time
|
|
3152
|
+
# * {Types::CreateRetrievalInstructionVersionResponse#description #description} => String
|
|
3153
|
+
#
|
|
3154
|
+
# @example Request syntax with placeholder values
|
|
3155
|
+
#
|
|
3156
|
+
# resp = client.create_retrieval_instruction_version({
|
|
3157
|
+
# retrieval_instruction_id: "RetrievalInstructionId", # required
|
|
3158
|
+
# description: "RetrievalInstructionDescription",
|
|
3159
|
+
# client_token: "ClientToken",
|
|
3160
|
+
# })
|
|
3161
|
+
#
|
|
3162
|
+
# @example Response structure
|
|
3163
|
+
#
|
|
3164
|
+
# resp.retrieval_instruction_id #=> String
|
|
3165
|
+
# resp.retrieval_instruction_arn #=> String
|
|
3166
|
+
# resp.version #=> String
|
|
3167
|
+
# resp.created_at #=> Time
|
|
3168
|
+
# resp.description #=> String
|
|
3169
|
+
#
|
|
3170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateRetrievalInstructionVersion AWS API Documentation
|
|
3171
|
+
#
|
|
3172
|
+
# @overload create_retrieval_instruction_version(params = {})
|
|
3173
|
+
# @param [Hash] params ({})
|
|
3174
|
+
def create_retrieval_instruction_version(params = {}, options = {})
|
|
3175
|
+
req = build_request(:create_retrieval_instruction_version, params)
|
|
3176
|
+
req.send_request(options)
|
|
3177
|
+
end
|
|
3178
|
+
|
|
3040
3179
|
# Creates a VPC configuration that lets a knowledge base connect to a
|
|
3041
3180
|
# resource in your private VPC. This operation is asynchronous: it
|
|
3042
3181
|
# returns a `vpcConfigurationId` with status `CREATING`. Poll
|
|
@@ -3657,6 +3796,52 @@ module Aws::BedrockAgent
|
|
|
3657
3796
|
req.send_request(options)
|
|
3658
3797
|
end
|
|
3659
3798
|
|
|
3799
|
+
# Deletes a retrieval instruction or a single version of it. Omit
|
|
3800
|
+
# retrievalInstructionVersion to delete the retrieval instruction
|
|
3801
|
+
# itself; the service rejects that request with ConflictException while
|
|
3802
|
+
# the retrieval instruction has versions or while lastTransitionStatus
|
|
3803
|
+
# is CREATING or UPDATING. Specify retrievalInstructionVersion to delete
|
|
3804
|
+
# only that version; the retrieval instruction and its other versions
|
|
3805
|
+
# are unaffected.
|
|
3806
|
+
#
|
|
3807
|
+
# @option params [required, String] :retrieval_instruction_id
|
|
3808
|
+
# The identifier of the retrieval instruction to delete.
|
|
3809
|
+
#
|
|
3810
|
+
# @option params [String] :retrieval_instruction_version
|
|
3811
|
+
# The version to delete. Omit this field to delete the retrieval
|
|
3812
|
+
# instruction itself, which you can do only when it has no versions;
|
|
3813
|
+
# while any version exists the service rejects the request with
|
|
3814
|
+
# ConflictException. You cannot delete DRAFT on its own; deleting the
|
|
3815
|
+
# retrieval instruction removes it.
|
|
3816
|
+
#
|
|
3817
|
+
# @return [Types::DeleteRetrievalInstructionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3818
|
+
#
|
|
3819
|
+
# * {Types::DeleteRetrievalInstructionResponse#retrieval_instruction_id #retrieval_instruction_id} => String
|
|
3820
|
+
# * {Types::DeleteRetrievalInstructionResponse#retrieval_instruction_arn #retrieval_instruction_arn} => String
|
|
3821
|
+
# * {Types::DeleteRetrievalInstructionResponse#version #version} => String
|
|
3822
|
+
#
|
|
3823
|
+
# @example Request syntax with placeholder values
|
|
3824
|
+
#
|
|
3825
|
+
# resp = client.delete_retrieval_instruction({
|
|
3826
|
+
# retrieval_instruction_id: "RetrievalInstructionId", # required
|
|
3827
|
+
# retrieval_instruction_version: "RetrievalInstructionNumericalVersion",
|
|
3828
|
+
# })
|
|
3829
|
+
#
|
|
3830
|
+
# @example Response structure
|
|
3831
|
+
#
|
|
3832
|
+
# resp.retrieval_instruction_id #=> String
|
|
3833
|
+
# resp.retrieval_instruction_arn #=> String
|
|
3834
|
+
# resp.version #=> String
|
|
3835
|
+
#
|
|
3836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteRetrievalInstruction AWS API Documentation
|
|
3837
|
+
#
|
|
3838
|
+
# @overload delete_retrieval_instruction(params = {})
|
|
3839
|
+
# @param [Hash] params ({})
|
|
3840
|
+
def delete_retrieval_instruction(params = {}, options = {})
|
|
3841
|
+
req = build_request(:delete_retrieval_instruction, params)
|
|
3842
|
+
req.send_request(options)
|
|
3843
|
+
end
|
|
3844
|
+
|
|
3660
3845
|
# Deletes a VPC configuration. This operation is asynchronous: it
|
|
3661
3846
|
# returns status `DELETING`. Poll `GetVpcConfiguration` until it returns
|
|
3662
3847
|
# a `ResourceNotFoundException`, indicating the configuration is
|
|
@@ -5020,6 +5205,72 @@ module Aws::BedrockAgent
|
|
|
5020
5205
|
req.send_request(options)
|
|
5021
5206
|
end
|
|
5022
5207
|
|
|
5208
|
+
# Gets a retrieval instruction. Also used to poll the terminal reporting
|
|
5209
|
+
# of an asynchronous create or update.
|
|
5210
|
+
#
|
|
5211
|
+
# @option params [required, String] :retrieval_instruction_id
|
|
5212
|
+
# The identifier of the retrieval instruction to get.
|
|
5213
|
+
#
|
|
5214
|
+
# @option params [String] :retrieval_instruction_version
|
|
5215
|
+
# The version to return: a version number, or DRAFT for the retrieval
|
|
5216
|
+
# instruction's current reviewed content. When omitted, DRAFT is used.
|
|
5217
|
+
# This default is permanent: omitting retrievalInstructionVersion will
|
|
5218
|
+
# never resolve to a numbered version.
|
|
5219
|
+
#
|
|
5220
|
+
# @return [Types::GetRetrievalInstructionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5221
|
+
#
|
|
5222
|
+
# * {Types::GetRetrievalInstructionResponse#retrieval_instruction_id #retrieval_instruction_id} => String
|
|
5223
|
+
# * {Types::GetRetrievalInstructionResponse#retrieval_instruction_arn #retrieval_instruction_arn} => String
|
|
5224
|
+
# * {Types::GetRetrievalInstructionResponse#name #name} => String
|
|
5225
|
+
# * {Types::GetRetrievalInstructionResponse#status #status} => String
|
|
5226
|
+
# * {Types::GetRetrievalInstructionResponse#last_transition_status #last_transition_status} => String
|
|
5227
|
+
# * {Types::GetRetrievalInstructionResponse#instruction #instruction} => Types::RetrievalInstructionContent
|
|
5228
|
+
# * {Types::GetRetrievalInstructionResponse#created_at #created_at} => Time
|
|
5229
|
+
# * {Types::GetRetrievalInstructionResponse#updated_at #updated_at} => Time
|
|
5230
|
+
# * {Types::GetRetrievalInstructionResponse#description #description} => String
|
|
5231
|
+
# * {Types::GetRetrievalInstructionResponse#customer_encryption_key_arn #customer_encryption_key_arn} => String
|
|
5232
|
+
# * {Types::GetRetrievalInstructionResponse#last_transition_status_reasons #last_transition_status_reasons} => Array<Types::RetrievalInstructionFailureReason>
|
|
5233
|
+
# * {Types::GetRetrievalInstructionResponse#version #version} => String
|
|
5234
|
+
# * {Types::GetRetrievalInstructionResponse#latest_version #latest_version} => String
|
|
5235
|
+
#
|
|
5236
|
+
# @example Request syntax with placeholder values
|
|
5237
|
+
#
|
|
5238
|
+
# resp = client.get_retrieval_instruction({
|
|
5239
|
+
# retrieval_instruction_id: "RetrievalInstructionId", # required
|
|
5240
|
+
# retrieval_instruction_version: "RetrievalInstructionVersionSelector",
|
|
5241
|
+
# })
|
|
5242
|
+
#
|
|
5243
|
+
# @example Response structure
|
|
5244
|
+
#
|
|
5245
|
+
# resp.retrieval_instruction_id #=> String
|
|
5246
|
+
# resp.retrieval_instruction_arn #=> String
|
|
5247
|
+
# resp.name #=> String
|
|
5248
|
+
# resp.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
5249
|
+
# resp.last_transition_status #=> String, one of "CREATING", "UPDATING", "CREATE_SUCCESSFUL", "CREATE_FAILED", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
|
5250
|
+
# resp.instruction.retrieval_guidance #=> String
|
|
5251
|
+
# resp.instruction.persona #=> String
|
|
5252
|
+
# resp.instruction.answer_format #=> String
|
|
5253
|
+
# resp.instruction.answer_policy #=> String
|
|
5254
|
+
# resp.created_at #=> Time
|
|
5255
|
+
# resp.updated_at #=> Time
|
|
5256
|
+
# resp.description #=> String
|
|
5257
|
+
# resp.customer_encryption_key_arn #=> String
|
|
5258
|
+
# resp.last_transition_status_reasons #=> Array
|
|
5259
|
+
# resp.last_transition_status_reasons[0].field_name #=> String, one of "RETRIEVAL_GUIDANCE", "PERSONA", "ANSWER_FORMAT", "ANSWER_POLICY"
|
|
5260
|
+
# resp.last_transition_status_reasons[0].code #=> String, one of "CONTENT_REJECTED", "CLIENT_ERROR", "INTERNAL_ERROR"
|
|
5261
|
+
# resp.last_transition_status_reasons[0].message #=> String
|
|
5262
|
+
# resp.version #=> String
|
|
5263
|
+
# resp.latest_version #=> String
|
|
5264
|
+
#
|
|
5265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetRetrievalInstruction AWS API Documentation
|
|
5266
|
+
#
|
|
5267
|
+
# @overload get_retrieval_instruction(params = {})
|
|
5268
|
+
# @param [Hash] params ({})
|
|
5269
|
+
def get_retrieval_instruction(params = {}, options = {})
|
|
5270
|
+
req = build_request(:get_retrieval_instruction, params)
|
|
5271
|
+
req.send_request(options)
|
|
5272
|
+
end
|
|
5273
|
+
|
|
5023
5274
|
# Returns the details and current status of a single VPC configuration.
|
|
5024
5275
|
# Use this operation to poll for the outcome of an asynchronous create
|
|
5025
5276
|
# or delete.
|
|
@@ -6012,6 +6263,104 @@ module Aws::BedrockAgent
|
|
|
6012
6263
|
req.send_request(options)
|
|
6013
6264
|
end
|
|
6014
6265
|
|
|
6266
|
+
# Lists the numbered versions of a retrieval instruction, newest first.
|
|
6267
|
+
# DRAFT is not listed; read it with GetRetrievalInstruction without
|
|
6268
|
+
# retrievalInstructionVersion. Results are paginated. Use the nextToken
|
|
6269
|
+
# parameter to retrieve additional results.
|
|
6270
|
+
#
|
|
6271
|
+
# @option params [required, String] :retrieval_instruction_id
|
|
6272
|
+
# The identifier of the retrieval instruction whose versions to list.
|
|
6273
|
+
#
|
|
6274
|
+
# @option params [Integer] :max_results
|
|
6275
|
+
# Specifies the maximum number of versions to return in a single page.
|
|
6276
|
+
# The service enforces the effective upper bound.
|
|
6277
|
+
#
|
|
6278
|
+
# @option params [String] :next_token
|
|
6279
|
+
# The pagination token from a previous ListRetrievalInstructionVersions
|
|
6280
|
+
# response.
|
|
6281
|
+
#
|
|
6282
|
+
# @return [Types::ListRetrievalInstructionVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6283
|
+
#
|
|
6284
|
+
# * {Types::ListRetrievalInstructionVersionsResponse#retrieval_instruction_version_summaries #retrieval_instruction_version_summaries} => Array<Types::RetrievalInstructionVersionSummary>
|
|
6285
|
+
# * {Types::ListRetrievalInstructionVersionsResponse#next_token #next_token} => String
|
|
6286
|
+
#
|
|
6287
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
6288
|
+
#
|
|
6289
|
+
# @example Request syntax with placeholder values
|
|
6290
|
+
#
|
|
6291
|
+
# resp = client.list_retrieval_instruction_versions({
|
|
6292
|
+
# retrieval_instruction_id: "RetrievalInstructionId", # required
|
|
6293
|
+
# max_results: 1,
|
|
6294
|
+
# next_token: "NextToken",
|
|
6295
|
+
# })
|
|
6296
|
+
#
|
|
6297
|
+
# @example Response structure
|
|
6298
|
+
#
|
|
6299
|
+
# resp.retrieval_instruction_version_summaries #=> Array
|
|
6300
|
+
# resp.retrieval_instruction_version_summaries[0].version #=> String
|
|
6301
|
+
# resp.retrieval_instruction_version_summaries[0].created_at #=> Time
|
|
6302
|
+
# resp.next_token #=> String
|
|
6303
|
+
#
|
|
6304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListRetrievalInstructionVersions AWS API Documentation
|
|
6305
|
+
#
|
|
6306
|
+
# @overload list_retrieval_instruction_versions(params = {})
|
|
6307
|
+
# @param [Hash] params ({})
|
|
6308
|
+
def list_retrieval_instruction_versions(params = {}, options = {})
|
|
6309
|
+
req = build_request(:list_retrieval_instruction_versions, params)
|
|
6310
|
+
req.send_request(options)
|
|
6311
|
+
end
|
|
6312
|
+
|
|
6313
|
+
# Lists the retrieval instructions in the caller's account. Results are
|
|
6314
|
+
# paginated. Use the nextToken parameter to retrieve additional results.
|
|
6315
|
+
#
|
|
6316
|
+
# @option params [String] :status
|
|
6317
|
+
# Return only instructions with this availability status.
|
|
6318
|
+
#
|
|
6319
|
+
# @option params [Integer] :max_results
|
|
6320
|
+
# The maximum number of results to return in a single page. The
|
|
6321
|
+
# effective upper bound is enforced service-side.
|
|
6322
|
+
#
|
|
6323
|
+
# @option params [String] :next_token
|
|
6324
|
+
# The pagination token from a previous ListRetrievalInstructions
|
|
6325
|
+
# response.
|
|
6326
|
+
#
|
|
6327
|
+
# @return [Types::ListRetrievalInstructionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6328
|
+
#
|
|
6329
|
+
# * {Types::ListRetrievalInstructionsResponse#retrieval_instruction_summaries #retrieval_instruction_summaries} => Array<Types::RetrievalInstructionSummary>
|
|
6330
|
+
# * {Types::ListRetrievalInstructionsResponse#next_token #next_token} => String
|
|
6331
|
+
#
|
|
6332
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
6333
|
+
#
|
|
6334
|
+
# @example Request syntax with placeholder values
|
|
6335
|
+
#
|
|
6336
|
+
# resp = client.list_retrieval_instructions({
|
|
6337
|
+
# status: "ACTIVE", # accepts ACTIVE, INACTIVE
|
|
6338
|
+
# max_results: 1,
|
|
6339
|
+
# next_token: "NextToken",
|
|
6340
|
+
# })
|
|
6341
|
+
#
|
|
6342
|
+
# @example Response structure
|
|
6343
|
+
#
|
|
6344
|
+
# resp.retrieval_instruction_summaries #=> Array
|
|
6345
|
+
# resp.retrieval_instruction_summaries[0].retrieval_instruction_id #=> String
|
|
6346
|
+
# resp.retrieval_instruction_summaries[0].retrieval_instruction_arn #=> String
|
|
6347
|
+
# resp.retrieval_instruction_summaries[0].name #=> String
|
|
6348
|
+
# resp.retrieval_instruction_summaries[0].status #=> String, one of "ACTIVE", "INACTIVE"
|
|
6349
|
+
# resp.retrieval_instruction_summaries[0].last_transition_status #=> String, one of "CREATING", "UPDATING", "CREATE_SUCCESSFUL", "CREATE_FAILED", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
|
6350
|
+
# resp.retrieval_instruction_summaries[0].created_at #=> Time
|
|
6351
|
+
# resp.retrieval_instruction_summaries[0].updated_at #=> Time
|
|
6352
|
+
# resp.retrieval_instruction_summaries[0].description #=> String
|
|
6353
|
+
# resp.next_token #=> String
|
|
6354
|
+
#
|
|
6355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListRetrievalInstructions AWS API Documentation
|
|
6356
|
+
#
|
|
6357
|
+
# @overload list_retrieval_instructions(params = {})
|
|
6358
|
+
# @param [Hash] params ({})
|
|
6359
|
+
def list_retrieval_instructions(params = {}, options = {})
|
|
6360
|
+
req = build_request(:list_retrieval_instructions, params)
|
|
6361
|
+
req.send_request(options)
|
|
6362
|
+
end
|
|
6363
|
+
|
|
6015
6364
|
# List all the tags for the resource you specify.
|
|
6016
6365
|
#
|
|
6017
6366
|
# @option params [required, String] :resource_arn
|
|
@@ -8462,6 +8811,66 @@ module Aws::BedrockAgent
|
|
|
8462
8811
|
req.send_request(options)
|
|
8463
8812
|
end
|
|
8464
8813
|
|
|
8814
|
+
# Updates the content of a retrieval instruction. The update is
|
|
8815
|
+
# processed asynchronously; the stored content is a candidate until
|
|
8816
|
+
# content review passes, and the served content does not change while
|
|
8817
|
+
# the update is in flight. The service rejects the request with
|
|
8818
|
+
# ConflictException while lastTransitionStatus is CREATING or UPDATING.
|
|
8819
|
+
#
|
|
8820
|
+
# @option params [required, String] :retrieval_instruction_id
|
|
8821
|
+
# The identifier of the retrieval instruction to update.
|
|
8822
|
+
#
|
|
8823
|
+
# @option params [required, Types::RetrievalInstructionContent] :instruction
|
|
8824
|
+
# The replacement instruction content. This is a full replacement of all
|
|
8825
|
+
# four fields, not a patch. During UPDATING, Get continues to return the
|
|
8826
|
+
# previously-served content until the update review passes.
|
|
8827
|
+
#
|
|
8828
|
+
# @option params [String] :description
|
|
8829
|
+
# A replacement description; applied together with the content when the
|
|
8830
|
+
# review passes. Omit to clear.
|
|
8831
|
+
#
|
|
8832
|
+
# @return [Types::UpdateRetrievalInstructionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8833
|
+
#
|
|
8834
|
+
# * {Types::UpdateRetrievalInstructionResponse#retrieval_instruction_id #retrieval_instruction_id} => String
|
|
8835
|
+
# * {Types::UpdateRetrievalInstructionResponse#retrieval_instruction_arn #retrieval_instruction_arn} => String
|
|
8836
|
+
# * {Types::UpdateRetrievalInstructionResponse#name #name} => String
|
|
8837
|
+
# * {Types::UpdateRetrievalInstructionResponse#status #status} => String
|
|
8838
|
+
# * {Types::UpdateRetrievalInstructionResponse#last_transition_status #last_transition_status} => String
|
|
8839
|
+
# * {Types::UpdateRetrievalInstructionResponse#created_at #created_at} => Time
|
|
8840
|
+
# * {Types::UpdateRetrievalInstructionResponse#updated_at #updated_at} => Time
|
|
8841
|
+
#
|
|
8842
|
+
# @example Request syntax with placeholder values
|
|
8843
|
+
#
|
|
8844
|
+
# resp = client.update_retrieval_instruction({
|
|
8845
|
+
# retrieval_instruction_id: "RetrievalInstructionId", # required
|
|
8846
|
+
# instruction: { # required
|
|
8847
|
+
# retrieval_guidance: "RetrievalInstructionFieldText",
|
|
8848
|
+
# persona: "RetrievalInstructionFieldText",
|
|
8849
|
+
# answer_format: "RetrievalInstructionFieldText",
|
|
8850
|
+
# answer_policy: "RetrievalInstructionFieldText",
|
|
8851
|
+
# },
|
|
8852
|
+
# description: "RetrievalInstructionDescription",
|
|
8853
|
+
# })
|
|
8854
|
+
#
|
|
8855
|
+
# @example Response structure
|
|
8856
|
+
#
|
|
8857
|
+
# resp.retrieval_instruction_id #=> String
|
|
8858
|
+
# resp.retrieval_instruction_arn #=> String
|
|
8859
|
+
# resp.name #=> String
|
|
8860
|
+
# resp.status #=> String, one of "ACTIVE", "INACTIVE"
|
|
8861
|
+
# resp.last_transition_status #=> String, one of "CREATING", "UPDATING", "CREATE_SUCCESSFUL", "CREATE_FAILED", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
|
8862
|
+
# resp.created_at #=> Time
|
|
8863
|
+
# resp.updated_at #=> Time
|
|
8864
|
+
#
|
|
8865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateRetrievalInstruction AWS API Documentation
|
|
8866
|
+
#
|
|
8867
|
+
# @overload update_retrieval_instruction(params = {})
|
|
8868
|
+
# @param [Hash] params ({})
|
|
8869
|
+
def update_retrieval_instruction(params = {}, options = {})
|
|
8870
|
+
req = build_request(:update_retrieval_instruction, params)
|
|
8871
|
+
req.send_request(options)
|
|
8872
|
+
end
|
|
8873
|
+
|
|
8465
8874
|
# Validates the definition of a flow.
|
|
8466
8875
|
#
|
|
8467
8876
|
# @option params [required, Types::FlowDefinition] :definition
|
|
@@ -8820,7 +9229,7 @@ module Aws::BedrockAgent
|
|
|
8820
9229
|
tracer: tracer
|
|
8821
9230
|
)
|
|
8822
9231
|
context[:gem_name] = 'aws-sdk-bedrockagent'
|
|
8823
|
-
context[:gem_version] = '1.
|
|
9232
|
+
context[:gem_version] = '1.88.0'
|
|
8824
9233
|
Seahorse::Client::Request.new(handlers, context)
|
|
8825
9234
|
end
|
|
8826
9235
|
|