aws bedrock98 CLI commands available for Amazon Bedrock.
| Command | API Operation | Sample |
|---|---|---|
batch-delete-evaluation-jobDeletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status FAILED, COMPLETED, and STOPPED. You can request up to 25 model evaluation jobs be deleted in a single request. | BatchDeleteEvaluationJob | |
cancel-automated-reasoning-policy-build-workflowCancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents. | CancelAutomatedReasoningPolicyBuildWorkflow | |
create-automated-reasoning-policyCreates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application. To create a policy, you upload a source document | CreateAutomatedReasoningPolicy | |
create-automated-reasoning-policy-test-caseCreates a test for an Automated Reasoning policy. Tests validate that your policy works as expected by providing sample inputs and expected outcomes. Use tests to verify policy behavior before deploying to production. | CreateAutomatedReasoningPolicyTestCase | |
create-automated-reasoning-policy-versionCreates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes. | CreateAutomatedReasoningPolicyVersion | |
create-custom-modelCreates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference. To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see P | CreateCustomModel | |
create-custom-model-deploymentDeploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the modelId parameter when you submit prompts and generate responses with model inference. For more information about setting up on-demand inf | CreateCustomModelDeployment | |
create-evaluation-jobCreates an evaluation job. | CreateEvaluationJob | |
create-foundation-model-agreementRequest a model access agreement for the specified model. | CreateFoundationModelAgreement | |
create-guardrailCreates 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. Conte | CreateGuardrail | |
create-guardrail-versionCreates 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. | CreateGuardrailVersion | |
create-inference-profileCreates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple r | CreateInferenceProfile | |
create-marketplace-model-endpointCreates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker. | CreateMarketplaceModelEndpoint | |
create-model-copy-jobCopies 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. | CreateModelCopyJob | |
create-model-customization-jobCreates 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 gener | CreateModelCustomizationJob | |
create-model-import-jobCreates 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 | CreateModelImportJob | |
create-model-invocation-jobCreates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference. The response returns a jobArn that you can use to stop or get d | CreateModelInvocationJob | |
create-prompt-routerCreates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria. | CreatePromptRouter | |
create-provisioned-model-throughputCreates 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. | CreateProvisionedModelThroughput | |
delete-automated-reasoning-policyDeletes an Automated Reasoning policy or policy version. This operation is idempotent. If you delete a policy more than once, each call succeeds. Deleting a policy removes it permanently and cannot be undone. | DeleteAutomatedReasoningPolicy | |
delete-automated-reasoning-policy-build-workflowDeletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets. | DeleteAutomatedReasoningPolicyBuildWorkflow | |
delete-automated-reasoning-policy-test-caseDeletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds. | DeleteAutomatedReasoningPolicyTestCase | |
delete-custom-modelDeletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide. | DeleteCustomModel | |
delete-custom-model-deploymentDeletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests. The following actions are related to the DeleteCustomModelDeployment operation: CreateCustomModelDeployment | DeleteCustomModelDeployment | |
delete-enforced-guardrail-configurationDeletes the account-level enforced guardrail configuration. | DeleteEnforcedGuardrailConfiguration | |
delete-foundation-model-agreementDelete the model access agreement for the specified model. | DeleteFoundationModelAgreement | |
delete-guardrailDeletes a guardrail. To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier field. If you delete a guardrail, all of its versions will be deleted. To delete a version of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field and the versio | DeleteGuardrail | |
delete-imported-modelDeletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide. | DeleteImportedModel | |
delete-inference-profileDeletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide. | DeleteInferenceProfile | |
delete-marketplace-model-endpointDeletes an endpoint for a model from Amazon Bedrock Marketplace. | DeleteMarketplaceModelEndpoint | |
delete-model-invocation-logging-configurationDelete the invocation logging. | DeleteModelInvocationLoggingConfiguration | |
delete-prompt-routerDeletes a specified prompt router. This action cannot be undone. | DeletePromptRouter | |
delete-provisioned-model-throughputDeletes 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. | DeleteProvisionedModelThroughput | |
deregister-marketplace-model-endpointDeregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint. | DeregisterMarketplaceModelEndpoint | |
export-automated-reasoning-policy-versionExports the policy definition for an Automated Reasoning policy version. Returns the complete policy definition including rules, variables, and custom variable types in a structured format. | ExportAutomatedReasoningPolicyVersion | |
get-automated-reasoning-policyRetrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps. | GetAutomatedReasoningPolicy | |
get-automated-reasoning-policy-annotationsRetrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy. | GetAutomatedReasoningPolicyAnnotations | |
get-automated-reasoning-policy-build-workflowRetrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata. | GetAutomatedReasoningPolicyBuildWorkflow | |
get-automated-reasoning-policy-build-workflow-result-assetsRetrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts. | GetAutomatedReasoningPolicyBuildWorkflowResultAssets | |
get-automated-reasoning-policy-next-scenarioRetrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior. | GetAutomatedReasoningPolicyNextScenario | |
get-automated-reasoning-policy-test-caseRetrieves details about a specific Automated Reasoning policy test. | GetAutomatedReasoningPolicyTestCase | |
get-automated-reasoning-policy-test-resultRetrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status. | GetAutomatedReasoningPolicyTestResult | |
get-custom-modelGet 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. | GetCustomModel | |
get-custom-model-deploymentRetrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests. The following actions are related to the GetCustomModelDeployment operation: CreateCust | GetCustomModelDeployment | |
get-evaluation-jobGets information about an evaluation job, such as the status of the job. | GetEvaluationJob | |
get-foundation-modelGet details about a Amazon Bedrock foundation model. | GetFoundationModel | |
get-foundation-model-availabilityGet information about the Foundation model availability. | GetFoundationModelAvailability | |
get-guardrailGets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version. | GetGuardrail | |
get-imported-modelGets properties associated with a customized model you imported. | GetImportedModel | |
get-inference-profileGets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide. | GetInferenceProfile | |
get-marketplace-model-endpointRetrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace. | GetMarketplaceModelEndpoint | |
get-model-copy-jobRetrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide. | GetModelCopyJob | |
get-model-customization-jobRetrieves 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. | GetModelCustomizationJob | |
get-model-import-jobRetrieves 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. | GetModelImportJob | |
get-model-invocation-jobGets details about a batch inference job. For more information, see Monitor batch inference jobs | GetModelInvocationJob | |
get-model-invocation-logging-configurationGet the current configuration values for model invocation logging. | GetModelInvocationLoggingConfiguration | |
get-prompt-routerRetrieves details about a prompt router. | GetPromptRouter | |
get-provisioned-model-throughputReturns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. | GetProvisionedModelThroughput | |
get-use-case-for-model-accessGet usecase for model access. | GetUseCaseForModelAccess | |
list-automated-reasoning-policiesLists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies. | ListAutomatedReasoningPolicies | |
list-automated-reasoning-policy-build-workflowsLists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts. | ListAutomatedReasoningPolicyBuildWorkflows | |
list-automated-reasoning-policy-test-casesLists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully. | ListAutomatedReasoningPolicyTestCases | |
list-automated-reasoning-policy-test-resultsLists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks. | ListAutomatedReasoningPolicyTestResults | |
list-custom-model-deploymentsLists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments. We recommend using pagination to ensure that the operation returns quickly and successfully. The fo | ListCustomModelDeployments | |
list-custom-modelsReturns a list of the custom models that you have created with the CreateModelCustomizationJob operation. For more information, see Custom models in the Amazon Bedrock User Guide. | ListCustomModels | |
list-enforced-guardrails-configurationLists the account-level enforced guardrail configurations. | ListEnforcedGuardrailsConfiguration | |
list-evaluation-jobsLists all existing evaluation jobs. | ListEvaluationJobs | |
list-foundation-model-agreement-offersGet the offers associated with the specified model. | ListFoundationModelAgreementOffers | |
list-foundation-modelsLists 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. | ListFoundationModels | |
list-guardrailsLists details about all the guardrails in an account. To list the DRAFT version of all your guardrails, don't specify the guardrailIdentifier field. To list all versions of a guardrail, specify the ARN of the guardrail in the guardrailIdentifier field. You can set the maximum number of results to re | ListGuardrails | |
list-imported-modelsReturns 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. | ListImportedModels | |
list-inference-profilesReturns a list of inference profiles that you can use. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide. | ListInferenceProfiles | |
list-marketplace-model-endpointsLists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account. | ListMarketplaceModelEndpoints | |
list-model-copy-jobsReturns 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. | ListModelCopyJobs | |
list-model-customization-jobsReturns 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. | ListModelCustomizationJobs | |
list-model-import-jobsReturns 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. | ListModelImportJobs | |
list-model-invocation-jobsLists all batch inference jobs in the account. For more information, see View details about a batch inference job. | ListModelInvocationJobs | |
list-prompt-routersRetrieves a list of prompt routers. | ListPromptRouters | |
list-provisioned-model-throughputsLists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. | ListProvisionedModelThroughputs | |
list-tags-for-resourceList the tags associated with the specified resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. | ListTagsForResource | |
put-enforced-guardrail-configurationSets the account-level enforced guardrail configuration. | PutEnforcedGuardrailConfiguration | |
put-model-invocation-logging-configurationSet the configuration values for model invocation logging. | PutModelInvocationLoggingConfiguration | |
put-use-case-for-model-accessPut usecase for model access. | PutUseCaseForModelAccess | |
register-marketplace-model-endpointRegisters an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs. | RegisterMarketplaceModelEndpoint | |
start-automated-reasoning-policy-build-workflowStarts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types. | StartAutomatedReasoningPolicyBuildWorkflow | |
start-automated-reasoning-policy-test-workflowInitiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results. | StartAutomatedReasoningPolicyTestWorkflow | |
stop-evaluation-jobStops an evaluation job that is current being created or running. | StopEvaluationJob | |
stop-model-customization-jobStops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide. | StopModelCustomizationJob | |
stop-model-invocation-jobStops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job. | StopModelInvocationJob | |
tag-resourceAssociate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. | TagResource | |
untag-resourceRemove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide. | UntagResource | |
update-automated-reasoning-policyUpdates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version. | UpdateAutomatedReasoningPolicy | |
update-automated-reasoning-policy-annotationsUpdates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy. | UpdateAutomatedReasoningPolicyAnnotations | |
update-automated-reasoning-policy-test-caseUpdates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold. | UpdateAutomatedReasoningPolicyTestCase | |
update-custom-model-deploymentUpdates a custom model deployment with a new custom model. This allows you to deploy updated models without creating new deployment endpoints. | UpdateCustomModelDeployment | |
update-guardrailUpdates a guardrail with the values you specify. Specify a name and optional description. Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields. Specify topics for the guardrail to deny in the to | UpdateGuardrail | |
update-marketplace-model-endpointUpdates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace. | UpdateMarketplaceModelEndpoint | |
update-provisioned-model-throughputUpdates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. | UpdateProvisionedModelThroughput |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterBedrock