AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Bedrock

Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Bedrock.AmazonBedrockClient

Namespace: Amazon.Bedrock
Assembly: AWSSDK.Bedrock.dll
Version: 3.x.y.z

Syntax

C# 
public class AmazonBedrockClient : AmazonServiceClient
         IAmazonBedrock, IAmazonService, IDisposable

The AmazonBedrockClient type exposes the following members

Constructors

NameDescription
Public Method AmazonBedrockClient()

Constructs AmazonBedrockClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonBedrockClient(RegionEndpoint)

Constructs AmazonBedrockClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonBedrockClient(AmazonBedrockConfig)

Constructs AmazonBedrockClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonBedrockClient(AWSCredentials)

Constructs AmazonBedrockClient with AWS Credentials

Public Method AmazonBedrockClient(AWSCredentials, RegionEndpoint)

Constructs AmazonBedrockClient with AWS Credentials

Public Method AmazonBedrockClient(AWSCredentials, AmazonBedrockConfig)

Constructs AmazonBedrockClient with AWS Credentials and an AmazonBedrockClient Configuration object.

Public Method AmazonBedrockClient(string, string)

Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBedrockClient(string, string, RegionEndpoint)

Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBedrockClient(string, string, AmazonBedrockConfig)

Constructs AmazonBedrockClient with AWS Access Key ID, AWS Secret Key and an AmazonBedrockClient Configuration object.

Public Method AmazonBedrockClient(string, string, string)

Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBedrockClient(string, string, string, RegionEndpoint)

Constructs AmazonBedrockClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonBedrockClient(string, string, string, AmazonBedrockConfig)

Constructs AmazonBedrockClient with AWS Access Key ID, AWS Secret Key and an AmazonBedrockClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.Bedrock.Model.IBedrockPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method BatchDeleteEvaluationJob(BatchDeleteEvaluationJobRequest)

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.

Public Method BatchDeleteEvaluationJobAsync(BatchDeleteEvaluationJobRequest, CancellationToken)

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.

Public Method CreateCustomModel(CreateCustomModelRequest)

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
Public Method CreateCustomModelAsync(CreateCustomModelRequest, CancellationToken)

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
Public Method CreateEvaluationJob(CreateEvaluationJobRequest)

Creates an evaluation job.

Public Method CreateEvaluationJobAsync(CreateEvaluationJobRequest, CancellationToken)

Creates an evaluation job.

Public Method CreateFoundationModelAgreement(CreateFoundationModelAgreementRequest)

Request a model access agreement for the specified model.

Public Method CreateFoundationModelAgreementAsync(CreateFoundationModelAgreementRequest, CancellationToken)

Request a model access agreement for the specified model.

Public Method CreateGuardrail(CreateGuardrailRequest)

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.

Public Method CreateGuardrailAsync(CreateGuardrailRequest, CancellationToken)

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.

Public Method CreateGuardrailVersion(CreateGuardrailVersionRequest)

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.

Public Method CreateGuardrailVersionAsync(CreateGuardrailVersionRequest, CancellationToken)

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.

Public Method CreateInferenceProfile(CreateInferenceProfileRequest)

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.

Public Method CreateInferenceProfileAsync(CreateInferenceProfileRequest, CancellationToken)

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.

Public Method CreateMarketplaceModelEndpoint(CreateMarketplaceModelEndpointRequest)

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

Public Method CreateMarketplaceModelEndpointAsync(CreateMarketplaceModelEndpointRequest, CancellationToken)

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

Public Method CreateModelCopyJob(CreateModelCopyJobRequest)

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.

Public Method CreateModelCopyJobAsync(CreateModelCopyJobRequest, CancellationToken)

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.

Public Method CreateModelCustomizationJob(CreateModelCustomizationJobRequest)

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.

Public Method CreateModelCustomizationJobAsync(CreateModelCustomizationJobRequest, CancellationToken)

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.

Public Method CreateModelImportJob(CreateModelImportJobRequest)

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
Public Method CreateModelImportJobAsync(CreateModelImportJobRequest, CancellationToken)

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
Public Method CreateModelInvocationJob(CreateModelInvocationJobRequest)

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.

Public Method CreateModelInvocationJobAsync(CreateModelInvocationJobRequest, CancellationToken)

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.

Public Method CreatePromptRouter(CreatePromptRouterRequest)

Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.

Public Method CreatePromptRouterAsync(CreatePromptRouterRequest, CancellationToken)

Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.

Public Method CreateProvisionedModelThroughput(CreateProvisionedModelThroughputRequest)

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.

Public Method CreateProvisionedModelThroughputAsync(CreateProvisionedModelThroughputRequest, CancellationToken)

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.

Public Method DeleteCustomModel(DeleteCustomModelRequest)

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

Public Method DeleteCustomModelAsync(DeleteCustomModelRequest, CancellationToken)

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

Public Method DeleteFoundationModelAgreement(DeleteFoundationModelAgreementRequest)

Delete the model access agreement for the specified model.

Public Method DeleteFoundationModelAgreementAsync(DeleteFoundationModelAgreementRequest, CancellationToken)

Delete the model access agreement for the specified model.

Public Method DeleteGuardrail(DeleteGuardrailRequest)

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.

Public Method DeleteGuardrailAsync(DeleteGuardrailRequest, CancellationToken)

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.

Public Method DeleteImportedModel(DeleteImportedModelRequest)

Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.

Public Method DeleteImportedModelAsync(DeleteImportedModelRequest, CancellationToken)

Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.

Public Method DeleteInferenceProfile(DeleteInferenceProfileRequest)

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.

Public Method DeleteInferenceProfileAsync(DeleteInferenceProfileRequest, CancellationToken)

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.

Public Method DeleteMarketplaceModelEndpoint(DeleteMarketplaceModelEndpointRequest)

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

Public Method DeleteMarketplaceModelEndpointAsync(DeleteMarketplaceModelEndpointRequest, CancellationToken)

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

Public Method DeleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest)

Delete the invocation logging.

Public Method DeleteModelInvocationLoggingConfigurationAsync(DeleteModelInvocationLoggingConfigurationRequest, CancellationToken)

Delete the invocation logging.

Public Method DeletePromptRouter(DeletePromptRouterRequest)

Deletes a specified prompt router. This action cannot be undone.

Public Method DeletePromptRouterAsync(DeletePromptRouterRequest, CancellationToken)

Deletes a specified prompt router. This action cannot be undone.

Public Method DeleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest)

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.

Public Method DeleteProvisionedModelThroughputAsync(DeleteProvisionedModelThroughputRequest, CancellationToken)

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.

Public Method DeregisterMarketplaceModelEndpoint(DeregisterMarketplaceModelEndpointRequest)

Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

Public Method DeregisterMarketplaceModelEndpointAsync(DeregisterMarketplaceModelEndpointRequest, CancellationToken)

Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetCustomModel(GetCustomModelRequest)

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.

Public Method GetCustomModelAsync(GetCustomModelRequest, CancellationToken)

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.

Public Method GetEvaluationJob(GetEvaluationJobRequest)

Gets information about an evaluation job, such as the status of the job.

Public Method GetEvaluationJobAsync(GetEvaluationJobRequest, CancellationToken)

Gets information about an evaluation job, such as the status of the job.

Public Method GetFoundationModel(GetFoundationModelRequest)

Get details about a Amazon Bedrock foundation model.

Public Method GetFoundationModelAsync(GetFoundationModelRequest, CancellationToken)

Get details about a Amazon Bedrock foundation model.

Public Method GetFoundationModelAvailability(GetFoundationModelAvailabilityRequest)

Get information about the Foundation model availability.

Public Method GetFoundationModelAvailabilityAsync(GetFoundationModelAvailabilityRequest, CancellationToken)

Get information about the Foundation model availability.

Public Method GetGuardrail(GetGuardrailRequest)

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

Public Method GetGuardrailAsync(GetGuardrailRequest, CancellationToken)

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

Public Method GetImportedModel(GetImportedModelRequest)

Gets properties associated with a customized model you imported.

Public Method GetImportedModelAsync(GetImportedModelRequest, CancellationToken)

Gets properties associated with a customized model you imported.

Public Method GetInferenceProfile(GetInferenceProfileRequest)

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.

Public Method GetInferenceProfileAsync(GetInferenceProfileRequest, CancellationToken)

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.

Public Method GetMarketplaceModelEndpoint(GetMarketplaceModelEndpointRequest)

Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.

Public Method GetMarketplaceModelEndpointAsync(GetMarketplaceModelEndpointRequest, CancellationToken)

Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.

Public Method GetModelCopyJob(GetModelCopyJobRequest)

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.

Public Method GetModelCopyJobAsync(GetModelCopyJobRequest, CancellationToken)

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.

Public Method GetModelCustomizationJob(GetModelCustomizationJobRequest)

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.

Public Method GetModelCustomizationJobAsync(GetModelCustomizationJobRequest, CancellationToken)

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.

Public Method GetModelImportJob(GetModelImportJobRequest)

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.

Public Method GetModelImportJobAsync(GetModelImportJobRequest, CancellationToken)

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.

Public Method GetModelInvocationJob(GetModelInvocationJobRequest)

Gets details about a batch inference job. For more information, see Monitor batch inference jobs
Public Method GetModelInvocationJobAsync(GetModelInvocationJobRequest, CancellationToken)

Gets details about a batch inference job. For more information, see Monitor batch inference jobs
Public Method GetModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest)

Get the current configuration values for model invocation logging.

Public Method GetModelInvocationLoggingConfigurationAsync(GetModelInvocationLoggingConfigurationRequest, CancellationToken)

Get the current configuration values for model invocation logging.

Public Method GetPromptRouter(GetPromptRouterRequest)

Retrieves details about a prompt router.

Public Method GetPromptRouterAsync(GetPromptRouterRequest, CancellationToken)

Retrieves details about a prompt router.

Public Method GetProvisionedModelThroughput(GetProvisionedModelThroughputRequest)

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Public Method GetProvisionedModelThroughputAsync(GetProvisionedModelThroughputRequest, CancellationToken)

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Public Method GetUseCaseForModelAccess(GetUseCaseForModelAccessRequest)

Get usecase for model access.

Public Method GetUseCaseForModelAccessAsync(GetUseCaseForModelAccessRequest, CancellationToken)

Get usecase for model access.

Public Method ListCustomModels(ListCustomModelsRequest)

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.

Public Method ListCustomModelsAsync(ListCustomModelsRequest, CancellationToken)

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.

Public Method ListEvaluationJobs(ListEvaluationJobsRequest)

Lists all existing evaluation jobs.

Public Method ListEvaluationJobsAsync(ListEvaluationJobsRequest, CancellationToken)

Lists all existing evaluation jobs.

Public Method ListFoundationModelAgreementOffers(ListFoundationModelAgreementOffersRequest)

Get the offers associated with the specified model.

Public Method ListFoundationModelAgreementOffersAsync(ListFoundationModelAgreementOffersRequest, CancellationToken)

Get the offers associated with the specified model.

Public Method ListFoundationModels(ListFoundationModelsRequest)

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.

Public Method ListFoundationModelsAsync(ListFoundationModelsRequest, CancellationToken)

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.

Public Method ListGuardrails(ListGuardrailsRequest)

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.

Public Method ListGuardrailsAsync(ListGuardrailsRequest, CancellationToken)

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.

Public Method ListImportedModels(ListImportedModelsRequest)

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.

Public Method ListImportedModelsAsync(ListImportedModelsRequest, CancellationToken)

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.

Public Method ListInferenceProfiles(ListInferenceProfilesRequest)

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.

Public Method ListInferenceProfilesAsync(ListInferenceProfilesRequest, CancellationToken)

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.

Public Method ListMarketplaceModelEndpoints(ListMarketplaceModelEndpointsRequest)

Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.

Public Method ListMarketplaceModelEndpointsAsync(ListMarketplaceModelEndpointsRequest, CancellationToken)

Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.

Public Method ListModelCopyJobs(ListModelCopyJobsRequest)

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.

Public Method ListModelCopyJobsAsync(ListModelCopyJobsRequest, CancellationToken)

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.

Public Method ListModelCustomizationJobs(ListModelCustomizationJobsRequest)

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.

Public Method ListModelCustomizationJobsAsync(ListModelCustomizationJobsRequest, CancellationToken)

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.

Public Method ListModelImportJobs(ListModelImportJobsRequest)

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.

Public Method ListModelImportJobsAsync(ListModelImportJobsRequest, CancellationToken)

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.

Public Method ListModelInvocationJobs(ListModelInvocationJobsRequest)

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

Public Method ListModelInvocationJobsAsync(ListModelInvocationJobsRequest, CancellationToken)

Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.

Public Method ListPromptRouters(ListPromptRoutersRequest)

Retrieves a list of prompt routers.

Public Method ListPromptRoutersAsync(ListPromptRoutersRequest, CancellationToken)

Retrieves a list of prompt routers.

Public Method ListProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest)

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Public Method ListProvisionedModelThroughputsAsync(ListProvisionedModelThroughputsRequest, CancellationToken)

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Public Method ListTagsForResource(ListTagsForResourceRequest)

List the tags associated with the specified resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

List the tags associated with the specified resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method PutModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest)

Set the configuration values for model invocation logging.

Public Method PutModelInvocationLoggingConfigurationAsync(PutModelInvocationLoggingConfigurationRequest, CancellationToken)

Set the configuration values for model invocation logging.

Public Method PutUseCaseForModelAccess(PutUseCaseForModelAccessRequest)

Put usecase for model access.

Public Method PutUseCaseForModelAccessAsync(PutUseCaseForModelAccessRequest, CancellationToken)

Put usecase for model access.

Public Method RegisterMarketplaceModelEndpoint(RegisterMarketplaceModelEndpointRequest)

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

Public Method RegisterMarketplaceModelEndpointAsync(RegisterMarketplaceModelEndpointRequest, CancellationToken)

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

Public Method StopEvaluationJob(StopEvaluationJobRequest)

Stops an evaluation job that is current being created or running.

Public Method StopEvaluationJobAsync(StopEvaluationJobRequest, CancellationToken)

Stops an evaluation job that is current being created or running.

Public Method StopModelCustomizationJob(StopModelCustomizationJobRequest)

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

Public Method StopModelCustomizationJobAsync(StopModelCustomizationJobRequest, CancellationToken)

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

Public Method StopModelInvocationJob(StopModelInvocationJobRequest)

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

Public Method StopModelInvocationJobAsync(StopModelInvocationJobRequest, CancellationToken)

Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

Public Method TagResource(TagResourceRequest)

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method UntagResource(UntagResourceRequest)

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method UpdateGuardrail(UpdateGuardrailRequest)

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.

Public Method UpdateGuardrailAsync(UpdateGuardrailRequest, CancellationToken)

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.

Public Method UpdateMarketplaceModelEndpoint(UpdateMarketplaceModelEndpointRequest)

Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.

Public Method UpdateMarketplaceModelEndpointAsync(UpdateMarketplaceModelEndpointRequest, CancellationToken)

Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.

Public Method UpdateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest)

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Public Method UpdateProvisionedModelThroughputAsync(UpdateProvisionedModelThroughputRequest, CancellationToken)

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5