Package-level declarations

Types

Link copied to clipboard

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

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard

Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.

Link copied to clipboard

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.

Link copied to clipboard

Creates an evaluation job.

Link copied to clipboard

Request a model access agreement for the specified model.

Link copied to clipboard

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates a fine-tuning job to customize a base model.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Delete the model access agreement for the specified model.

Link copied to clipboard

Deletes a guardrail.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Get details about a Amazon Bedrock foundation model.

Link copied to clipboard

Get information about the Foundation model availability.

Link copied to clipboard

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

Link copied to clipboard

Gets properties associated with a customized model you imported.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Gets details about a batch inference job. For more information, see Monitor batch inference jobs

Link copied to clipboard

Get the current configuration values for model invocation logging.

Link copied to clipboard

Retrieves details about a prompt router.

Link copied to clipboard

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

Link copied to clipboard

Get usecase for model access.

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

Link copied to clipboard

Lists all existing evaluation jobs.

Link copied to clipboard

Get the offers associated with the specified model.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Retrieves a list of prompt routers.

Link copied to clipboard

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

Link copied to clipboard

List the tags associated with the specified resource.

Link copied to clipboard

Set the configuration values for model invocation logging.

Link copied to clipboard

Put usecase for model access.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun BedrockClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

Link copied to clipboard

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

Link copied to clipboard

Updates a guardrail with the values you specify.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.