Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The name of the human loop that you want to delete.

[required] The name of the human loop that you want information about.

(Optional) The timestamp of the date when you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.

(Optional) The timestamp of the date before which you want the human loops to begin in ISO 8601 format. For example, 2020-02-24.

[required] The Amazon Resource Name (ARN) of a flow definition.

Optional. The order for displaying results. Valid values: Ascending and Descending.

A token to display the next page of results.

The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken is returned in the output. You can use this token to display the next page of results.

[required] The name of the human loop.

[required] The Amazon Resource Name (ARN) of the flow definition associated with this human loop.

[required] An object that contains information about the human loop.

Attributes of the specified data. Use DataAttributes to specify if your data is free of personally identifiable information and/or free of adult content.

[required] The name of the human loop that you want to stop.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] A list of one or more evaluation job Amazon Resource Names (ARNs) you want to delete.

[required] A name for the evaluation job. Names must unique with your Amazon Web Services account, and your account's Amazon Web Services region.

A description of the evaluation job.

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 error. For more information, see Ensuring idempotency.

[required] The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see Required permissions for model evaluations.

Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.

Tags to attach to the model evaluation job.

Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).

[required] Contains the configuration details of either an automated or human-based evaluation job.

[required] Contains the configuration details of the inference model for the evaluation job.

For model evaluation jobs, automated jobs support a single model or inference profile, and jobs that use human workers support two models or inference profiles.

[required] Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.

[required] The name to give the guardrail.

A description of the guardrail.

The topic policies to configure for the guardrail.

The content filter policies to configure for the guardrail.

The word policy you configure for the guardrail.

The sensitive information policy to configure for the guardrail.

The contextual grounding policy configuration used to create a guardrail.

[required] The message to return when the guardrail blocks a prompt.

[required] The message to return when the guardrail blocks a model response.

The ARN of the KMS key that you use to encrypt the guardrail.

The tags that you want to attach to the guardrail.

A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

[required] The unique identifier of the guardrail. This can be an ID or the ARN.

A description of the guardrail version.

A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

[required] A name for the inference profile.

A description for the inference profile.

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 error. For more information, see Ensuring idempotency.

[required] The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.

An array of objects, each of which contains a tag and its value. For more information, see Tagging resources in the Amazon Bedrock User Guide.

[required] The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint.

[required] The configuration for the endpoint, including the number and type of instances to use.

Indicates whether you accept the end-user license agreement (EULA) for the model. Set to true to accept the EULA.

[required] The name of the endpoint. This name must be unique within your Amazon Web Services account and region.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail.

An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your Amazon Web Services resources.

[required] The Amazon Resource Name (ARN) of the model to be copied.

[required] A name for the copied model.

The ARN of the KMS key that you use to encrypt the model copy.

Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide.

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 error. For more information, see Ensuring idempotency.

[required] A name for the fine-tuning job.

[required] A name for the resulting custom model.

[required] The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.

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 error. For more information, see Ensuring idempotency.

[required] Name of the base model.

The customization type.

The custom model is encrypted at rest using this key.

Tags to attach to the job.

Tags to attach to the resulting custom model.

[required] Information about the training dataset.

Information about the validation dataset.

[required] S3 location for the output data.

Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.

The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see Protect your model customization jobs using a VPC.

The customization configuration for the model customization job.

[required] The name of the import job.

[required] The name of the imported model.

[required] The Amazon Resource Name (ARN) of the model import job.

[required] The data source for the imported model.

Tags to attach to this import job.

Tags to attach to the imported model.

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 error. For more information, see Ensuring idempotency.

VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.

The imported model is encrypted at rest using this key.

[required] A name to give the batch inference job.

[required] The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at Create a service role for batch inference.

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 error. For more information, see Ensuring idempotency.

[required] The unique identifier of the foundation model to use for the batch inference job.

[required] Details about the location of the input to the batch inference job.

[required] Details about the location of the output of the batch inference job.

The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see Protect batch inference jobs using a VPC.

The number of hours after which to force the batch inference job to time out.

Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources.

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 error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

[required] Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.

For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.

For more information about what an MU specifies, contact your Amazon Web Services account manager.

[required] The name for this Provisioned Throughput.

[required] The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.

The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.

Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide

Tags to associate with this Provisioned Throughput.

[required] Name of the model to delete.

[required] The unique identifier of the guardrail. This can be an ID or the ARN.

The version of the guardrail.

[required] Name of the imported model to delete.

[required] The Amazon Resource Name (ARN) or ID of the application inference profile to delete.

[required] The Amazon Resource Name (ARN) of the endpoint you want to delete.

[required] The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

[required] The Amazon Resource Name (ARN) of the endpoint you want to deregister.

[required] Name or Amazon Resource Name (ARN) of the custom model.

[required] The Amazon Resource Name (ARN) of the evaluation job you want get information on.

[required] The model identifier.

[required] The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.

The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the DRAFT version.

[required] Name or Amazon Resource Name (ARN) of the imported model.

[required] The ID or Amazon Resource Name (ARN) of the inference profile.

[required] The Amazon Resource Name (ARN) of the endpoint you want to get information about.

[required] The Amazon Resource Name (ARN) of the model copy job.

[required] Identifier for the customization job.

[required] The identifier of the import job.

[required] The Amazon Resource Name (ARN) of the batch inference job.

[required] The prompt router's ARN

[required] The Amazon Resource Name (ARN) or name of the Provisioned Throughput.

Return custom models created before the specified time.

Return custom models created after the specified time.

Return custom models only if the job name contains these characters.

Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.

Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The field to sort by in the returned list of models.

The sort order of the results.

Return custom models depending on if the current account owns them (true) or if they were shared with the current account (false).

A filter to only list evaluation jobs created after a specified time.

A filter to only list evaluation jobs created before a specified time.

A filter to only list evaluation jobs that are of a certain status.

A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.

A filter to only list evaluation jobs that contain a specified string in the job name.

The maximum number of results to return.

Continuation token from the previous response, for Amazon Bedrock to list the next set of results.

Specifies a creation time to sort the list of evaluation jobs by when they were created.

Specifies whether to sort the list of evaluation jobs by either ascending or descending order.

Return models belonging to the model provider that you specify.

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

Return models that support the output modality that you specify.

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

The unique identifier of the guardrail. This can be an ID or the ARN.

The maximum number of results to return in the response.

If there are more results than were returned in the response, the response returns a nextToken that you can send in another list_guardrails request to see the next batch of results.

Return imported models that created before the specified time.

Return imported models that were created after the specified time.

Return imported models only if the model name contains these characters.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The field to sort by in the returned list of imported models.

Specifies whetehr to sort the results in ascending or descending order.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Filters for inference profiles that match the type you specify.

• SYSTEM_DEFINED – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.

• APPLICATION – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.

The maximum number of results to return in a single call. If more results are available, the operation returns a NextToken value.

The token for the next set of results. You receive this token from a previous list_marketplace_model_endpoints call.

If specified, only endpoints for the given model source identifier are returned.

Filters for model copy jobs created after the specified time.

Filters for model copy jobs created before the specified time.

Filters for model copy jobs whose status matches the value that you specify.

Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.

Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.

Filters for model copy jobs in which the name of the copied model contains the string that you specify.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The field to sort by in the returned list of model copy jobs.

Specifies whether to sort the results in ascending or descending order.

Return customization jobs created after the specified time.

Return customization jobs created before the specified time.

Return customization jobs with the specified status.

Return customization jobs only if the job name contains these characters.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The field to sort by in the returned list of jobs.

The sort order of the results.

Return import jobs that were created after the specified time.

Return import jobs that were created before the specified time.

Return imported jobs with the specified status.

Return imported jobs only if the job name contains these characters.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The field to sort by in the returned list of imported jobs.

Specifies whether to sort the results in ascending or descending order.

Specify a time to filter for batch inference jobs that were submitted after the time you specify.

Specify a time to filter for batch inference jobs that were submitted before the time you specify.

Specify a status to filter for batch inference jobs whose statuses match the string you specify.

The following statuses are possible:

• Submitted – This job has been submitted to a queue for validation.

• Validating – This job is being validated for the requirements described in Format and upload your batch inference data. The criteria include the following:

  • Your IAM service role has access to the Amazon S3 buckets containing your files.

  • Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the modelInput value matches the request body for the model.

  • Your files fulfill the requirements for file size and number of records. For more information, see Quotas for Amazon Bedrock.

• Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.

• Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.

• InProgress – This job has begun. You can start viewing the results in the output S3 location.

• Completed – This job has successfully completed. View the output files in the output S3 location.

• PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.

• Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the Amazon Web Services Support Center.

• Stopped – This job was stopped by a user.

• Stopping – This job is being stopped by a user.

Specify a string to filter for batch inference jobs whose names contain the string.

The maximum number of results to return. If there are more results than the number that you specify, a nextToken value is returned. Use the nextToken in a request to return the next batch of results.

If there were more results than the value you specified in the maxResults field in a previous list_model_invocation_jobs request, the response would have returned a nextToken value. To see the next batch of results, send the nextToken value in another request.

An attribute by which to sort the results.

Specifies whether to sort the results by ascending or descending order.

The maximum number of prompt routers to return in one page of results.

Specify the pagination token from a previous request to retrieve the next page of results.

A filter that returns Provisioned Throughputs created after the specified time.

A filter that returns Provisioned Throughputs created before the specified time.

A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.

A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.

A filter that returns Provisioned Throughputs if their name contains the expression that you specify.

THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a nextToken value. To see the next batch of results, send the nextToken value in another list request.

If there are more results than the number you specified in the maxResults field, the response returns a nextToken value. To see the next batch of results, specify the nextToken value in this field.

The field by which to sort the returned list of Provisioned Throughputs.

The sort order of the results.

[required] The Amazon Resource Name (ARN) of the resource.

[required] The logging configuration values to set.

[required] The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace.

[required] The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint.

[required] The Amazon Resource Name (ARN) of the evaluation job you want to stop.

[required] Job identifier of the job to stop.

[required] The Amazon Resource Name (ARN) of the batch inference job to stop.

[required] The Amazon Resource Name (ARN) of the resource to tag.

[required] Tags to associate with the resource.

[required] The Amazon Resource Name (ARN) of the resource to untag.

[required] Tag keys of the tags to remove from the resource.

[required] The unique identifier of the guardrail. This can be an ID or the ARN.

[required] A name for the guardrail.

A description of the guardrail.

The topic policy to configure for the guardrail.

The content policy to configure for the guardrail.

The word policy to configure for the guardrail.

The sensitive information policy to configure for the guardrail.

The contextual grounding policy configuration used to update a guardrail.

[required] The message to return when the guardrail blocks a prompt.

[required] The message to return when the guardrail blocks a model response.

The ARN of the KMS key with which to encrypt the guardrail.

[required] The Amazon Resource Name (ARN) of the endpoint you want to update.

[required] The new configuration for the endpoint, including the number and type of instances to use.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because Amazon Web Services SDKs automatically generate it for you and set this parameter. If you're not using the Amazon Web Services SDK or the CLI, you must provide this token or the action will fail.

[required] The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.

The new name for this Provisioned Throughput.

The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.

If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:

• The base model from which the custom model was customized.

• Another custom model that was customized from the same base model as the custom model.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The alias of the collaborator agent.

[required] The agent's ID.

[required] An agent version.

A client token.

[required] Instruction for the collaborator.

[required] A name for the collaborator.

A relay conversation history for the collaborator.

[required] The unique identifier of the agent with which you want to associate the knowledge base.

[required] The version of the agent with which you want to associate the knowledge base.

[required] A description of what the agent should use the knowledge base for.

[required] The unique identifier of the knowledge base to associate with the agent.

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

The agent's collaboration role.

[required] A name for the agent that you create.

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

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 error. For more information, see Ensuring idempotency.

Contains details of the custom orchestration configured for the agent.

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

A description of the agent.

The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

The unique Guardrail configuration assigned to the agent when it is created.

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

Instructions that tell the agent what it should do and how it should interact with users.

Contains the details of the memory configured for the agent.

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

Any tags that you want to attach to the agent.

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

[required] The name to give the action group.

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

[required] The unique identifier of the agent for which to create the action group.

[required] The version of the agent for which to create the action group.

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

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 error. For more information, see Ensuring idempotency.

A description of the action group.

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

[required] The name of the alias.

[required] The unique identifier of the agent.

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 error. For more information, see Ensuring idempotency.

A description of the alias of the agent.

Contains details about the routing configuration of the alias.

Any tags that you want to attach to the alias of the agent.

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 error. For more information, see Ensuring idempotency.

The data deletion policy for the data source.

You can set the data deletion policy to:

• DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

• RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

[required] The connection configuration for the data source.

A description of the data source.

[required] The unique identifier of the knowledge base to which to add the data source.

[required] The name of the data source.

Contains details about the server-side encryption for the data source.

Contains details about how to ingest the documents in the data source.

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 error. For more information, see Ensuring idempotency.

The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

A definition of the nodes and connections between nodes in the flow.

A description for the flow.

[required] The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

[required] A name for the flow.

Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.

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 error. For more information, see Ensuring idempotency.

A description for the alias.

[required] The unique identifier of the flow for which to create an alias.

[required] A name for the alias.

[required] Contains information about the version to which to map the alias.

Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.

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 error. For more information, see Ensuring idempotency.

A description of the version of the flow.

[required] The unique identifier of the flow that you want to create a version of.

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 error. For more information, see Ensuring idempotency.

A description of the knowledge base.

[required] Contains details about the embeddings model used for the knowledge base.

[required] A name for the knowledge base.

[required] The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

Contains details about the configuration of the vector database used for the knowledge base.

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

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 error. For more information, see Ensuring idempotency.

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

A description for the prompt.

[required] A name for the prompt.

Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.

A list of objects, each containing details about a variant of the prompt.

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 error. For more information, see Ensuring idempotency.

A description for the version of the prompt.

[required] The unique identifier of the prompt that you want to create a version of.

Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.

[required] The unique identifier of the agent to delete.

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

[required] The unique identifier of the action group to delete.

[required] The unique identifier of the agent that the action group belongs to.

[required] The version of the agent that the action group belongs to.

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

[required] The unique identifier of the alias to delete.

[required] The unique identifier of the agent that the alias belongs to.

[required] The unique identifier of the agent that the version belongs to.

[required] The version of the agent to delete.

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

[required] The unique identifier of the data source to delete.

[required] The unique identifier of the knowledge base from which to delete the data source.

[required] The unique identifier of the flow.

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

[required] The unique identifier of the alias to be deleted.

[required] The unique identifier of the flow that the alias belongs to.

[required] The unique identifier of the flow whose version that you want to delete

[required] The version of the flow that you want to delete.

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

[required] The unique identifier of the knowledge base to delete.

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 error. For more information, see Ensuring idempotency.

[required] The unique identifier of the data source that contains the documents.

[required] A list of objects, each of which contains information to identify a document to delete.

[required] The unique identifier of the knowledge base that is connected to the data source.

[required] The unique identifier of the prompt.

The version of the prompt to delete. To delete the prompt, omit this field.

[required] An agent ID.

[required] The agent's version.

[required] The collaborator's ID.

[required] The unique identifier of the agent from which to disassociate the knowledge base.

[required] The version of the agent from which to disassociate the knowledge base.

[required] The unique identifier of the knowledge base to disassociate.

[required] The unique identifier of the agent.

[required] The unique identifier of the action group for which to get information.

[required] The unique identifier of the agent that the action group belongs to.

[required] The version of the agent that the action group belongs to.

[required] The unique identifier of the alias for which to get information.

[required] The unique identifier of the agent to which the alias to get information belongs.

[required] The agent's ID.

[required] The agent's version.

[required] The collaborator's ID.

[required] The unique identifier of the agent with which the knowledge base is associated.

[required] The version of the agent with which the knowledge base is associated.

[required] The unique identifier of the knowledge base associated with the agent.

[required] The unique identifier of the agent.

[required] The version of the agent.

[required] The unique identifier of the data source.

[required] The unique identifier of the knowledge base for the data source.

[required] The unique identifier of the flow.

[required] The unique identifier of the alias for which to retrieve information.

[required] The unique identifier of the flow that the alias belongs to.

[required] The unique identifier of the flow for which to get information.

[required] The version of the flow for which to get information.

[required] The unique identifier of the data source for the data ingestion job you want to get information on.

[required] The unique identifier of the data ingestion job you want to get information on.

[required] The unique identifier of the knowledge base for the data ingestion job you want to get information on.

[required] The unique identifier of the knowledge base you want to get information on.

[required] The unique identifier of the data source that contains the documents.

[required] A list of objects, each of which contains information to identify a document for which to retrieve information.

[required] The unique identifier of the knowledge base that is connected to the data source.

[required] The unique identifier of the prompt.

The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.

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 error. For more information, see Ensuring idempotency.

[required] The unique identifier of the data source connected to the knowledge base that you're adding documents to.

[required] A list of objects, each of which contains information about the documents to add.

[required] The unique identifier of the knowledge base to ingest the documents into.

[required] The unique identifier of the agent.

[required] The version of the agent.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The unique identifier of the agent.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The agent's ID.

[required] The agent's version.

The maximum number of agent collaborators to return in one page of results.

Specify the pagination token from a previous request to retrieve the next page of results.

[required] The unique identifier of the agent for which to return information about knowledge bases associated with it.

[required] The version of the agent for which to return information about knowledge bases associated with it.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The unique identifier of the agent.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The unique identifier of the knowledge base for which to return a list of information.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The unique identifier of the flow for which aliases are being returned.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The unique identifier of the flow.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The unique identifier of the data source for the list of data ingestion jobs.

Contains information about the filters for filtering the data.

[required] The unique identifier of the knowledge base for the list of data ingestion jobs.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Contains details about how to sort the data.

[required] The unique identifier of the data source that contains the documents.

[required] The unique identifier of the knowledge base that is connected to the data source.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.

[required] The Amazon Resource Name (ARN) of the resource for which to list tags.

[required] The unique identifier of the agent for which to create a DRAFT version.

[required] The unique identifier of the flow.

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 error. For more information, see Ensuring idempotency.

[required] The unique identifier of the data source you want to ingest into your knowledge base.

A description of the data ingestion job.

[required] The unique identifier of the knowledge base for the data ingestion job.

[required] The unique identifier of the data source for the data ingestion job you want to stop.

[required] The unique identifier of the data ingestion job you want to stop.

[required] The unique identifier of the knowledge base for the data ingestion job you want to stop.

[required] The Amazon Resource Name (ARN) of the resource to tag.

[required] An object containing key-value pairs that define the tags to attach to the resource.

[required] The Amazon Resource Name (ARN) of the resource from which to remove tags.

[required] A list of keys of the tags to remove from the resource.

The agent's collaboration role.

[required] The unique identifier of the agent.

[required] Specifies a new name for the agent.

[required] The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Contains details of the custom orchestration configured for the agent.

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

Specifies a new description of the agent.

[required] The identifier for the model that you want to be used for orchestration by the agent you create.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

The unique Guardrail configuration assigned to the agent when it is updated.

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

Specifies new instructions that tell the agent what it should do and how it should interact with users.

Specifies the new memory configuration for the agent.

Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

[required] The unique identifier of the action group.

[required] Specifies a new name for the action group.

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

[required] The unique identifier of the agent for which to update the action group.

[required] The unique identifier of the agent version for which to update the action group.

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

Specifies a new name for the action group.

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

[required] The unique identifier of the alias.

[required] Specifies a new name for the alias.

[required] The unique identifier of the agent.

Specifies a new description for the alias.

Contains details about the routing configuration of the alias.

[required] An agent descriptor for the agent collaborator.

[required] The agent's ID.

[required] The agent's version.

[required] Instruction for the collaborator.

[required] The collaborator's ID.

[required] The collaborator's name.

A relay conversation history for the collaborator.

[required] The unique identifier of the agent associated with the knowledge base that you want to update.

[required] The version of the agent associated with the knowledge base that you want to update.

Specifies a new description for the knowledge base associated with an agent.

[required] The unique identifier of the knowledge base that has been associated with an agent.

Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

The data deletion policy for the data source that you want to update.

[required] The connection configuration for the data source that you want to update.

[required] The unique identifier of the data source.

Specifies a new description for the data source.

[required] The unique identifier of the knowledge base for the data source.

[required] Specifies a new name for the data source.

Contains details about server-side encryption of the data source.

Contains details about how to ingest the documents in the data source.

The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

A definition of the nodes and the connections between the nodes in the flow.

A description for the flow.

[required] The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

[required] The unique identifier of the flow.

[required] A name for the flow.

[required] The unique identifier of the alias.

A description for the alias.

[required] The unique identifier of the flow.

[required] The name of the alias.

[required] Contains information about the version to which to map the alias.

Specifies a new description for the knowledge base.

[required] Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

[required] The unique identifier of the knowledge base to update.

[required] Specifies a new name for the knowledge base.

[required] Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

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.

The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

A description for the prompt.

[required] A name for the prompt.

[required] The unique identifier of the prompt.

A list of objects, each containing details about a variant of the prompt.

[required] The definition of a flow to validate.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The unique identifier of an alias of an agent.

[required] The unique identifier of the agent to which the alias belongs.

The unique identifier of the memory.

The unique session identifier of the memory.

[required] Specifies information about a natural language query to transform into SQL.

[required] Specifies configurations for transforming the natural language query into SQL.

[required] The unique identifier of an alias of an agent.

[required] The unique identifier of the agent to which the alias belongs.

The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

[required] The unique identifier of the memory.

[required] The type of memory.

If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

[required] The alias of the agent to use.

[required] The unique identifier of the agent to use.

Model performance settings for the request.

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.

Specifies whether to end the session with the agent or not.

The prompt text to send the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

The unique identifier of the agent memory.

[required] The unique identifier of the session. Use the same value across requests to continue the same conversation.

Contains parameters that specify various attributes of the session. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

The ARN of the resource making the request.

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.

The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.

[required] The unique identifier of the flow alias.

[required] The unique identifier of the flow.

[required] A list of objects, each containing information about an input into the flow.

Model performance settings for the request.

A list of action groups with each action group defining the action the inline agent needs to carry out.

Model settings for the request.

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.

 </p>

Specifies whether to end the session with the inline agent or not.

[required] The model identifier (ID) of the model to use for orchestration by the inline agent. For example, ⁠meta.llama3-1-70b-instruct-v1:0⁠.

The guardrails to assign to the inline agent.

The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent invoke_inline_agent request begins a new session.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

The prompt text to send to the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

[required] The instructions that tell the inline agent what it should do and how it should interact with users.

Contains information of the knowledge bases to associate with.

Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.

[required] The unique identifier of the session. Use the same value across requests to continue the same conversation.

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.

[required] Contains the prompt to optimize.

[required] The unique identifier of the model that you want to optimize the prompt for.

If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.

[required] An array of objects, each of which contains information about a query to submit to the reranker model.

[required] Contains configurations for reranking.

[required] An array of objects, each of which contains information about the sources to rerank.

Guardrail settings.

[required] The unique identifier of the knowledge base to query.

If there are more results than can fit in the response, the response returns a nextToken. Use this token in the nextToken field of another request to retrieve the next batch of results.

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

[required] Contains the query to send the knowledge base.

[required] Contains the query to be made to the knowledge base.

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Contains details about the session with the knowledge base.

The unique identifier of the session. When you first make a retrieve_and_generate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

[required] Contains the query to be made to the knowledge base.

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Contains details about the session with the knowledge base.

The unique identifier of the session. When you first make a retrieve_and_generate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required]

[required]

[required]

[required] ARN generated at the server side when a Blueprint is created

[required]

[required]

[required] ARN generated at the server side when a Blueprint is created

Optional field to delete a specific Blueprint version

[required] ARN generated at the server side when a DataAutomationProject is created

[required] ARN generated at the server side when a Blueprint is created

Optional field to get a specific Blueprint version

Optional field to get a specific Blueprint stage

[required] ARN generated at the server side when a DataAutomationProject is created

Optional field to delete a specific DataAutomationProject stage

[required] ARN generated at the server side when a Blueprint is created

[required]

[required] ARN generated at the server side when a DataAutomationProject is created

[required]

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] Invocation arn.

Idempotency token.

[required] Input configuration.

[required] Output configuration.

Data automation configuration.

Encryption configuration.

Notification configuration.

Blueprint list.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.

[required] The guardrail identifier used in the request to apply the guardrail.

[required] The guardrail version used in the request to apply the guardrail.

[required] The source of data used in the request to apply the guardrail.

[required] The content details used in the request to apply the guardrail.

[required] Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.

The Converse API doesn't support imported models.

The messages that you want to send to the model.

A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.

Inference parameters to pass to the model. converse and converse_stream support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

Configuration information for the tools that the model can use when generating a response.

For information about models that support tool use, see Supported models and model features.

Configuration information for a guardrail that you want to use in the request. If you include guardContent blocks in the content field in the messages field, the guardrail operates only on those messages. If you include no guardContent blocks, the guardrail operates on all messages in the request body and in any included prompt resource.

Additional inference parameters that the model supports, beyond the base set of inference parameters that converse and converse_stream support in the inferenceConfig field. For more information, see Model parameters.

Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the modelId field.

Additional model parameters field paths to return in the response. converse and converse_stream return the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

⁠[ "/stop_sequence" ]⁠

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

converse and converse_stream reject an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by converse.

Key-value pairs that you can use to filter invocation logs.

Model performance settings for the request.

[required] Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• To include a prompt that was defined in Prompt management, specify the ARN of the prompt version to use.

The Converse API doesn't support imported models.

The messages that you want to send to the model.

A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.

Inference parameters to pass to the model. converse and converse_stream support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

Configuration information for the tools that the model can use when generating a response.

For information about models that support streaming tool use, see Supported models and model features.

Configuration information for a guardrail that you want to use in the request. If you include guardContent blocks in the content field in the messages field, the guardrail operates only on those messages. If you include no guardContent blocks, the guardrail operates on all messages in the request body and in any included prompt resource.

Additional inference parameters that the model supports, beyond the base set of inference parameters that converse and converse_stream support in the inferenceConfig field. For more information, see Model parameters.

Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the modelId field.

Additional model parameters field paths to return in the response. converse and converse_stream return the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

⁠[ "/stop_sequence" ]⁠

For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation.

converse and converse_stream reject an empty JSON Pointer or incorrectly structured JSON Pointer with a 400 error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by converse.

Key-value pairs that you can use to filter invocation logs.

Model performance settings for the request.

[required] The invocation's ARN.

The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

The MIME type of the input data in the request. You must specify application/json.

The desired MIME type of the inference body in the response. The default value is application/json.

[required] The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.

An error will be thrown in the following situations.

• You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

• You enable the guardrail but the contentType isn't application/json.

• You provide a guardrail identifier, but guardrailVersion isn't specified.

The version number for the guardrail. The value can also be DRAFT.

Model performance settings for the request.

The prompt and inference parameters in the format specified in the contentType in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to Inference parameters. For more information, see Run inference in the Bedrock User Guide.

The MIME type of the input data in the request. You must specify application/json.

The desired MIME type of the inference body in the response. The default value is application/json.

[required] The unique identifier of the model to invoke to run inference.

The modelId to provide depends on the type of model or throughput that you use:

• If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

• If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

• If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

• If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

• If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.

An error is thrown in the following situations.

• You don't provide a guardrail identifier but you specify the amazon-bedrock-guardrailConfig field in the request body.

• You enable the guardrail but the contentType isn't application/json.

• You provide a guardrail identifier, but guardrailVersion isn't specified.

The version number for the guardrail. The value can also be DRAFT.

Model performance settings for the request.

Include invocations submitted after this time.

Include invocations submitted before this time.

Filter invocations by status.

The maximum number of invocations to return in one page of results.

Specify the pagination token from a previous request to retrieve the next page of results.

How to sort the response.

The sorting order for the response.

Specify idempotency token to ensure that requests are not duplicated.

[required] The model to invoke.

[required] Input to send to the model.

[required] Where to store the output.

Tags to apply to the invocation.

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

Optional shorthand for complete URL to use for the constructed client.

Optional shorthand for AWS Region used in instantiating the client.