Interface BedrockClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault BatchDeleteEvaluationJobResponsebatchDeleteEvaluationJob(Consumer<BatchDeleteEvaluationJobRequest.Builder> batchDeleteEvaluationJobRequest) Creates a batch deletion job.default BatchDeleteEvaluationJobResponsebatchDeleteEvaluationJob(BatchDeleteEvaluationJobRequest batchDeleteEvaluationJobRequest) Creates a batch deletion job.static BedrockClientBuilderbuilder()Create a builder that can be used to configure and create aBedrockClient.static BedrockClientcreate()Create aBedrockClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateEvaluationJobResponsecreateEvaluationJob(Consumer<CreateEvaluationJobRequest.Builder> createEvaluationJobRequest) API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.default CreateEvaluationJobResponsecreateEvaluationJob(CreateEvaluationJobRequest createEvaluationJobRequest) API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.default CreateGuardrailResponsecreateGuardrail(Consumer<CreateGuardrailRequest.Builder> createGuardrailRequest) Creates a guardrail to block topics and to implement safeguards for your generative AI applications.default CreateGuardrailResponsecreateGuardrail(CreateGuardrailRequest createGuardrailRequest) Creates a guardrail to block topics and to implement safeguards for your generative AI applications.default CreateGuardrailVersionResponsecreateGuardrailVersion(Consumer<CreateGuardrailVersionRequest.Builder> createGuardrailVersionRequest) Creates a version of the guardrail.default CreateGuardrailVersionResponsecreateGuardrailVersion(CreateGuardrailVersionRequest createGuardrailVersionRequest) Creates a version of the guardrail.default CreateModelCopyJobResponsecreateModelCopyJob(Consumer<CreateModelCopyJobRequest.Builder> createModelCopyJobRequest) Copies a model to another region so that it can be used there.default CreateModelCopyJobResponsecreateModelCopyJob(CreateModelCopyJobRequest createModelCopyJobRequest) Copies a model to another region so that it can be used there.createModelCustomizationJob(Consumer<CreateModelCustomizationJobRequest.Builder> createModelCustomizationJobRequest) Creates a fine-tuning job to customize a base model.createModelCustomizationJob(CreateModelCustomizationJobRequest createModelCustomizationJobRequest) Creates a fine-tuning job to customize a base model.default CreateModelImportJobResponsecreateModelImportJob(Consumer<CreateModelImportJobRequest.Builder> createModelImportJobRequest) Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker.default CreateModelImportJobResponsecreateModelImportJob(CreateModelImportJobRequest createModelImportJobRequest) Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker.default CreateModelInvocationJobResponsecreateModelInvocationJob(Consumer<CreateModelInvocationJobRequest.Builder> createModelInvocationJobRequest) Creates a batch inference job to invoke a model on multiple prompts.default CreateModelInvocationJobResponsecreateModelInvocationJob(CreateModelInvocationJobRequest createModelInvocationJobRequest) Creates a batch inference job to invoke a model on multiple prompts.createProvisionedModelThroughput(Consumer<CreateProvisionedModelThroughputRequest.Builder> createProvisionedModelThroughputRequest) Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest createProvisionedModelThroughputRequest) Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.default DeleteCustomModelResponsedeleteCustomModel(Consumer<DeleteCustomModelRequest.Builder> deleteCustomModelRequest) Deletes a custom model that you created earlier.default DeleteCustomModelResponsedeleteCustomModel(DeleteCustomModelRequest deleteCustomModelRequest) Deletes a custom model that you created earlier.default DeleteGuardrailResponsedeleteGuardrail(Consumer<DeleteGuardrailRequest.Builder> deleteGuardrailRequest) Deletes a guardrail.default DeleteGuardrailResponsedeleteGuardrail(DeleteGuardrailRequest deleteGuardrailRequest) Deletes a guardrail.default DeleteImportedModelResponsedeleteImportedModel(Consumer<DeleteImportedModelRequest.Builder> deleteImportedModelRequest) Deletes a custom model that you imported earlier.default DeleteImportedModelResponsedeleteImportedModel(DeleteImportedModelRequest deleteImportedModelRequest) Deletes a custom model that you imported earlier.deleteModelInvocationLoggingConfiguration(Consumer<DeleteModelInvocationLoggingConfigurationRequest.Builder> deleteModelInvocationLoggingConfigurationRequest) Delete the invocation logging.deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest deleteModelInvocationLoggingConfigurationRequest) Delete the invocation logging.deleteProvisionedModelThroughput(Consumer<DeleteProvisionedModelThroughputRequest.Builder> deleteProvisionedModelThroughputRequest) Deletes a Provisioned Throughput.deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest deleteProvisionedModelThroughputRequest) Deletes a Provisioned Throughput.default GetCustomModelResponsegetCustomModel(Consumer<GetCustomModelRequest.Builder> 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.default GetCustomModelResponsegetCustomModel(GetCustomModelRequest 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.default GetEvaluationJobResponsegetEvaluationJob(Consumer<GetEvaluationJobRequest.Builder> getEvaluationJobRequest) Retrieves the properties associated with a model evaluation job, including the status of the job.default GetEvaluationJobResponsegetEvaluationJob(GetEvaluationJobRequest getEvaluationJobRequest) Retrieves the properties associated with a model evaluation job, including the status of the job.default GetFoundationModelResponsegetFoundationModel(Consumer<GetFoundationModelRequest.Builder> getFoundationModelRequest) Get details about a Amazon Bedrock foundation model.default GetFoundationModelResponsegetFoundationModel(GetFoundationModelRequest getFoundationModelRequest) Get details about a Amazon Bedrock foundation model.default GetGuardrailResponsegetGuardrail(Consumer<GetGuardrailRequest.Builder> getGuardrailRequest) Gets details about a guardrail.default GetGuardrailResponsegetGuardrail(GetGuardrailRequest getGuardrailRequest) Gets details about a guardrail.default GetImportedModelResponsegetImportedModel(Consumer<GetImportedModelRequest.Builder> getImportedModelRequest) Gets properties associated with a customized model you imported.default GetImportedModelResponsegetImportedModel(GetImportedModelRequest getImportedModelRequest) Gets properties associated with a customized model you imported.default GetInferenceProfileResponsegetInferenceProfile(Consumer<GetInferenceProfileRequest.Builder> getInferenceProfileRequest) Gets information about an inference profile.default GetInferenceProfileResponsegetInferenceProfile(GetInferenceProfileRequest getInferenceProfileRequest) Gets information about an inference profile.default GetModelCopyJobResponsegetModelCopyJob(Consumer<GetModelCopyJobRequest.Builder> getModelCopyJobRequest) Retrieves information about a model copy job.default GetModelCopyJobResponsegetModelCopyJob(GetModelCopyJobRequest getModelCopyJobRequest) Retrieves information about a model copy job.default GetModelCustomizationJobResponsegetModelCustomizationJob(Consumer<GetModelCustomizationJobRequest.Builder> getModelCustomizationJobRequest) Retrieves the properties associated with a model-customization job, including the status of the job.default GetModelCustomizationJobResponsegetModelCustomizationJob(GetModelCustomizationJobRequest getModelCustomizationJobRequest) Retrieves the properties associated with a model-customization job, including the status of the job.default GetModelImportJobResponsegetModelImportJob(Consumer<GetModelImportJobRequest.Builder> getModelImportJobRequest) Retrieves the properties associated with import model job, including the status of the job.default GetModelImportJobResponsegetModelImportJob(GetModelImportJobRequest getModelImportJobRequest) Retrieves the properties associated with import model job, including the status of the job.default GetModelInvocationJobResponsegetModelInvocationJob(Consumer<GetModelInvocationJobRequest.Builder> getModelInvocationJobRequest) Gets details about a batch inference job.default GetModelInvocationJobResponsegetModelInvocationJob(GetModelInvocationJobRequest getModelInvocationJobRequest) Gets details about a batch inference job.getModelInvocationLoggingConfiguration(Consumer<GetModelInvocationLoggingConfigurationRequest.Builder> getModelInvocationLoggingConfigurationRequest) Get the current configuration values for model invocation logging.getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest getModelInvocationLoggingConfigurationRequest) Get the current configuration values for model invocation logging.getProvisionedModelThroughput(Consumer<GetProvisionedModelThroughputRequest.Builder> getProvisionedModelThroughputRequest) Returns details for a Provisioned Throughput.getProvisionedModelThroughput(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest) Returns details for a Provisioned Throughput.default ListCustomModelsResponselistCustomModels(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJoboperation.default ListCustomModelsResponselistCustomModels(ListCustomModelsRequest listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJoboperation.default ListCustomModelsIterablelistCustomModelsPaginator(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) This is a variant oflistCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation.default ListCustomModelsIterablelistCustomModelsPaginator(ListCustomModelsRequest listCustomModelsRequest) This is a variant oflistCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation.default ListEvaluationJobsResponselistEvaluationJobs(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) Lists model evaluation jobs.default ListEvaluationJobsResponselistEvaluationJobs(ListEvaluationJobsRequest listEvaluationJobsRequest) Lists model evaluation jobs.default ListEvaluationJobsIterablelistEvaluationJobsPaginator(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) This is a variant oflistEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.default ListEvaluationJobsIterablelistEvaluationJobsPaginator(ListEvaluationJobsRequest listEvaluationJobsRequest) This is a variant oflistEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.default ListFoundationModelsResponselistFoundationModels(Consumer<ListFoundationModelsRequest.Builder> listFoundationModelsRequest) Lists Amazon Bedrock foundation models that you can use.default ListFoundationModelsResponselistFoundationModels(ListFoundationModelsRequest listFoundationModelsRequest) Lists Amazon Bedrock foundation models that you can use.default ListGuardrailsResponselistGuardrails(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) Lists details about all the guardrails in an account.default ListGuardrailsResponselistGuardrails(ListGuardrailsRequest listGuardrailsRequest) Lists details about all the guardrails in an account.default ListGuardrailsIterablelistGuardrailsPaginator(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) This is a variant oflistGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.default ListGuardrailsIterablelistGuardrailsPaginator(ListGuardrailsRequest listGuardrailsRequest) This is a variant oflistGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.default ListImportedModelsResponselistImportedModels(Consumer<ListImportedModelsRequest.Builder> listImportedModelsRequest) Returns a list of models you've imported.default ListImportedModelsResponselistImportedModels(ListImportedModelsRequest listImportedModelsRequest) Returns a list of models you've imported.default ListImportedModelsIterablelistImportedModelsPaginator(Consumer<ListImportedModelsRequest.Builder> listImportedModelsRequest) This is a variant oflistImportedModels(software.amazon.awssdk.services.bedrock.model.ListImportedModelsRequest)operation.default ListImportedModelsIterablelistImportedModelsPaginator(ListImportedModelsRequest listImportedModelsRequest) This is a variant oflistImportedModels(software.amazon.awssdk.services.bedrock.model.ListImportedModelsRequest)operation.default ListInferenceProfilesResponselistInferenceProfiles(Consumer<ListInferenceProfilesRequest.Builder> listInferenceProfilesRequest) Returns a list of inference profiles that you can use.default ListInferenceProfilesResponselistInferenceProfiles(ListInferenceProfilesRequest listInferenceProfilesRequest) Returns a list of inference profiles that you can use.default ListInferenceProfilesIterablelistInferenceProfilesPaginator(Consumer<ListInferenceProfilesRequest.Builder> listInferenceProfilesRequest) This is a variant oflistInferenceProfiles(software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesRequest)operation.default ListInferenceProfilesIterablelistInferenceProfilesPaginator(ListInferenceProfilesRequest listInferenceProfilesRequest) This is a variant oflistInferenceProfiles(software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesRequest)operation.default ListModelCopyJobsResponselistModelCopyJobs(Consumer<ListModelCopyJobsRequest.Builder> listModelCopyJobsRequest) Returns a list of model copy jobs that you have submitted.default ListModelCopyJobsResponselistModelCopyJobs(ListModelCopyJobsRequest listModelCopyJobsRequest) Returns a list of model copy jobs that you have submitted.default ListModelCopyJobsIterablelistModelCopyJobsPaginator(Consumer<ListModelCopyJobsRequest.Builder> listModelCopyJobsRequest) This is a variant oflistModelCopyJobs(software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsRequest)operation.default ListModelCopyJobsIterablelistModelCopyJobsPaginator(ListModelCopyJobsRequest listModelCopyJobsRequest) This is a variant oflistModelCopyJobs(software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsRequest)operation.listModelCustomizationJobs(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest) Returns a list of model customization jobs that you have submitted.listModelCustomizationJobs(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) Returns a list of model customization jobs that you have submitted.listModelCustomizationJobsPaginator(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest) This is a variant oflistModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation.listModelCustomizationJobsPaginator(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) This is a variant oflistModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation.default ListModelImportJobsResponselistModelImportJobs(Consumer<ListModelImportJobsRequest.Builder> listModelImportJobsRequest) Returns a list of import jobs you've submitted.default ListModelImportJobsResponselistModelImportJobs(ListModelImportJobsRequest listModelImportJobsRequest) Returns a list of import jobs you've submitted.default ListModelImportJobsIterablelistModelImportJobsPaginator(Consumer<ListModelImportJobsRequest.Builder> listModelImportJobsRequest) This is a variant oflistModelImportJobs(software.amazon.awssdk.services.bedrock.model.ListModelImportJobsRequest)operation.default ListModelImportJobsIterablelistModelImportJobsPaginator(ListModelImportJobsRequest listModelImportJobsRequest) This is a variant oflistModelImportJobs(software.amazon.awssdk.services.bedrock.model.ListModelImportJobsRequest)operation.default ListModelInvocationJobsResponselistModelInvocationJobs(Consumer<ListModelInvocationJobsRequest.Builder> listModelInvocationJobsRequest) Lists all batch inference jobs in the account.default ListModelInvocationJobsResponselistModelInvocationJobs(ListModelInvocationJobsRequest listModelInvocationJobsRequest) Lists all batch inference jobs in the account.default ListModelInvocationJobsIterablelistModelInvocationJobsPaginator(Consumer<ListModelInvocationJobsRequest.Builder> listModelInvocationJobsRequest) This is a variant oflistModelInvocationJobs(software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsRequest)operation.default ListModelInvocationJobsIterablelistModelInvocationJobsPaginator(ListModelInvocationJobsRequest listModelInvocationJobsRequest) This is a variant oflistModelInvocationJobs(software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsRequest)operation.listProvisionedModelThroughputs(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) Lists the Provisioned Throughputs in the account.listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) Lists the Provisioned Throughputs in the account.listProvisionedModelThroughputsPaginator(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) This is a variant oflistProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation.listProvisionedModelThroughputsPaginator(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) This is a variant oflistProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags associated with the specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags associated with the specified resource.putModelInvocationLoggingConfiguration(Consumer<PutModelInvocationLoggingConfigurationRequest.Builder> putModelInvocationLoggingConfigurationRequest) Set the configuration values for model invocation logging.putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest putModelInvocationLoggingConfigurationRequest) Set the configuration values for model invocation logging.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StopEvaluationJobResponsestopEvaluationJob(Consumer<StopEvaluationJobRequest.Builder> stopEvaluationJobRequest) Stops an in progress model evaluation job.default StopEvaluationJobResponsestopEvaluationJob(StopEvaluationJobRequest stopEvaluationJobRequest) Stops an in progress model evaluation job.stopModelCustomizationJob(Consumer<StopModelCustomizationJobRequest.Builder> stopModelCustomizationJobRequest) Stops an active model customization job.stopModelCustomizationJob(StopModelCustomizationJobRequest stopModelCustomizationJobRequest) Stops an active model customization job.default StopModelInvocationJobResponsestopModelInvocationJob(Consumer<StopModelInvocationJobRequest.Builder> stopModelInvocationJobRequest) Stops a batch inference job.default StopModelInvocationJobResponsestopModelInvocationJob(StopModelInvocationJobRequest stopModelInvocationJobRequest) Stops a batch inference job.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associate tags with a resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Associate tags with a resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove one or more tags from a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Remove one or more tags from a resource.default UpdateGuardrailResponseupdateGuardrail(Consumer<UpdateGuardrailRequest.Builder> updateGuardrailRequest) Updates a guardrail with the values you specify.default UpdateGuardrailResponseupdateGuardrail(UpdateGuardrailRequest updateGuardrailRequest) Updates a guardrail with the values you specify.updateProvisionedModelThroughput(Consumer<UpdateProvisionedModelThroughputRequest.Builder> updateProvisionedModelThroughputRequest) Updates the name or associated model for a Provisioned Throughput.updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest) Updates the name or associated model for a Provisioned Throughput.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
batchDeleteEvaluationJob
default BatchDeleteEvaluationJobResponse batchDeleteEvaluationJob(BatchDeleteEvaluationJobRequest batchDeleteEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Creates a batch deletion job. A model evaluation job can only be deleted if it has following status
FAILED,COMPLETED, andSTOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.- Parameters:
batchDeleteEvaluationJobRequest-- Returns:
- Result of the BatchDeleteEvaluationJob operation returned by the service.
- See Also:
-
batchDeleteEvaluationJob
default BatchDeleteEvaluationJobResponse batchDeleteEvaluationJob(Consumer<BatchDeleteEvaluationJobRequest.Builder> batchDeleteEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Creates a batch deletion job. A model evaluation job can only be deleted if it has following status
FAILED,COMPLETED, andSTOPPED. You can request up to 25 model evaluation jobs be deleted in a single request.
This is a convenience which creates an instance of the
BatchDeleteEvaluationJobRequest.Builderavoiding the need to create one manually viaBatchDeleteEvaluationJobRequest.builder()- Parameters:
batchDeleteEvaluationJobRequest- AConsumerthat will call methods onBatchDeleteEvaluationJobRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteEvaluationJob operation returned by the service.
- See Also:
-
createEvaluationJob
default CreateEvaluationJobResponse createEvaluationJob(CreateEvaluationJobRequest createEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation.
- Parameters:
createEvaluationJobRequest-- Returns:
- Result of the CreateEvaluationJob operation returned by the service.
- See Also:
-
createEvaluationJob
default CreateEvaluationJobResponse createEvaluationJob(Consumer<CreateEvaluationJobRequest.Builder> createEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation.
This is a convenience which creates an instance of the
CreateEvaluationJobRequest.Builderavoiding the need to create one manually viaCreateEvaluationJobRequest.builder()- Parameters:
createEvaluationJobRequest- AConsumerthat will call methods onCreateEvaluationJobRequest.Builderto create a request.- Returns:
- Result of the CreateEvaluationJob operation returned by the service.
- See Also:
-
createGuardrail
default CreateGuardrailResponse createGuardrail(CreateGuardrailRequest createGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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 Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
createGuardrailRequest-- Returns:
- Result of the CreateGuardrail operation returned by the service.
- See Also:
-
-
createGuardrail
default CreateGuardrailResponse createGuardrail(Consumer<CreateGuardrailRequest.Builder> createGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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 Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateGuardrailRequest.Builderavoiding the need to create one manually viaCreateGuardrailRequest.builder()- Parameters:
createGuardrailRequest- AConsumerthat will call methods onCreateGuardrailRequest.Builderto create a request.- Returns:
- Result of the CreateGuardrail operation returned by the service.
- See Also:
-
-
createGuardrailVersion
default CreateGuardrailVersionResponse createGuardrailVersion(CreateGuardrailVersionRequest createGuardrailVersionRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
createGuardrailVersionRequest-- Returns:
- Result of the CreateGuardrailVersion operation returned by the service.
- See Also:
-
createGuardrailVersion
default CreateGuardrailVersionResponse createGuardrailVersion(Consumer<CreateGuardrailVersionRequest.Builder> createGuardrailVersionRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
CreateGuardrailVersionRequest.Builderavoiding the need to create one manually viaCreateGuardrailVersionRequest.builder()- Parameters:
createGuardrailVersionRequest- AConsumerthat will call methods onCreateGuardrailVersionRequest.Builderto create a request.- Returns:
- Result of the CreateGuardrailVersion operation returned by the service.
- See Also:
-
createModelCopyJob
default CreateModelCopyJobResponse createModelCopyJob(CreateModelCopyJobRequest createModelCopyJobRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, TooManyTagsException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
createModelCopyJobRequest-- Returns:
- Result of the CreateModelCopyJob operation returned by the service.
- See Also:
-
createModelCopyJob
default CreateModelCopyJobResponse createModelCopyJob(Consumer<CreateModelCopyJobRequest.Builder> createModelCopyJobRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, TooManyTagsException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
CreateModelCopyJobRequest.Builderavoiding the need to create one manually viaCreateModelCopyJobRequest.builder()- Parameters:
createModelCopyJobRequest- AConsumerthat will call methods onCreateModelCopyJobRequest.Builderto create a request.- Returns:
- Result of the CreateModelCopyJob operation returned by the service.
- See Also:
-
createModelCustomizationJob
default CreateModelCustomizationJobResponse createModelCustomizationJob(CreateModelCustomizationJobRequest createModelCustomizationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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
GetModelCustomizationJoboperation to retrieve the job status.For more information, see Custom models in the Amazon Bedrock User Guide.
- Parameters:
createModelCustomizationJobRequest-- Returns:
- Result of the CreateModelCustomizationJob operation returned by the service.
- See Also:
-
createModelCustomizationJob
default CreateModelCustomizationJobResponse createModelCustomizationJob(Consumer<CreateModelCustomizationJobRequest.Builder> createModelCustomizationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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
GetModelCustomizationJoboperation to retrieve the job status.For more information, see Custom models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateModelCustomizationJobRequest.Builderavoiding the need to create one manually viaCreateModelCustomizationJobRequest.builder()- Parameters:
createModelCustomizationJobRequest- AConsumerthat will call methods onCreateModelCustomizationJobRequest.Builderto create a request.- Returns:
- Result of the CreateModelCustomizationJob operation returned by the service.
- See Also:
-
createModelImportJob
default CreateModelImportJobResponse createModelImportJob(CreateModelImportJobRequest createModelImportJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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
- Parameters:
createModelImportJobRequest-- Returns:
- Result of the CreateModelImportJob operation returned by the service.
- See Also:
-
createModelImportJob
default CreateModelImportJobResponse createModelImportJob(Consumer<CreateModelImportJobRequest.Builder> createModelImportJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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
This is a convenience which creates an instance of the
CreateModelImportJobRequest.Builderavoiding the need to create one manually viaCreateModelImportJobRequest.builder()- Parameters:
createModelImportJobRequest- AConsumerthat will call methods onCreateModelImportJobRequest.Builderto create a request.- Returns:
- Result of the CreateModelImportJob operation returned by the service.
- See Also:
-
createModelInvocationJob
default CreateModelInvocationJobResponse createModelInvocationJob(CreateModelInvocationJobRequest createModelInvocationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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
jobArnthat you can use to stop or get details about the job.- Parameters:
createModelInvocationJobRequest-- Returns:
- Result of the CreateModelInvocationJob operation returned by the service.
- See Also:
-
createModelInvocationJob
default CreateModelInvocationJobResponse createModelInvocationJob(Consumer<CreateModelInvocationJobRequest.Builder> createModelInvocationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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
jobArnthat you can use to stop or get details about the job.
This is a convenience which creates an instance of the
CreateModelInvocationJobRequest.Builderavoiding the need to create one manually viaCreateModelInvocationJobRequest.builder()- Parameters:
createModelInvocationJobRequest- AConsumerthat will call methods onCreateModelInvocationJobRequest.Builderto create a request.- Returns:
- Result of the CreateModelInvocationJob operation returned by the service.
- See Also:
-
createProvisionedModelThroughput
default CreateProvisionedModelThroughputResponse createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest createProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
createProvisionedModelThroughputRequest-- Returns:
- Result of the CreateProvisionedModelThroughput operation returned by the service.
- See Also:
-
createProvisionedModelThroughput
default CreateProvisionedModelThroughputResponse createProvisionedModelThroughput(Consumer<CreateProvisionedModelThroughputRequest.Builder> createProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, TooManyTagsException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
CreateProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaCreateProvisionedModelThroughputRequest.builder()- Parameters:
createProvisionedModelThroughputRequest- AConsumerthat will call methods onCreateProvisionedModelThroughputRequest.Builderto create a request.- Returns:
- Result of the CreateProvisionedModelThroughput operation returned by the service.
- See Also:
-
deleteCustomModel
default DeleteCustomModelResponse deleteCustomModel(DeleteCustomModelRequest deleteCustomModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
- Parameters:
deleteCustomModelRequest-- Returns:
- Result of the DeleteCustomModel operation returned by the service.
- See Also:
-
deleteCustomModel
default DeleteCustomModelResponse deleteCustomModel(Consumer<DeleteCustomModelRequest.Builder> deleteCustomModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
DeleteCustomModelRequest.Builderavoiding the need to create one manually viaDeleteCustomModelRequest.builder()- Parameters:
deleteCustomModelRequest- AConsumerthat will call methods onDeleteCustomModelRequest.Builderto create a request.- Returns:
- Result of the DeleteCustomModel operation returned by the service.
- See Also:
-
deleteGuardrail
default DeleteGuardrailResponse deleteGuardrail(DeleteGuardrailRequest deleteGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Deletes a guardrail.
-
To delete a guardrail, only specify the ARN of the guardrail in the
guardrailIdentifierfield. 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
guardrailIdentifierfield and the version in theguardrailVersionfield.
- Parameters:
deleteGuardrailRequest-- Returns:
- Result of the DeleteGuardrail operation returned by the service.
- See Also:
-
-
deleteGuardrail
default DeleteGuardrailResponse deleteGuardrail(Consumer<DeleteGuardrailRequest.Builder> deleteGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Deletes a guardrail.
-
To delete a guardrail, only specify the ARN of the guardrail in the
guardrailIdentifierfield. 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
guardrailIdentifierfield and the version in theguardrailVersionfield.
This is a convenience which creates an instance of the
DeleteGuardrailRequest.Builderavoiding the need to create one manually viaDeleteGuardrailRequest.builder()- Parameters:
deleteGuardrailRequest- AConsumerthat will call methods onDeleteGuardrailRequest.Builderto create a request.- Returns:
- Result of the DeleteGuardrail operation returned by the service.
- See Also:
-
-
deleteImportedModel
default DeleteImportedModelResponse deleteImportedModel(DeleteImportedModelRequest deleteImportedModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.
- Parameters:
deleteImportedModelRequest-- Returns:
- Result of the DeleteImportedModel operation returned by the service.
- See Also:
-
deleteImportedModel
default DeleteImportedModelResponse deleteImportedModel(Consumer<DeleteImportedModelRequest.Builder> deleteImportedModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
DeleteImportedModelRequest.Builderavoiding the need to create one manually viaDeleteImportedModelRequest.builder()- Parameters:
deleteImportedModelRequest- AConsumerthat will call methods onDeleteImportedModelRequest.Builderto create a request.- Returns:
- Result of the DeleteImportedModel operation returned by the service.
- See Also:
-
deleteModelInvocationLoggingConfiguration
default DeleteModelInvocationLoggingConfigurationResponse deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest deleteModelInvocationLoggingConfigurationRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Delete the invocation logging.
- Parameters:
deleteModelInvocationLoggingConfigurationRequest-- Returns:
- Result of the DeleteModelInvocationLoggingConfiguration operation returned by the service.
- See Also:
-
deleteModelInvocationLoggingConfiguration
default DeleteModelInvocationLoggingConfigurationResponse deleteModelInvocationLoggingConfiguration(Consumer<DeleteModelInvocationLoggingConfigurationRequest.Builder> deleteModelInvocationLoggingConfigurationRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Delete the invocation logging.
This is a convenience which creates an instance of the
DeleteModelInvocationLoggingConfigurationRequest.Builderavoiding the need to create one manually viaDeleteModelInvocationLoggingConfigurationRequest.builder()- Parameters:
deleteModelInvocationLoggingConfigurationRequest- AConsumerthat will call methods onDeleteModelInvocationLoggingConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteModelInvocationLoggingConfiguration operation returned by the service.
- See Also:
-
deleteProvisionedModelThroughput
default DeleteProvisionedModelThroughputResponse deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest deleteProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
deleteProvisionedModelThroughputRequest-- Returns:
- Result of the DeleteProvisionedModelThroughput operation returned by the service.
- See Also:
-
deleteProvisionedModelThroughput
default DeleteProvisionedModelThroughputResponse deleteProvisionedModelThroughput(Consumer<DeleteProvisionedModelThroughputRequest.Builder> deleteProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
DeleteProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaDeleteProvisionedModelThroughputRequest.builder()- Parameters:
deleteProvisionedModelThroughputRequest- AConsumerthat will call methods onDeleteProvisionedModelThroughputRequest.Builderto create a request.- Returns:
- Result of the DeleteProvisionedModelThroughput operation returned by the service.
- See Also:
-
getCustomModel
default GetCustomModelResponse getCustomModel(GetCustomModelRequest getCustomModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
getCustomModelRequest-- Returns:
- Result of the GetCustomModel operation returned by the service.
- See Also:
-
getCustomModel
default GetCustomModelResponse getCustomModel(Consumer<GetCustomModelRequest.Builder> getCustomModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
GetCustomModelRequest.Builderavoiding the need to create one manually viaGetCustomModelRequest.builder()- Parameters:
getCustomModelRequest- AConsumerthat will call methods onGetCustomModelRequest.Builderto create a request.- Returns:
- Result of the GetCustomModel operation returned by the service.
- See Also:
-
getEvaluationJob
default GetEvaluationJobResponse getEvaluationJob(GetEvaluationJobRequest getEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluation.
- Parameters:
getEvaluationJobRequest-- Returns:
- Result of the GetEvaluationJob operation returned by the service.
- See Also:
-
getEvaluationJob
default GetEvaluationJobResponse getEvaluationJob(Consumer<GetEvaluationJobRequest.Builder> getEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluation.
This is a convenience which creates an instance of the
GetEvaluationJobRequest.Builderavoiding the need to create one manually viaGetEvaluationJobRequest.builder()- Parameters:
getEvaluationJobRequest- AConsumerthat will call methods onGetEvaluationJobRequest.Builderto create a request.- Returns:
- Result of the GetEvaluationJob operation returned by the service.
- See Also:
-
getFoundationModel
default GetFoundationModelResponse getFoundationModel(GetFoundationModelRequest getFoundationModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Get details about a Amazon Bedrock foundation model.
- Parameters:
getFoundationModelRequest-- Returns:
- Result of the GetFoundationModel operation returned by the service.
- See Also:
-
getFoundationModel
default GetFoundationModelResponse getFoundationModel(Consumer<GetFoundationModelRequest.Builder> getFoundationModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Get details about a Amazon Bedrock foundation model.
This is a convenience which creates an instance of the
GetFoundationModelRequest.Builderavoiding the need to create one manually viaGetFoundationModelRequest.builder()- Parameters:
getFoundationModelRequest- AConsumerthat will call methods onGetFoundationModelRequest.Builderto create a request.- Returns:
- Result of the GetFoundationModel operation returned by the service.
- See Also:
-
getGuardrail
default GetGuardrailResponse getGuardrail(GetGuardrailRequest getGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets details about a guardrail. If you don't specify a version, the response returns details for the
DRAFTversion.- Parameters:
getGuardrailRequest-- Returns:
- Result of the GetGuardrail operation returned by the service.
- See Also:
-
getGuardrail
default GetGuardrailResponse getGuardrail(Consumer<GetGuardrailRequest.Builder> getGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets details about a guardrail. If you don't specify a version, the response returns details for the
DRAFTversion.
This is a convenience which creates an instance of the
GetGuardrailRequest.Builderavoiding the need to create one manually viaGetGuardrailRequest.builder()- Parameters:
getGuardrailRequest- AConsumerthat will call methods onGetGuardrailRequest.Builderto create a request.- Returns:
- Result of the GetGuardrail operation returned by the service.
- See Also:
-
getImportedModel
default GetImportedModelResponse getImportedModel(GetImportedModelRequest getImportedModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets properties associated with a customized model you imported.
- Parameters:
getImportedModelRequest-- Returns:
- Result of the GetImportedModel operation returned by the service.
- See Also:
-
getImportedModel
default GetImportedModelResponse getImportedModel(Consumer<GetImportedModelRequest.Builder> getImportedModelRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets properties associated with a customized model you imported.
This is a convenience which creates an instance of the
GetImportedModelRequest.Builderavoiding the need to create one manually viaGetImportedModelRequest.builder()- Parameters:
getImportedModelRequest- AConsumerthat will call methods onGetImportedModelRequest.Builderto create a request.- Returns:
- Result of the GetImportedModel operation returned by the service.
- See Also:
-
getInferenceProfile
default GetInferenceProfileResponse getInferenceProfile(GetInferenceProfileRequest getInferenceProfileRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets information about an inference profile. For more information, see the Amazon Bedrock User Guide.
- Parameters:
getInferenceProfileRequest-- Returns:
- Result of the GetInferenceProfile operation returned by the service.
- See Also:
-
getInferenceProfile
default GetInferenceProfileResponse getInferenceProfile(Consumer<GetInferenceProfileRequest.Builder> getInferenceProfileRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets information about an inference profile. For more information, see the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetInferenceProfileRequest.Builderavoiding the need to create one manually viaGetInferenceProfileRequest.builder()- Parameters:
getInferenceProfileRequest- AConsumerthat will call methods onGetInferenceProfileRequest.Builderto create a request.- Returns:
- Result of the GetInferenceProfile operation returned by the service.
- See Also:
-
getModelCopyJob
default GetModelCopyJobResponse getModelCopyJob(GetModelCopyJobRequest getModelCopyJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
getModelCopyJobRequest-- Returns:
- Result of the GetModelCopyJob operation returned by the service.
- See Also:
-
getModelCopyJob
default GetModelCopyJobResponse getModelCopyJob(Consumer<GetModelCopyJobRequest.Builder> getModelCopyJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
GetModelCopyJobRequest.Builderavoiding the need to create one manually viaGetModelCopyJobRequest.builder()- Parameters:
getModelCopyJobRequest- AConsumerthat will call methods onGetModelCopyJobRequest.Builderto create a request.- Returns:
- Result of the GetModelCopyJob operation returned by the service.
- See Also:
-
getModelCustomizationJob
default GetModelCustomizationJobResponse getModelCustomizationJob(GetModelCustomizationJobRequest getModelCustomizationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
getModelCustomizationJobRequest-- Returns:
- Result of the GetModelCustomizationJob operation returned by the service.
- See Also:
-
getModelCustomizationJob
default GetModelCustomizationJobResponse getModelCustomizationJob(Consumer<GetModelCustomizationJobRequest.Builder> getModelCustomizationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
GetModelCustomizationJobRequest.Builderavoiding the need to create one manually viaGetModelCustomizationJobRequest.builder()- Parameters:
getModelCustomizationJobRequest- AConsumerthat will call methods onGetModelCustomizationJobRequest.Builderto create a request.- Returns:
- Result of the GetModelCustomizationJob operation returned by the service.
- See Also:
-
getModelImportJob
default GetModelImportJobResponse getModelImportJob(GetModelImportJobRequest getModelImportJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
getModelImportJobRequest-- Returns:
- Result of the GetModelImportJob operation returned by the service.
- See Also:
-
getModelImportJob
default GetModelImportJobResponse getModelImportJob(Consumer<GetModelImportJobRequest.Builder> getModelImportJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
GetModelImportJobRequest.Builderavoiding the need to create one manually viaGetModelImportJobRequest.builder()- Parameters:
getModelImportJobRequest- AConsumerthat will call methods onGetModelImportJobRequest.Builderto create a request.- Returns:
- Result of the GetModelImportJob operation returned by the service.
- See Also:
-
getModelInvocationJob
default GetModelInvocationJobResponse getModelInvocationJob(GetModelInvocationJobRequest getModelInvocationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets details about a batch inference job. For more information, see View details about a batch inference job
- Parameters:
getModelInvocationJobRequest-- Returns:
- Result of the GetModelInvocationJob operation returned by the service.
- See Also:
-
getModelInvocationJob
default GetModelInvocationJobResponse getModelInvocationJob(Consumer<GetModelInvocationJobRequest.Builder> getModelInvocationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Gets details about a batch inference job. For more information, see View details about a batch inference job
This is a convenience which creates an instance of the
GetModelInvocationJobRequest.Builderavoiding the need to create one manually viaGetModelInvocationJobRequest.builder()- Parameters:
getModelInvocationJobRequest- AConsumerthat will call methods onGetModelInvocationJobRequest.Builderto create a request.- Returns:
- Result of the GetModelInvocationJob operation returned by the service.
- See Also:
-
getModelInvocationLoggingConfiguration
default GetModelInvocationLoggingConfigurationResponse getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest getModelInvocationLoggingConfigurationRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Get the current configuration values for model invocation logging.
- Parameters:
getModelInvocationLoggingConfigurationRequest-- Returns:
- Result of the GetModelInvocationLoggingConfiguration operation returned by the service.
- See Also:
-
getModelInvocationLoggingConfiguration
default GetModelInvocationLoggingConfigurationResponse getModelInvocationLoggingConfiguration(Consumer<GetModelInvocationLoggingConfigurationRequest.Builder> getModelInvocationLoggingConfigurationRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Get the current configuration values for model invocation logging.
This is a convenience which creates an instance of the
GetModelInvocationLoggingConfigurationRequest.Builderavoiding the need to create one manually viaGetModelInvocationLoggingConfigurationRequest.builder()- Parameters:
getModelInvocationLoggingConfigurationRequest- AConsumerthat will call methods onGetModelInvocationLoggingConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetModelInvocationLoggingConfiguration operation returned by the service.
- See Also:
-
getProvisionedModelThroughput
default GetProvisionedModelThroughputResponse getProvisionedModelThroughput(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
- Parameters:
getProvisionedModelThroughputRequest-- Returns:
- Result of the GetProvisionedModelThroughput operation returned by the service.
- See Also:
-
getProvisionedModelThroughput
default GetProvisionedModelThroughputResponse getProvisionedModelThroughput(Consumer<GetProvisionedModelThroughputRequest.Builder> getProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaGetProvisionedModelThroughputRequest.builder()- Parameters:
getProvisionedModelThroughputRequest- AConsumerthat will call methods onGetProvisionedModelThroughputRequest.Builderto create a request.- Returns:
- Result of the GetProvisionedModelThroughput operation returned by the service.
- See Also:
-
listCustomModels
default ListCustomModelsResponse listCustomModels(ListCustomModelsRequest listCustomModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Returns a list of the custom models that you have created with the
CreateModelCustomizationJoboperation.For more information, see Custom models in the Amazon Bedrock User Guide.
- Parameters:
listCustomModelsRequest-- Returns:
- Result of the ListCustomModels operation returned by the service.
- See Also:
-
listCustomModels
default ListCustomModelsResponse listCustomModels(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Returns a list of the custom models that you have created with the
CreateModelCustomizationJoboperation.For more information, see Custom models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListCustomModelsRequest.Builderavoiding the need to create one manually viaListCustomModelsRequest.builder()- Parameters:
listCustomModelsRequest- AConsumerthat will call methods onListCustomModelsRequest.Builderto create a request.- Returns:
- Result of the ListCustomModels operation returned by the service.
- See Also:
-
listCustomModelsPaginator
default ListCustomModelsIterable listCustomModelsPaginator(ListCustomModelsRequest listCustomModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsIterable responses = client.listCustomModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListCustomModelsIterable responses = client .listCustomModelsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListCustomModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsIterable responses = client.listCustomModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation.- Parameters:
listCustomModelsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCustomModelsPaginator
default ListCustomModelsIterable listCustomModelsPaginator(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsIterable responses = client.listCustomModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListCustomModelsIterable responses = client .listCustomModelsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListCustomModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsIterable responses = client.listCustomModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation.
This is a convenience which creates an instance of the
ListCustomModelsRequest.Builderavoiding the need to create one manually viaListCustomModelsRequest.builder()- Parameters:
listCustomModelsRequest- AConsumerthat will call methods onListCustomModelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEvaluationJobs
default ListEvaluationJobsResponse listEvaluationJobs(ListEvaluationJobsRequest listEvaluationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists model evaluation jobs.
- Parameters:
listEvaluationJobsRequest-- Returns:
- Result of the ListEvaluationJobs operation returned by the service.
- See Also:
-
listEvaluationJobs
default ListEvaluationJobsResponse listEvaluationJobs(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists model evaluation jobs.
This is a convenience which creates an instance of the
ListEvaluationJobsRequest.Builderavoiding the need to create one manually viaListEvaluationJobsRequest.builder()- Parameters:
listEvaluationJobsRequest- AConsumerthat will call methods onListEvaluationJobsRequest.Builderto create a request.- Returns:
- Result of the ListEvaluationJobs operation returned by the service.
- See Also:
-
listEvaluationJobsPaginator
default ListEvaluationJobsIterable listEvaluationJobsPaginator(ListEvaluationJobsRequest listEvaluationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsIterable responses = client.listEvaluationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsIterable responses = client .listEvaluationJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsIterable responses = client.listEvaluationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.- Parameters:
listEvaluationJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listEvaluationJobsPaginator
default ListEvaluationJobsIterable listEvaluationJobsPaginator(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsIterable responses = client.listEvaluationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsIterable responses = client .listEvaluationJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsIterable responses = client.listEvaluationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.
This is a convenience which creates an instance of the
ListEvaluationJobsRequest.Builderavoiding the need to create one manually viaListEvaluationJobsRequest.builder()- Parameters:
listEvaluationJobsRequest- AConsumerthat will call methods onListEvaluationJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFoundationModels
default ListFoundationModelsResponse listFoundationModels(ListFoundationModelsRequest listFoundationModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
listFoundationModelsRequest-- Returns:
- Result of the ListFoundationModels operation returned by the service.
- See Also:
-
listFoundationModels
default ListFoundationModelsResponse listFoundationModels(Consumer<ListFoundationModelsRequest.Builder> listFoundationModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
ListFoundationModelsRequest.Builderavoiding the need to create one manually viaListFoundationModelsRequest.builder()- Parameters:
listFoundationModelsRequest- AConsumerthat will call methods onListFoundationModelsRequest.Builderto create a request.- Returns:
- Result of the ListFoundationModels operation returned by the service.
- See Also:
-
listGuardrails
default ListGuardrailsResponse listGuardrails(ListGuardrailsRequest listGuardrailsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists details about all the guardrails in an account. To list the
DRAFTversion of all your guardrails, don't specify theguardrailIdentifierfield. To list all versions of a guardrail, specify the ARN of the guardrail in theguardrailIdentifierfield.You can set the maximum number of results to return in a response in the
maxResultsfield. If there are more results than the number you set, the response returns anextTokenthat you can send in anotherListGuardrailsrequest to see the next batch of results.- Parameters:
listGuardrailsRequest-- Returns:
- Result of the ListGuardrails operation returned by the service.
- See Also:
-
listGuardrails
default ListGuardrailsResponse listGuardrails(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists details about all the guardrails in an account. To list the
DRAFTversion of all your guardrails, don't specify theguardrailIdentifierfield. To list all versions of a guardrail, specify the ARN of the guardrail in theguardrailIdentifierfield.You can set the maximum number of results to return in a response in the
maxResultsfield. If there are more results than the number you set, the response returns anextTokenthat you can send in anotherListGuardrailsrequest to see the next batch of results.
This is a convenience which creates an instance of the
ListGuardrailsRequest.Builderavoiding the need to create one manually viaListGuardrailsRequest.builder()- Parameters:
listGuardrailsRequest- AConsumerthat will call methods onListGuardrailsRequest.Builderto create a request.- Returns:
- Result of the ListGuardrails operation returned by the service.
- See Also:
-
listGuardrailsPaginator
default ListGuardrailsIterable listGuardrailsPaginator(ListGuardrailsRequest listGuardrailsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListGuardrailsIterable responses = client.listGuardrailsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListGuardrailsIterable responses = client.listGuardrailsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListGuardrailsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListGuardrailsIterable responses = client.listGuardrailsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.- Parameters:
listGuardrailsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listGuardrailsPaginator
default ListGuardrailsIterable listGuardrailsPaginator(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListGuardrailsIterable responses = client.listGuardrailsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListGuardrailsIterable responses = client.listGuardrailsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListGuardrailsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListGuardrailsIterable responses = client.listGuardrailsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.
This is a convenience which creates an instance of the
ListGuardrailsRequest.Builderavoiding the need to create one manually viaListGuardrailsRequest.builder()- Parameters:
listGuardrailsRequest- AConsumerthat will call methods onListGuardrailsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportedModels
default ListImportedModelsResponse listImportedModels(ListImportedModelsRequest listImportedModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
listImportedModelsRequest-- Returns:
- Result of the ListImportedModels operation returned by the service.
- See Also:
-
listImportedModels
default ListImportedModelsResponse listImportedModels(Consumer<ListImportedModelsRequest.Builder> listImportedModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
ListImportedModelsRequest.Builderavoiding the need to create one manually viaListImportedModelsRequest.builder()- Parameters:
listImportedModelsRequest- AConsumerthat will call methods onListImportedModelsRequest.Builderto create a request.- Returns:
- Result of the ListImportedModels operation returned by the service.
- See Also:
-
listImportedModelsPaginator
default ListImportedModelsIterable listImportedModelsPaginator(ListImportedModelsRequest listImportedModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listImportedModels(software.amazon.awssdk.services.bedrock.model.ListImportedModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListImportedModelsIterable responses = client.listImportedModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListImportedModelsIterable responses = client .listImportedModelsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListImportedModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListImportedModelsIterable responses = client.listImportedModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportedModels(software.amazon.awssdk.services.bedrock.model.ListImportedModelsRequest)operation.- Parameters:
listImportedModelsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportedModelsPaginator
default ListImportedModelsIterable listImportedModelsPaginator(Consumer<ListImportedModelsRequest.Builder> listImportedModelsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listImportedModels(software.amazon.awssdk.services.bedrock.model.ListImportedModelsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListImportedModelsIterable responses = client.listImportedModelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListImportedModelsIterable responses = client .listImportedModelsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListImportedModelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListImportedModelsIterable responses = client.listImportedModelsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportedModels(software.amazon.awssdk.services.bedrock.model.ListImportedModelsRequest)operation.
This is a convenience which creates an instance of the
ListImportedModelsRequest.Builderavoiding the need to create one manually viaListImportedModelsRequest.builder()- Parameters:
listImportedModelsRequest- AConsumerthat will call methods onListImportedModelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInferenceProfiles
default ListInferenceProfilesResponse listInferenceProfiles(ListInferenceProfilesRequest listInferenceProfilesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Returns a list of inference profiles that you can use.
- Parameters:
listInferenceProfilesRequest-- Returns:
- Result of the ListInferenceProfiles operation returned by the service.
- See Also:
-
listInferenceProfiles
default ListInferenceProfilesResponse listInferenceProfiles(Consumer<ListInferenceProfilesRequest.Builder> listInferenceProfilesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Returns a list of inference profiles that you can use.
This is a convenience which creates an instance of the
ListInferenceProfilesRequest.Builderavoiding the need to create one manually viaListInferenceProfilesRequest.builder()- Parameters:
listInferenceProfilesRequest- AConsumerthat will call methods onListInferenceProfilesRequest.Builderto create a request.- Returns:
- Result of the ListInferenceProfiles operation returned by the service.
- See Also:
-
listInferenceProfilesPaginator
default ListInferenceProfilesIterable listInferenceProfilesPaginator(ListInferenceProfilesRequest listInferenceProfilesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listInferenceProfiles(software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListInferenceProfilesIterable responses = client.listInferenceProfilesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListInferenceProfilesIterable responses = client .listInferenceProfilesPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListInferenceProfilesIterable responses = client.listInferenceProfilesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInferenceProfiles(software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesRequest)operation.- Parameters:
listInferenceProfilesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listInferenceProfilesPaginator
default ListInferenceProfilesIterable listInferenceProfilesPaginator(Consumer<ListInferenceProfilesRequest.Builder> listInferenceProfilesRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listInferenceProfiles(software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListInferenceProfilesIterable responses = client.listInferenceProfilesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListInferenceProfilesIterable responses = client .listInferenceProfilesPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListInferenceProfilesIterable responses = client.listInferenceProfilesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInferenceProfiles(software.amazon.awssdk.services.bedrock.model.ListInferenceProfilesRequest)operation.
This is a convenience which creates an instance of the
ListInferenceProfilesRequest.Builderavoiding the need to create one manually viaListInferenceProfilesRequest.builder()- Parameters:
listInferenceProfilesRequest- AConsumerthat will call methods onListInferenceProfilesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelCopyJobs
default ListModelCopyJobsResponse listModelCopyJobs(ListModelCopyJobsRequest listModelCopyJobsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
listModelCopyJobsRequest-- Returns:
- Result of the ListModelCopyJobs operation returned by the service.
- See Also:
-
listModelCopyJobs
default ListModelCopyJobsResponse listModelCopyJobs(Consumer<ListModelCopyJobsRequest.Builder> listModelCopyJobsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
ListModelCopyJobsRequest.Builderavoiding the need to create one manually viaListModelCopyJobsRequest.builder()- Parameters:
listModelCopyJobsRequest- AConsumerthat will call methods onListModelCopyJobsRequest.Builderto create a request.- Returns:
- Result of the ListModelCopyJobs operation returned by the service.
- See Also:
-
listModelCopyJobsPaginator
default ListModelCopyJobsIterable listModelCopyJobsPaginator(ListModelCopyJobsRequest listModelCopyJobsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelCopyJobs(software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelCopyJobsIterable responses = client.listModelCopyJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelCopyJobsIterable responses = client .listModelCopyJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelCopyJobsIterable responses = client.listModelCopyJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelCopyJobs(software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsRequest)operation.- Parameters:
listModelCopyJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelCopyJobsPaginator
default ListModelCopyJobsIterable listModelCopyJobsPaginator(Consumer<ListModelCopyJobsRequest.Builder> listModelCopyJobsRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelCopyJobs(software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelCopyJobsIterable responses = client.listModelCopyJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelCopyJobsIterable responses = client .listModelCopyJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelCopyJobsIterable responses = client.listModelCopyJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelCopyJobs(software.amazon.awssdk.services.bedrock.model.ListModelCopyJobsRequest)operation.
This is a convenience which creates an instance of the
ListModelCopyJobsRequest.Builderavoiding the need to create one manually viaListModelCopyJobsRequest.builder()- Parameters:
listModelCopyJobsRequest- AConsumerthat will call methods onListModelCopyJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelCustomizationJobs
default ListModelCustomizationJobsResponse listModelCustomizationJobs(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
listModelCustomizationJobsRequest-- Returns:
- Result of the ListModelCustomizationJobs operation returned by the service.
- See Also:
-
listModelCustomizationJobs
default ListModelCustomizationJobsResponse listModelCustomizationJobs(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
ListModelCustomizationJobsRequest.Builderavoiding the need to create one manually viaListModelCustomizationJobsRequest.builder()- Parameters:
listModelCustomizationJobsRequest- AConsumerthat will call methods onListModelCustomizationJobsRequest.Builderto create a request.- Returns:
- Result of the ListModelCustomizationJobs operation returned by the service.
- See Also:
-
listModelCustomizationJobsPaginator
default ListModelCustomizationJobsIterable listModelCustomizationJobsPaginator(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsIterable responses = client.listModelCustomizationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsIterable responses = client .listModelCustomizationJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsIterable responses = client.listModelCustomizationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation.- Parameters:
listModelCustomizationJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelCustomizationJobsPaginator
default ListModelCustomizationJobsIterable listModelCustomizationJobsPaginator(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsIterable responses = client.listModelCustomizationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsIterable responses = client .listModelCustomizationJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsIterable responses = client.listModelCustomizationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation.
This is a convenience which creates an instance of the
ListModelCustomizationJobsRequest.Builderavoiding the need to create one manually viaListModelCustomizationJobsRequest.builder()- Parameters:
listModelCustomizationJobsRequest- AConsumerthat will call methods onListModelCustomizationJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelImportJobs
default ListModelImportJobsResponse listModelImportJobs(ListModelImportJobsRequest listModelImportJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
- Parameters:
listModelImportJobsRequest-- Returns:
- Result of the ListModelImportJobs operation returned by the service.
- See Also:
-
listModelImportJobs
default ListModelImportJobsResponse listModelImportJobs(Consumer<ListModelImportJobsRequest.Builder> listModelImportJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException 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.
This is a convenience which creates an instance of the
ListModelImportJobsRequest.Builderavoiding the need to create one manually viaListModelImportJobsRequest.builder()- Parameters:
listModelImportJobsRequest- AConsumerthat will call methods onListModelImportJobsRequest.Builderto create a request.- Returns:
- Result of the ListModelImportJobs operation returned by the service.
- See Also:
-
listModelImportJobsPaginator
default ListModelImportJobsIterable listModelImportJobsPaginator(ListModelImportJobsRequest listModelImportJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelImportJobs(software.amazon.awssdk.services.bedrock.model.ListModelImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelImportJobsIterable responses = client.listModelImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelImportJobsIterable responses = client .listModelImportJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelImportJobsIterable responses = client.listModelImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelImportJobs(software.amazon.awssdk.services.bedrock.model.ListModelImportJobsRequest)operation.- Parameters:
listModelImportJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelImportJobsPaginator
default ListModelImportJobsIterable listModelImportJobsPaginator(Consumer<ListModelImportJobsRequest.Builder> listModelImportJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelImportJobs(software.amazon.awssdk.services.bedrock.model.ListModelImportJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelImportJobsIterable responses = client.listModelImportJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelImportJobsIterable responses = client .listModelImportJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelImportJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelImportJobsIterable responses = client.listModelImportJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelImportJobs(software.amazon.awssdk.services.bedrock.model.ListModelImportJobsRequest)operation.
This is a convenience which creates an instance of the
ListModelImportJobsRequest.Builderavoiding the need to create one manually viaListModelImportJobsRequest.builder()- Parameters:
listModelImportJobsRequest- AConsumerthat will call methods onListModelImportJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelInvocationJobs
default ListModelInvocationJobsResponse listModelInvocationJobs(ListModelInvocationJobsRequest listModelInvocationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
- Parameters:
listModelInvocationJobsRequest-- Returns:
- Result of the ListModelInvocationJobs operation returned by the service.
- See Also:
-
listModelInvocationJobs
default ListModelInvocationJobsResponse listModelInvocationJobs(Consumer<ListModelInvocationJobsRequest.Builder> listModelInvocationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
This is a convenience which creates an instance of the
ListModelInvocationJobsRequest.Builderavoiding the need to create one manually viaListModelInvocationJobsRequest.builder()- Parameters:
listModelInvocationJobsRequest- AConsumerthat will call methods onListModelInvocationJobsRequest.Builderto create a request.- Returns:
- Result of the ListModelInvocationJobs operation returned by the service.
- See Also:
-
listModelInvocationJobsPaginator
default ListModelInvocationJobsIterable listModelInvocationJobsPaginator(ListModelInvocationJobsRequest listModelInvocationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelInvocationJobs(software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelInvocationJobsIterable responses = client.listModelInvocationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelInvocationJobsIterable responses = client .listModelInvocationJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelInvocationJobsIterable responses = client.listModelInvocationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelInvocationJobs(software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsRequest)operation.- Parameters:
listModelInvocationJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listModelInvocationJobsPaginator
default ListModelInvocationJobsIterable listModelInvocationJobsPaginator(Consumer<ListModelInvocationJobsRequest.Builder> listModelInvocationJobsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listModelInvocationJobs(software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListModelInvocationJobsIterable responses = client.listModelInvocationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListModelInvocationJobsIterable responses = client .listModelInvocationJobsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListModelInvocationJobsIterable responses = client.listModelInvocationJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelInvocationJobs(software.amazon.awssdk.services.bedrock.model.ListModelInvocationJobsRequest)operation.
This is a convenience which creates an instance of the
ListModelInvocationJobsRequest.Builderavoiding the need to create one manually viaListModelInvocationJobsRequest.builder()- Parameters:
listModelInvocationJobsRequest- AConsumerthat will call methods onListModelInvocationJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProvisionedModelThroughputs
default ListProvisionedModelThroughputsResponse listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
- Parameters:
listProvisionedModelThroughputsRequest-- Returns:
- Result of the ListProvisionedModelThroughputs operation returned by the service.
- See Also:
-
listProvisionedModelThroughputs
default ListProvisionedModelThroughputsResponse listProvisionedModelThroughputs(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListProvisionedModelThroughputsRequest.Builderavoiding the need to create one manually viaListProvisionedModelThroughputsRequest.builder()- Parameters:
listProvisionedModelThroughputsRequest- AConsumerthat will call methods onListProvisionedModelThroughputsRequest.Builderto create a request.- Returns:
- Result of the ListProvisionedModelThroughputs operation returned by the service.
- See Also:
-
listProvisionedModelThroughputsPaginator
default ListProvisionedModelThroughputsIterable listProvisionedModelThroughputsPaginator(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsIterable responses = client.listProvisionedModelThroughputsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsIterable responses = client .listProvisionedModelThroughputsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsIterable responses = client.listProvisionedModelThroughputsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation.- Parameters:
listProvisionedModelThroughputsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProvisionedModelThroughputsPaginator
default ListProvisionedModelThroughputsIterable listProvisionedModelThroughputsPaginator(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException This is a variant of
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsIterable responses = client.listProvisionedModelThroughputsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsIterable responses = client .listProvisionedModelThroughputsPaginator(request); for (software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsIterable responses = client.listProvisionedModelThroughputsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation.
This is a convenience which creates an instance of the
ListProvisionedModelThroughputsRequest.Builderavoiding the need to create one manually viaListProvisionedModelThroughputsRequest.builder()- Parameters:
listProvisionedModelThroughputsRequest- AConsumerthat will call methods onListProvisionedModelThroughputsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException List the tags associated with the specified resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException List the tags associated with the specified resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putModelInvocationLoggingConfiguration
default PutModelInvocationLoggingConfigurationResponse putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest putModelInvocationLoggingConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Set the configuration values for model invocation logging.
- Parameters:
putModelInvocationLoggingConfigurationRequest-- Returns:
- Result of the PutModelInvocationLoggingConfiguration operation returned by the service.
- See Also:
-
putModelInvocationLoggingConfiguration
default PutModelInvocationLoggingConfigurationResponse putModelInvocationLoggingConfiguration(Consumer<PutModelInvocationLoggingConfigurationRequest.Builder> putModelInvocationLoggingConfigurationRequest) throws AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Set the configuration values for model invocation logging.
This is a convenience which creates an instance of the
PutModelInvocationLoggingConfigurationRequest.Builderavoiding the need to create one manually viaPutModelInvocationLoggingConfigurationRequest.builder()- Parameters:
putModelInvocationLoggingConfigurationRequest- AConsumerthat will call methods onPutModelInvocationLoggingConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutModelInvocationLoggingConfiguration operation returned by the service.
- See Also:
-
stopEvaluationJob
default StopEvaluationJobResponse stopEvaluationJob(StopEvaluationJobRequest stopEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Stops an in progress model evaluation job.
- Parameters:
stopEvaluationJobRequest-- Returns:
- Result of the StopEvaluationJob operation returned by the service.
- See Also:
-
stopEvaluationJob
default StopEvaluationJobResponse stopEvaluationJob(Consumer<StopEvaluationJobRequest.Builder> stopEvaluationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Stops an in progress model evaluation job.
This is a convenience which creates an instance of the
StopEvaluationJobRequest.Builderavoiding the need to create one manually viaStopEvaluationJobRequest.builder()- Parameters:
stopEvaluationJobRequest- AConsumerthat will call methods onStopEvaluationJobRequest.Builderto create a request.- Returns:
- Result of the StopEvaluationJob operation returned by the service.
- See Also:
-
stopModelCustomizationJob
default StopModelCustomizationJobResponse stopModelCustomizationJob(StopModelCustomizationJobRequest stopModelCustomizationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
- Parameters:
stopModelCustomizationJobRequest-- Returns:
- Result of the StopModelCustomizationJob operation returned by the service.
- See Also:
-
stopModelCustomizationJob
default StopModelCustomizationJobResponse stopModelCustomizationJob(Consumer<StopModelCustomizationJobRequest.Builder> stopModelCustomizationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
StopModelCustomizationJobRequest.Builderavoiding the need to create one manually viaStopModelCustomizationJobRequest.builder()- Parameters:
stopModelCustomizationJobRequest- AConsumerthat will call methods onStopModelCustomizationJobRequest.Builderto create a request.- Returns:
- Result of the StopModelCustomizationJob operation returned by the service.
- See Also:
-
stopModelInvocationJob
default StopModelInvocationJobResponse stopModelInvocationJob(StopModelInvocationJobRequest stopModelInvocationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.
- Parameters:
stopModelInvocationJobRequest-- Returns:
- Result of the StopModelInvocationJob operation returned by the service.
- See Also:
-
stopModelInvocationJob
default StopModelInvocationJobResponse stopModelInvocationJob(Consumer<StopModelInvocationJobRequest.Builder> stopModelInvocationJobRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.
This is a convenience which creates an instance of the
StopModelInvocationJobRequest.Builderavoiding the need to create one manually viaStopModelInvocationJobRequest.builder()- Parameters:
stopModelInvocationJobRequest- AConsumerthat will call methods onStopModelInvocationJobRequest.Builderto create a request.- Returns:
- Result of the StopModelInvocationJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, TooManyTagsException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, TooManyTagsException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateGuardrail
default UpdateGuardrailResponse updateGuardrail(UpdateGuardrailRequest updateGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Updates a guardrail with the values you specify.
-
Specify a
nameand optionaldescription. -
Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessagingandblockedOutputsMessagingfields. -
Specify topics for the guardrail to deny in the
topicPolicyConfigobject. Each GuardrailTopicConfig object in thetopicsConfiglist pertains to one topic.-
Give a
nameanddescriptionso that the guardrail can properly identify the topic. -
Specify
DENYin thetypefield. -
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the
exampleslist.
-
-
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the
contentPolicyConfigobject. Each GuardrailContentFilterConfig object in thefiltersConfiglist 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
typefield. -
Specify the strength of the filter for prompts in the
inputStrengthfield and for model responses in thestrengthfield of the GuardrailContentFilterConfig.
-
-
(Optional) For security, include the ARN of a KMS key in the
kmsKeyIdfield.
- Parameters:
updateGuardrailRequest-- Returns:
- Result of the UpdateGuardrail operation returned by the service.
- See Also:
-
-
updateGuardrail
default UpdateGuardrailResponse updateGuardrail(Consumer<UpdateGuardrailRequest.Builder> updateGuardrailRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Updates a guardrail with the values you specify.
-
Specify a
nameand optionaldescription. -
Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessagingandblockedOutputsMessagingfields. -
Specify topics for the guardrail to deny in the
topicPolicyConfigobject. Each GuardrailTopicConfig object in thetopicsConfiglist pertains to one topic.-
Give a
nameanddescriptionso that the guardrail can properly identify the topic. -
Specify
DENYin thetypefield. -
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the
exampleslist.
-
-
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the
contentPolicyConfigobject. Each GuardrailContentFilterConfig object in thefiltersConfiglist 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
typefield. -
Specify the strength of the filter for prompts in the
inputStrengthfield and for model responses in thestrengthfield of the GuardrailContentFilterConfig.
-
-
(Optional) For security, include the ARN of a KMS key in the
kmsKeyIdfield.
This is a convenience which creates an instance of the
UpdateGuardrailRequest.Builderavoiding the need to create one manually viaUpdateGuardrailRequest.builder()- Parameters:
updateGuardrailRequest- AConsumerthat will call methods onUpdateGuardrailRequest.Builderto create a request.- Returns:
- Result of the UpdateGuardrail operation returned by the service.
- See Also:
-
-
updateProvisionedModelThroughput
default UpdateProvisionedModelThroughputResponse updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
- Parameters:
updateProvisionedModelThroughputRequest-- Returns:
- Result of the UpdateProvisionedModelThroughput operation returned by the service.
- See Also:
-
updateProvisionedModelThroughput
default UpdateProvisionedModelThroughputResponse updateProvisionedModelThroughput(Consumer<UpdateProvisionedModelThroughputRequest.Builder> updateProvisionedModelThroughputRequest) throws ResourceNotFoundException, AccessDeniedException, ValidationException, InternalServerException, ThrottlingException, AwsServiceException, SdkClientException, BedrockException Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
UpdateProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaUpdateProvisionedModelThroughputRequest.builder()- Parameters:
updateProvisionedModelThroughputRequest- AConsumerthat will call methods onUpdateProvisionedModelThroughputRequest.Builderto create a request.- Returns:
- Result of the UpdateProvisionedModelThroughput operation returned by the service.
- See Also:
-
create
Create aBedrockClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aBedrockClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-