lib/aws-sdk-bedrockagent/client.rb in aws-sdk-bedrockagent-1.4.0 vs lib/aws-sdk-bedrockagent/client.rb in aws-sdk-bedrockagent-1.5.0

- old
+ new

@@ -453,15 +453,15 @@ # models, data sources, software applications, user conversations, and # APIs to carry out tasks to help customers. # # * Specify the following fields for security purposes. # - # * `agentResourceRoleArn` – The ARN of the role with permissions to - # create an agent. + # * `agentResourceRoleArn` – The Amazon Resource Name (ARN) of the + # role with permissions to invoke API operations on an agent. # - # * (Optional) `customerEncryptionKeyArn` – The ARN of a KMS key to - # encrypt the creation of the agent. + # * (Optional) `customerEncryptionKeyArn` – The Amazon Resource Name + # (ARN) of a KMS key to encrypt the creation of the agent. # # * (Optional) `idleSessionTTLinSeconds` – Specify the number of # seconds for which the agent should maintain session information. # After this time expires, the subsequent `InvokeAgent` request # begins a new session. @@ -479,13 +479,13 @@ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html # # @option params [required, String] :agent_name # A name for the agent that you create. # - # @option params [required, String] :agent_resource_role_arn - # The ARN of the IAM role with permissions to create the agent. The ARN - # must begin with `AmazonBedrockExecutionRoleForAgents_`. + # @option params [String] :agent_resource_role_arn + # The Amazon Resource Name (ARN) of the IAM role with permissions to + # invoke API operations on the agent. # # @option params [String] :client_token # A unique, case-sensitive identifier to ensure that the API request # completes no more than one time. If this token matches a previous # request, Amazon Bedrock ignores the request, but does not return an @@ -497,11 +497,12 @@ # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html # # @option params [String] :customer_encryption_key_arn - # The ARN of the KMS key with which to encrypt the agent. + # The Amazon Resource Name (ARN) of the KMS key with which to encrypt + # the agent. # # @option params [String] :description # A description of the agent. # # @option params [String] :foundation_model @@ -537,11 +538,11 @@ # # @example Request syntax with placeholder values # # resp = client.create_agent({ # agent_name: "Name", # required - # agent_resource_role_arn: "AgentRoleArn", # required + # agent_resource_role_arn: "AgentRoleArn", # client_token: "ClientToken", # customer_encryption_key_arn: "KmsKeyArn", # description: "Description", # foundation_model: "ModelIdentifier", # idle_session_ttl_in_seconds: 1, @@ -631,12 +632,12 @@ # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html # # @option params [Types::ActionGroupExecutor] :action_group_executor - # The ARN of the Lambda function containing the business logic that is - # carried out upon invoking the action. + # The Amazon Resource Name (ARN) of the Lambda function containing the + # business logic that is carried out upon invoking the action. # # @option params [required, String] :action_group_name # The name to give the action group. # # @option params [String] :action_group_state @@ -934,12 +935,12 @@ # # </note> # # * Provide the `name` and an optional `description`. # - # * Provide the ARN with permissions to create a knowledge base in the - # `roleArn` field. + # * Provide the Amazon Resource Name (ARN) with permissions to create a + # knowledge base in the `roleArn` field. # # * Provide the embedding model to use in the `embeddingModelArn` field # in the `knowledgeBaseConfiguration` object. # # * Provide the configuration for your vector store in the @@ -991,11 +992,12 @@ # # @option params [required, String] :name # A name for the knowledge base. # # @option params [required, String] :role_arn - # The ARN of the IAM role with permissions to create the knowledge base. + # The Amazon Resource Name (ARN) of the IAM role with permissions to + # invoke API operations on the knowledge base. # # @option params [required, Types::StorageConfiguration] :storage_configuration # Contains details about the configuration of the vector database used # for the knowledge base. # @@ -2252,11 +2254,11 @@ end # List all the tags for the resource you specify. # # @option params [required, String] :resource_arn - # The ARN of the resource for which to list tags. + # The Amazon Resource Name (ARN) of the resource for which to list tags. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt; # @@ -2389,11 +2391,11 @@ # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html # # @option params [required, String] :resource_arn - # The ARN of the resource to tag. + # The Amazon Resource Name (ARN) of the resource to tag. # # @option params [required, Hash<String,String>] :tags # An object containing key-value pairs that define the tags to attach to # the resource. # @@ -2418,11 +2420,12 @@ end # Remove tags from a resource. # # @option params [required, String] :resource_arn - # The ARN of the resource from which to remove tags. + # The Amazon Resource Name (ARN) of the resource from which to remove + # tags. # # @option params [required, Array<String>] :tag_keys # A list of keys of the tags to remove from the resource. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -2450,15 +2453,16 @@ # # @option params [required, String] :agent_name # Specifies a new name for the agent. # # @option params [required, String] :agent_resource_role_arn - # The ARN of the IAM role with permissions to update the agent. The ARN - # must begin with `AmazonBedrockExecutionRoleForAgents_`. + # The Amazon Resource Name (ARN) of the IAM role with permissions to + # invoke API operations on the agent. # # @option params [String] :customer_encryption_key_arn - # The ARN of the KMS key with which to encrypt the agent. + # The Amazon Resource Name (ARN) of the KMS key with which to encrypt + # the agent. # # @option params [String] :description # Specifies a new description of the agent. # # @option params [required, String] :foundation_model @@ -2566,12 +2570,12 @@ end # Updates the configuration for an action group for an agent. # # @option params [Types::ActionGroupExecutor] :action_group_executor - # The ARN of the Lambda function containing the business logic that is - # carried out upon invoking the action. + # The Amazon Resource Name (ARN) of the Lambda function containing the + # business logic that is carried out upon invoking the action. # # @option params [required, String] :action_group_id # The unique identifier of the action group. # # @option params [required, String] :action_group_name @@ -2917,11 +2921,11 @@ # @option params [required, String] :name # Specifies a new name for the knowledge base. # # @option params [required, String] :role_arn # Specifies a different Amazon Resource Name (ARN) of the IAM role with - # permissions to modify the knowledge base. + # permissions to invoke API operations on the knowledge base. # # @option params [required, Types::StorageConfiguration] :storage_configuration # Specifies the configuration for the vector store used for the # knowledge base. You must use the same configuration as when the # knowledge base was created. @@ -3048,10 +3052,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-bedrockagent' - context[:gem_version] = '1.4.0' + context[:gem_version] = '1.5.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated