AWS SDK for C++AWS SDK for C++ Version 1.11.608 |
#include <BedrockClient.h>
Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
Definition at line 22 of file BedrockClient.h.
Definition at line 25 of file BedrockClient.h.
Definition at line 29 of file BedrockClient.h.
Definition at line 30 of file BedrockClient.h.
Aws::Bedrock::BedrockClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Bedrock::BedrockClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Bedrock::BedrockClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED
, COMPLETED
, and STOPPED
. You can request up to 25 model evaluation jobs be deleted in a single request.
nullptr
An Async wrapper for BatchDeleteEvaluationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 103 of file BedrockClient.h.
A Callable wrapper for BatchDeleteEvaluationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 94 of file BedrockClient.h.
Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.
To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput.
The model appears in ListCustomModels
with a customizationType
of imported
. To track the status of the new model, you use the GetCustomModel
API operation. The model can be in the following states:
Creating
- Initial state during validation and registration
Active
- Model is ready for use in inference
Failed
- Creation process encountered an error
Related APIs
nullptr
An Async wrapper for CreateCustomModel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 146 of file BedrockClient.h.
A Callable wrapper for CreateCustomModel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 137 of file BedrockClient.h.
Deploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the modelId
parameter when you submit prompts and generate responses with model inference.
For more information about setting up on-demand inference for custom models, see Set up inference for a custom model.
The following actions are related to the CreateCustomModelDeployment
operation:
nullptr
An Async wrapper for CreateCustomModelDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 184 of file BedrockClient.h.
A Callable wrapper for CreateCustomModelDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 175 of file BedrockClient.h.
nullptr
An Async wrapper for CreateEvaluationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 209 of file BedrockClient.h.
A Callable wrapper for CreateEvaluationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 200 of file BedrockClient.h.
nullptr
An Async wrapper for CreateFoundationModelAgreement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 235 of file BedrockClient.h.
A Callable wrapper for CreateFoundationModelAgreement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 226 of file BedrockClient.h.
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for CreateGuardrail that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 279 of file BedrockClient.h.
A Callable wrapper for CreateGuardrail that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 270 of file BedrockClient.h.
Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
nullptr
An Async wrapper for CreateGuardrailVersion that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 306 of file BedrockClient.h.
A Callable wrapper for CreateGuardrailVersion that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 297 of file BedrockClient.h.
Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for CreateInferenceProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 339 of file BedrockClient.h.
A Callable wrapper for CreateInferenceProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 330 of file BedrockClient.h.
Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.
nullptr
An Async wrapper for CreateMarketplaceModelEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 365 of file BedrockClient.h.
A Callable wrapper for CreateMarketplaceModelEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 356 of file BedrockClient.h.
Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for CreateModelCopyJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 395 of file BedrockClient.h.
A Callable wrapper for CreateModelCopyJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 386 of file BedrockClient.h.
Creates a fine-tuning job to customize a base model.
You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.
For information on the format of training and validation data, see Prepare the datasets.
Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob
operation to retrieve the job status.
For more information, see Custom models in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for CreateModelCustomizationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 434 of file BedrockClient.h.
A Callable wrapper for CreateModelCustomizationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 425 of file BedrockClient.h.
Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see Import a customized model
nullptr
An Async wrapper for CreateModelImportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 462 of file BedrockClient.h.
A Callable wrapper for CreateModelImportJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 453 of file BedrockClient.h.
Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.
The response returns a jobArn
that you can use to stop or get details about the job.
nullptr
An Async wrapper for CreateModelInvocationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 495 of file BedrockClient.h.
A Callable wrapper for CreateModelInvocationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 486 of file BedrockClient.h.
Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
nullptr
An Async wrapper for CreatePromptRouter that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 521 of file BedrockClient.h.
A Callable wrapper for CreatePromptRouter that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 512 of file BedrockClient.h.
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for CreateProvisionedModelThroughput that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 553 of file BedrockClient.h.
A Callable wrapper for CreateProvisionedModelThroughput that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 544 of file BedrockClient.h.
Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for DeleteCustomModel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 582 of file BedrockClient.h.
A Callable wrapper for DeleteCustomModel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 573 of file BedrockClient.h.
Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests.
The following actions are related to the DeleteCustomModelDeployment
operation:
nullptr
An Async wrapper for DeleteCustomModelDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 616 of file BedrockClient.h.
A Callable wrapper for DeleteCustomModelDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 607 of file BedrockClient.h.
nullptr
An Async wrapper for DeleteFoundationModelAgreement that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 642 of file BedrockClient.h.
A Callable wrapper for DeleteFoundationModelAgreement that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 633 of file BedrockClient.h.
Deletes a guardrail.
To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier
field. If you delete a guardrail, all of its versions will be deleted.
To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier
field and the version in the guardrailVersion
field.
nullptr
An Async wrapper for DeleteGuardrail that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 672 of file BedrockClient.h.
A Callable wrapper for DeleteGuardrail that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 663 of file BedrockClient.h.
Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for DeleteImportedModel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 702 of file BedrockClient.h.
A Callable wrapper for DeleteImportedModel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 693 of file BedrockClient.h.
Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for DeleteInferenceProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 730 of file BedrockClient.h.
A Callable wrapper for DeleteInferenceProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 721 of file BedrockClient.h.
nullptr
An Async wrapper for DeleteMarketplaceModelEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 756 of file BedrockClient.h.
A Callable wrapper for DeleteMarketplaceModelEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 747 of file BedrockClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for DeleteModelInvocationLoggingConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 781 of file BedrockClient.h.
{}
)
const
A Callable wrapper for DeleteModelInvocationLoggingConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 772 of file BedrockClient.h.
nullptr
An Async wrapper for DeletePromptRouter that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 807 of file BedrockClient.h.
A Callable wrapper for DeletePromptRouter that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 798 of file BedrockClient.h.
Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for DeleteProvisionedModelThroughput that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 837 of file BedrockClient.h.
A Callable wrapper for DeleteProvisionedModelThroughput that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 828 of file BedrockClient.h.
nullptr
An Async wrapper for DeregisterMarketplaceModelEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 864 of file BedrockClient.h.
A Callable wrapper for DeregisterMarketplaceModelEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 855 of file BedrockClient.h.
Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for GetCustomModel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 894 of file BedrockClient.h.
A Callable wrapper for GetCustomModel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 885 of file BedrockClient.h.
Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.
The following actions are related to the GetCustomModelDeployment
operation:
nullptr
An Async wrapper for GetCustomModelDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 929 of file BedrockClient.h.
A Callable wrapper for GetCustomModelDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 920 of file BedrockClient.h.
Gets information about an evaluation job, such as the status of the job.
nullptr
An Async wrapper for GetEvaluationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 955 of file BedrockClient.h.
A Callable wrapper for GetEvaluationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 946 of file BedrockClient.h.
nullptr
An Async wrapper for GetFoundationModel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 981 of file BedrockClient.h.
nullptr
An Async wrapper for GetFoundationModelAvailability that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1007 of file BedrockClient.h.
A Callable wrapper for GetFoundationModelAvailability that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 998 of file BedrockClient.h.
A Callable wrapper for GetFoundationModel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 972 of file BedrockClient.h.
Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT
version.
nullptr
An Async wrapper for GetGuardrail that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1034 of file BedrockClient.h.
A Callable wrapper for GetGuardrail that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1025 of file BedrockClient.h.
nullptr
An Async wrapper for GetImportedModel that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1060 of file BedrockClient.h.
A Callable wrapper for GetImportedModel that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1051 of file BedrockClient.h.
Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for GetInferenceProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1088 of file BedrockClient.h.
A Callable wrapper for GetInferenceProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1079 of file BedrockClient.h.
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
nullptr
An Async wrapper for GetMarketplaceModelEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1114 of file BedrockClient.h.
A Callable wrapper for GetMarketplaceModelEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1105 of file BedrockClient.h.
Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for GetModelCopyJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1143 of file BedrockClient.h.
A Callable wrapper for GetModelCopyJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1134 of file BedrockClient.h.
Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for GetModelCustomizationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1173 of file BedrockClient.h.
A Callable wrapper for GetModelCustomizationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1164 of file BedrockClient.h.
Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for GetModelImportJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1203 of file BedrockClient.h.
A Callable wrapper for GetModelImportJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1194 of file BedrockClient.h.
Gets details about a batch inference job. For more information, see Monitor batch inference jobs
nullptr
An Async wrapper for GetModelInvocationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1230 of file BedrockClient.h.
A Callable wrapper for GetModelInvocationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1221 of file BedrockClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for GetModelInvocationLoggingConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1256 of file BedrockClient.h.
{}
)
const
A Callable wrapper for GetModelInvocationLoggingConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1247 of file BedrockClient.h.
nullptr
An Async wrapper for GetPromptRouter that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1281 of file BedrockClient.h.
A Callable wrapper for GetPromptRouter that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1272 of file BedrockClient.h.
Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for GetProvisionedModelThroughput that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1310 of file BedrockClient.h.
A Callable wrapper for GetProvisionedModelThroughput that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1301 of file BedrockClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for GetUseCaseForModelAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1335 of file BedrockClient.h.
{}
)
const
A Callable wrapper for GetUseCaseForModelAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1326 of file BedrockClient.h.
{}
)
const
Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.
We recommend using pagination to ensure that the operation returns quickly and successfully.
The following actions are related to the ListCustomModelDeployments
operation:
nullptr
,
{}
An Async wrapper for ListCustomModelDeployments that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1371 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListCustomModelDeployments that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1362 of file BedrockClient.h.
{}
)
const
Returns a list of the custom models that you have created with the CreateModelCustomizationJob
operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListCustomModels that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1402 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListCustomModels that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1393 of file BedrockClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListEvaluationJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1427 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListEvaluationJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1418 of file BedrockClient.h.
nullptr
An Async wrapper for ListFoundationModelAgreementOffers that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1453 of file BedrockClient.h.
A Callable wrapper for ListFoundationModelAgreementOffers that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1444 of file BedrockClient.h.
{}
)
const
Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListFoundationModels that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1483 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListFoundationModels that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1474 of file BedrockClient.h.
{}
)
const
Lists details about all the guardrails in an account. To list the DRAFT
version of all your guardrails, don't specify the guardrailIdentifier
field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier
field.
You can set the maximum number of results to return in a response in the maxResults
field. If there are more results than the number you set, the response returns a nextToken
that you can send in another ListGuardrails
request to see the next batch of results.
nullptr
,
{}
An Async wrapper for ListGuardrails that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1516 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListGuardrails that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1507 of file BedrockClient.h.
{}
)
const
Returns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListImportedModels that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1546 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListImportedModels that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1537 of file BedrockClient.h.
{}
)
const
Returns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListInferenceProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1575 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListInferenceProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1566 of file BedrockClient.h.
{}
)
const
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
nullptr
,
{}
An Async wrapper for ListMarketplaceModelEndpoints that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1601 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListMarketplaceModelEndpoints that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1592 of file BedrockClient.h.
{}
)
const
Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListModelCopyJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1631 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListModelCopyJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1622 of file BedrockClient.h.
{}
)
const
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListModelCustomizationJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1662 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListModelCustomizationJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1653 of file BedrockClient.h.
{}
)
const
Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see Import a customized model in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListModelImportJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1692 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListModelImportJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1683 of file BedrockClient.h.
{}
)
const
Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
nullptr
,
{}
An Async wrapper for ListModelInvocationJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1719 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListModelInvocationJobs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1710 of file BedrockClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListPromptRouters that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1744 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListPromptRouters that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1735 of file BedrockClient.h.
{}
)
const
Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
nullptr
,
{}
An Async wrapper for ListProvisionedModelThroughputs that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1774 of file BedrockClient.h.
{}
)
const
A Callable wrapper for ListProvisionedModelThroughputs that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1765 of file BedrockClient.h.
List the tags associated with the specified resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1804 of file BedrockClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1795 of file BedrockClient.h.
nullptr
An Async wrapper for PutModelInvocationLoggingConfiguration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1830 of file BedrockClient.h.
A Callable wrapper for PutModelInvocationLoggingConfiguration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1821 of file BedrockClient.h.
nullptr
An Async wrapper for PutUseCaseForModelAccess that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1855 of file BedrockClient.h.
A Callable wrapper for PutUseCaseForModelAccess that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1846 of file BedrockClient.h.
nullptr
An Async wrapper for RegisterMarketplaceModelEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1882 of file BedrockClient.h.
A Callable wrapper for RegisterMarketplaceModelEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1873 of file BedrockClient.h.
nullptr
An Async wrapper for StopEvaluationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1908 of file BedrockClient.h.
A Callable wrapper for StopEvaluationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1899 of file BedrockClient.h.
Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for StopModelCustomizationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1937 of file BedrockClient.h.
A Callable wrapper for StopModelCustomizationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1928 of file BedrockClient.h.
Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.
nullptr
An Async wrapper for StopModelInvocationJob that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1965 of file BedrockClient.h.
A Callable wrapper for StopModelInvocationJob that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1956 of file BedrockClient.h.
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1994 of file BedrockClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1985 of file BedrockClient.h.
Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2023 of file BedrockClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2014 of file BedrockClient.h.
Updates a guardrail with the values you specify.
Specify a name
and optional description
.
Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging
and blockedOutputsMessaging
fields.
Specify topics for the guardrail to deny in the topicPolicyConfig
object. Each GuardrailTopicConfig object in the topicsConfig
list pertains to one topic.
Give a name
and description
so that the guardrail can properly identify the topic.
Specify DENY
in the type
field.
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the examples
list.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the contentPolicyConfig
object. Each GuardrailContentFilterConfig object in the filtersConfig
list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.
Specify the category in the type
field.
Specify the strength of the filter for prompts in the inputStrength
field and for model responses in the strength
field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the kmsKeyId
field.
nullptr
An Async wrapper for UpdateGuardrail that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2075 of file BedrockClient.h.
A Callable wrapper for UpdateGuardrail that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2066 of file BedrockClient.h.
Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
nullptr
An Async wrapper for UpdateMarketplaceModelEndpoint that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2101 of file BedrockClient.h.
A Callable wrapper for UpdateMarketplaceModelEndpoint that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2092 of file BedrockClient.h.
Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
nullptr
An Async wrapper for UpdateProvisionedModelThroughput that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2131 of file BedrockClient.h.
A Callable wrapper for UpdateProvisionedModelThroughput that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2122 of file BedrockClient.h.
Definition at line 2138 of file BedrockClient.h.