# Amazon Bedrock The following actions are supported by Amazon Bedrock: + [BatchDeleteEvaluationJob](API_BatchDeleteEvaluationJob.md) + [CancelAutomatedReasoningPolicyBuildWorkflow](API_CancelAutomatedReasoningPolicyBuildWorkflow.md) + [CreateAutomatedReasoningPolicy](API_CreateAutomatedReasoningPolicy.md) + [CreateAutomatedReasoningPolicyTestCase](API_CreateAutomatedReasoningPolicyTestCase.md) + [CreateAutomatedReasoningPolicyVersion](API_CreateAutomatedReasoningPolicyVersion.md) + [CreateCustomModel](API_CreateCustomModel.md) + [CreateCustomModelDeployment](API_CreateCustomModelDeployment.md) + [CreateEvaluationJob](API_CreateEvaluationJob.md) + [CreateFoundationModelAgreement](API_CreateFoundationModelAgreement.md) + [CreateGuardrail](API_CreateGuardrail.md) + [CreateGuardrailVersion](API_CreateGuardrailVersion.md) + [CreateInferenceProfile](API_CreateInferenceProfile.md) + [CreateMarketplaceModelEndpoint](API_CreateMarketplaceModelEndpoint.md) + [CreateModelCopyJob](API_CreateModelCopyJob.md) + [CreateModelCustomizationJob](API_CreateModelCustomizationJob.md) + [CreateModelImportJob](API_CreateModelImportJob.md) + [CreateModelInvocationJob](API_CreateModelInvocationJob.md) + [CreatePromptRouter](API_CreatePromptRouter.md) + [CreateProvisionedModelThroughput](API_CreateProvisionedModelThroughput.md) + [DeleteAutomatedReasoningPolicy](API_DeleteAutomatedReasoningPolicy.md) + [DeleteAutomatedReasoningPolicyBuildWorkflow](API_DeleteAutomatedReasoningPolicyBuildWorkflow.md) + [DeleteAutomatedReasoningPolicyTestCase](API_DeleteAutomatedReasoningPolicyTestCase.md) + [DeleteCustomModel](API_DeleteCustomModel.md) + [DeleteCustomModelDeployment](API_DeleteCustomModelDeployment.md) + [DeleteEnforcedGuardrailConfiguration](API_DeleteEnforcedGuardrailConfiguration.md) + [DeleteFoundationModelAgreement](API_DeleteFoundationModelAgreement.md) + [DeleteGuardrail](API_DeleteGuardrail.md) + [DeleteImportedModel](API_DeleteImportedModel.md) + [DeleteInferenceProfile](API_DeleteInferenceProfile.md) + [DeleteMarketplaceModelEndpoint](API_DeleteMarketplaceModelEndpoint.md) + [DeleteModelInvocationLoggingConfiguration](API_DeleteModelInvocationLoggingConfiguration.md) + [DeletePromptRouter](API_DeletePromptRouter.md) + [DeleteProvisionedModelThroughput](API_DeleteProvisionedModelThroughput.md) + [DeleteResourcePolicy](API_DeleteResourcePolicy.md) + [DeregisterMarketplaceModelEndpoint](API_DeregisterMarketplaceModelEndpoint.md) + [ExportAutomatedReasoningPolicyVersion](API_ExportAutomatedReasoningPolicyVersion.md) + [GetAutomatedReasoningPolicy](API_GetAutomatedReasoningPolicy.md) + [GetAutomatedReasoningPolicyAnnotations](API_GetAutomatedReasoningPolicyAnnotations.md) + [GetAutomatedReasoningPolicyBuildWorkflow](API_GetAutomatedReasoningPolicyBuildWorkflow.md) + [GetAutomatedReasoningPolicyBuildWorkflowResultAssets](API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets.md) + [GetAutomatedReasoningPolicyNextScenario](API_GetAutomatedReasoningPolicyNextScenario.md) + [GetAutomatedReasoningPolicyTestCase](API_GetAutomatedReasoningPolicyTestCase.md) + [GetAutomatedReasoningPolicyTestResult](API_GetAutomatedReasoningPolicyTestResult.md) + [GetCustomModel](API_GetCustomModel.md) + [GetCustomModelDeployment](API_GetCustomModelDeployment.md) + [GetEvaluationJob](API_GetEvaluationJob.md) + [GetFoundationModel](API_GetFoundationModel.md) + [GetFoundationModelAvailability](API_GetFoundationModelAvailability.md) + [GetGuardrail](API_GetGuardrail.md) + [GetImportedModel](API_GetImportedModel.md) + [GetInferenceProfile](API_GetInferenceProfile.md) + [GetMarketplaceModelEndpoint](API_GetMarketplaceModelEndpoint.md) + [GetModelCopyJob](API_GetModelCopyJob.md) + [GetModelCustomizationJob](API_GetModelCustomizationJob.md) + [GetModelImportJob](API_GetModelImportJob.md) + [GetModelInvocationJob](API_GetModelInvocationJob.md) + [GetModelInvocationLoggingConfiguration](API_GetModelInvocationLoggingConfiguration.md) + [GetPromptRouter](API_GetPromptRouter.md) + [GetProvisionedModelThroughput](API_GetProvisionedModelThroughput.md) + [GetResourcePolicy](API_GetResourcePolicy.md) + [GetUseCaseForModelAccess](API_GetUseCaseForModelAccess.md) + [ListAutomatedReasoningPolicies](API_ListAutomatedReasoningPolicies.md) + [ListAutomatedReasoningPolicyBuildWorkflows](API_ListAutomatedReasoningPolicyBuildWorkflows.md) + [ListAutomatedReasoningPolicyTestCases](API_ListAutomatedReasoningPolicyTestCases.md) + [ListAutomatedReasoningPolicyTestResults](API_ListAutomatedReasoningPolicyTestResults.md) + [ListCustomModelDeployments](API_ListCustomModelDeployments.md) + [ListCustomModels](API_ListCustomModels.md) + [ListEnforcedGuardrailsConfiguration](API_ListEnforcedGuardrailsConfiguration.md) + [ListEvaluationJobs](API_ListEvaluationJobs.md) + [ListFoundationModelAgreementOffers](API_ListFoundationModelAgreementOffers.md) + [ListFoundationModels](API_ListFoundationModels.md) + [ListGuardrails](API_ListGuardrails.md) + [ListImportedModels](API_ListImportedModels.md) + [ListInferenceProfiles](API_ListInferenceProfiles.md) + [ListMarketplaceModelEndpoints](API_ListMarketplaceModelEndpoints.md) + [ListModelCopyJobs](API_ListModelCopyJobs.md) + [ListModelCustomizationJobs](API_ListModelCustomizationJobs.md) + [ListModelImportJobs](API_ListModelImportJobs.md) + [ListModelInvocationJobs](API_ListModelInvocationJobs.md) + [ListPromptRouters](API_ListPromptRouters.md) + [ListProvisionedModelThroughputs](API_ListProvisionedModelThroughputs.md) + [ListTagsForResource](API_ListTagsForResource.md) + [PutEnforcedGuardrailConfiguration](API_PutEnforcedGuardrailConfiguration.md) + [PutModelInvocationLoggingConfiguration](API_PutModelInvocationLoggingConfiguration.md) + [PutResourcePolicy](API_PutResourcePolicy.md) + [PutUseCaseForModelAccess](API_PutUseCaseForModelAccess.md) + [RegisterMarketplaceModelEndpoint](API_RegisterMarketplaceModelEndpoint.md) + [StartAutomatedReasoningPolicyBuildWorkflow](API_StartAutomatedReasoningPolicyBuildWorkflow.md) + [StartAutomatedReasoningPolicyTestWorkflow](API_StartAutomatedReasoningPolicyTestWorkflow.md) + [StopEvaluationJob](API_StopEvaluationJob.md) + [StopModelCustomizationJob](API_StopModelCustomizationJob.md) + [StopModelInvocationJob](API_StopModelInvocationJob.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAutomatedReasoningPolicy](API_UpdateAutomatedReasoningPolicy.md) + [UpdateAutomatedReasoningPolicyAnnotations](API_UpdateAutomatedReasoningPolicyAnnotations.md) + [UpdateAutomatedReasoningPolicyTestCase](API_UpdateAutomatedReasoningPolicyTestCase.md) + [UpdateCustomModelDeployment](API_UpdateCustomModelDeployment.md) + [UpdateGuardrail](API_UpdateGuardrail.md) + [UpdateMarketplaceModelEndpoint](API_UpdateMarketplaceModelEndpoint.md) + [UpdateProvisionedModelThroughput](API_UpdateProvisionedModelThroughput.md) # BatchDeleteEvaluationJob Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status `FAILED`, `COMPLETED`, and `STOPPED`. You can request up to 25 model evaluation jobs be deleted in a single request. ## Request Syntax ``` POST /evaluation-jobs/batch-delete HTTP/1.1 Content-type: application/json { "jobIdentifiers": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [jobIdentifiers](#API_BatchDeleteEvaluationJob_RequestSyntax) ** A list of one or more evaluation job Amazon Resource Names (ARNs) you want to delete. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})` Required: Yes ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "errors": [ { "code": "string", "jobIdentifier": "string", "message": "string" } ], "evaluationJobs": [ { "jobIdentifier": "string", "jobStatus": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [errors](#API_BatchDeleteEvaluationJob_ResponseSyntax) ** A JSON object containing the HTTP status codes and the ARNs of evaluation jobs that failed to be deleted. Type: Array of [BatchDeleteEvaluationJobError](API_BatchDeleteEvaluationJobError.md) objects Array Members: Minimum number of 0 items. Maximum number of 25 items. ** [evaluationJobs](#API_BatchDeleteEvaluationJob_ResponseSyntax) ** The list of evaluation jobs for deletion. Type: Array of [BatchDeleteEvaluationJobItem](API_BatchDeleteEvaluationJobItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/BatchDeleteEvaluationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/BatchDeleteEvaluationJob) # CancelAutomatedReasoningPolicyBuildWorkflow Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents. ## Request Syntax ``` POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/cancel HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The unique identifier of the build workflow to cancel. You can get this ID from the StartAutomatedReasoningPolicyBuildWorkflow response or by listing build workflows. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to cancel. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 202 ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow) # CreateAutomatedReasoningPolicy Creates 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 that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules. ## Request Syntax ``` POST /automated-reasoning-policies HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "description": "string", "kmsKeyId": "string", "name": "string", "policyDefinition": { "rules": [ { "alternateExpression": "string", "expression": "string", "id": "string" } ], "types": [ { "description": "string", "name": "string", "values": [ { "description": "string", "value": "string" } ] } ], "variables": [ { "description": "string", "name": "string", "type": "string" } ], "version": "string" }, "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateAutomatedReasoningPolicy_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [description](#API_CreateAutomatedReasoningPolicy_RequestSyntax) ** A description of the Automated Reasoning policy. Use this to provide context about the policy's purpose and the types of validations it performs. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\s\S]+` Required: No ** [kmsKeyId](#API_CreateAutomatedReasoningPolicy_RequestSyntax) ** The identifier of the AWS KMS key to use for encrypting the automated reasoning policy and its associated artifacts. If you don't specify a AWS KMS key, Amazon Bedrock uses an AWS KMS managed key for encryption. For enhanced security and control, you can specify a customer managed AWS KMS key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` Required: No ** [name](#API_CreateAutomatedReasoningPolicy_RequestSyntax) ** A unique name for the Automated Reasoning policy. The name must be between 1 and 63 characters and can contain letters, numbers, hyphens, and underscores. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[0-9a-zA-Z-_ ]+` Required: Yes ** [policyDefinition](#API_CreateAutomatedReasoningPolicy_RequestSyntax) ** The policy definition that contains the formal logic rules, variables, and custom variable types used to validate foundation model responses in your application. Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object Required: No ** [tags](#API_CreateAutomatedReasoningPolicy_RequestSyntax) ** A list of tags to associate with the Automated Reasoning policy. Tags help you organize and manage your policies. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "definitionHash": "string", "description": "string", "name": "string", "policyArn": "string", "updatedAt": "string", "version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [createdAt](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) ** The timestamp when the policy was created. Type: Timestamp ** [definitionHash](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) ** The hash of the policy definition. This is used as a concurrency token for creating policy versions that you can use in your application. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` ** [description](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) ** The description of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\s\S]+` ** [name](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) ** The name of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[0-9a-zA-Z-_ ]+` ** [policyArn](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy that you created. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [updatedAt](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) ** The timestamp when the policy was last updated. Type: Timestamp ** [version](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) ** The version number of the newly created Automated Reasoning policy. The initial version is always DRAFT. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `([1-9][0-9]{0,11})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy) # CreateAutomatedReasoningPolicyTestCase Creates 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. ## Request Syntax ``` POST /automated-reasoning-policies/policyArn/test-cases HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "confidenceThreshold": number, "expectedAggregatedFindingsResult": "string", "guardContent": "string", "queryContent": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [policyArn](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create the test. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [confidenceThreshold](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The minimum confidence level for logic validation. Content that meets the threshold is considered a high-confidence finding that can be validated. Type: Double Valid Range: Minimum value of 0. Maximum value of 1. Required: No ** [expectedAggregatedFindingsResult](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The expected result of the Automated Reasoning check. Valid values include: , TOO\$1COMPLEX, and NO\$1TRANSLATIONS. + `VALID` - The claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false. In other words, there are no alternative answers that are true that contradict the claims. + `INVALID` - The claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exists different claims that are consistent with the premises and Automated Reasoning policy. + `SATISFIABLE` - The claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true. + `IMPOSSIBLE` - Automated Reasoning can’t make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself. + `TRANSLATION_AMBIGUOUS` - Detected an ambiguity in the translation meant it would be unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed. + `TOO_COMPLEX` - The input contains too much information for Automated Reasoning to process within its latency limits. + `NO_TRANSLATIONS` - Identifies that some or all of the input prompt wasn't translated into logic. This can happen if the input isn't relevant to the Automated Reasoning policy, or if the policy doesn't have variables to model relevant input. If Automated Reasoning can't translate anything, you get a single `NO_TRANSLATIONS` finding. You might also see a `NO_TRANSLATIONS` (along with other findings) if some part of the validation isn't translated. Type: String Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION` Required: Yes ** [guardContent](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The output content that's validated by the Automated Reasoning policy. This represents the foundation model response that will be checked for accuracy. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: Yes ** [queryContent](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The input query or prompt that generated the content. This provides context for the validation. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "policyArn": "string", "testCaseId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyArn](#API_CreateAutomatedReasoningPolicyTestCase_ResponseSyntax) ** The Amazon Resource Name (ARN) of the policy for which the test was created. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [testCaseId](#API_CreateAutomatedReasoningPolicyTestCase_ResponseSyntax) ** The unique identifier of the created test. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[0-9A-Z]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase) # CreateAutomatedReasoningPolicyVersion Creates 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. ## Request Syntax ``` POST /automated-reasoning-policies/policyArn/versions HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "lastUpdatedDefinitionHash": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [policyArn](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create a version. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [lastUpdatedDefinitionHash](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) ** The hash of the current policy definition used as a concurrency token to ensure the policy hasn't been modified since you last retrieved it. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` Required: Yes ** [tags](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) ** A list of tags to associate with the policy version. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "definitionHash": "string", "description": "string", "name": "string", "policyArn": "string", "version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [createdAt](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) ** The timestamp when the policy version was created. Type: Timestamp ** [definitionHash](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) ** The hash of the policy definition for this version. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` ** [description](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) ** The description of the policy version. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\s\S]+` ** [name](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) ** The name of the policy version. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[0-9a-zA-Z-_ ]+` ** [policyArn](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) ** The versioned Amazon Resource Name (ARN) of the policy version. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [version](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) ** The version number of the policy version. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `([1-9][0-9]{0,11})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion) # CreateCustomModel Creates a new custom model in Amazon Bedrock from an existing SageMaker AI-trained Amazon Nova model stored in an Amazon-managed Amazon S3 bucket. To track the status of the new model, you use the `GetCustomModel` API operation. The model can be in the following states: + `Creating` - Initial state during validation and registration + `Active` - Model is ready for use in inference + `Failed` - Creation process encountered an error The model appears in `ListCustomModels` with a `customizationType` of `imported`. After the model is active, you can use it for inference. For information about setting up inference for custom models, see [Set up inference for a custom model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html). For more information about importing SageMaker AI trained Amazon Nova models, including specific model requirements, see [Import a SageMaker AI-trained Amazon Nova model](https://docs.aws.amazon.com/bedrock/latest/userguide/import-with-create-custom-model.html) in the Amazon Bedrock User Guide. **Note** You use the `CreateCustomModel` API to import only SageMaker AI-trained Amazon Nova models. To import open-source models, you use the [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html). **Related APIs** + [GetCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModel.html) + [ListCustomModels](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModels.html) + [DeleteCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModel.html) ## Request Syntax ``` POST /custom-models/create-custom-model HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "modelKmsKeyArn": "string", "modelName": "string", "modelSourceConfig": { ... }, "modelTags": [ { "key": "string", "value": "string" } ], "roleArn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateCustomModel_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [modelKmsKeyArn](#API_CreateCustomModel_RequestSyntax) ** The Amazon Resource Name (ARN) of the customer managed AWS KMS key to encrypt the custom model. If you don't provide a AWS KMS key, Amazon Bedrock uses an AWS-managed AWS KMS key to encrypt the model. If you provide a customer managed AWS KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see [Encryption of imported models](https://docs.aws.amazon.com/bedrock/latest/userguide/encryption-import-model.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` Required: No ** [modelName](#API_CreateCustomModel_RequestSyntax) ** A unique name for the custom model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` Required: Yes ** [modelSourceConfig](#API_CreateCustomModel_RequestSyntax) ** The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts. SageMaker AI creates this bucket when you run your first SageMaker AI training job. Type: [ModelDataSource](API_ModelDataSource.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [modelTags](#API_CreateCustomModel_RequestSyntax) ** A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources. For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [roleArn](#API_CreateCustomModel_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the AWS KMS key (if specified). For more information, see [Setting up an IAM service role for importing models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.html) in the Amazon Bedrock User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` Required: No ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "modelArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [modelArn](#API_CreateCustomModel_ResponseSyntax) ** The Amazon Resource Name (ARN) of the new custom model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Example request This example illustrates one usage of CreateCustomModel. ``` POST /custom-models/create-custom-model HTTP/1.1 Content-type: application/json { "modelName": "my-custom-nova-model", "modelSourceConfig": { "s3Uri": "s3://amzn-s3-demo-bucket/" }, "roleArn": "arn:aws:iam::123456789012:role/BedrockCustomModelRole", "modelKmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012", "clientRequestToken": "unique-request-token-123", "modelTags": [ { "key": "Environment", "value": "Production" }, { "key": "Project", "value": "CustomNova" }, { "key": "Team", "value": "MLEngineering" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateCustomModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateCustomModel) # CreateCustomModelDeployment Deploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the `modelId` parameter when you submit prompts and generate responses with model inference. For more information about setting up on-demand inference for custom models, see [Set up inference for a custom model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html). The following actions are related to the `CreateCustomModelDeployment` operation: + [GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html) + [ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html) + [DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html) ## Request Syntax ``` POST /model-customization/custom-model-deployments HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "description": "string", "modelArn": "string", "modelDeploymentName": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateCustomModelDeployment_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [description](#API_CreateCustomModelDeployment_RequestSyntax) ** A description for the custom model deployment to help you identify its purpose. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*` Required: No ** [modelArn](#API_CreateCustomModelDeployment_RequestSyntax) ** The Amazon Resource Name (ARN) of the custom model to deploy for on-demand inference. The custom model must be in the `Active` state. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}` Required: Yes ** [modelDeploymentName](#API_CreateCustomModelDeployment_RequestSyntax) ** The name for the custom model deployment. The name must be unique within your AWS account and Region. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` Required: Yes ** [tags](#API_CreateCustomModelDeployment_RequestSyntax) ** Tags to assign to the custom model deployment. You can use tags to organize and track your AWS resources for cost allocation and management purposes. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "customModelDeploymentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [customModelDeploymentArn](#API_CreateCustomModelDeployment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the custom model deployment. Use this ARN as the `modelId` parameter when invoking the model with the `InvokeModel` or `Converse` operations. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Example request This example illustrates one usage of CreateCustomModelDeployment. ``` POST /model-customization/custom-model-deployments HTTP/1.1 Content-type: application/json { "clientRequestToken": "unique-deployment-token-456", "description": "Production deployment of my custom model for customer support chatbot", "modelArn": "arn:aws:bedrock:us-west-2:123456789012:custom-model-deployment/abc123def456", "modelDeploymentName": "customer-support-model-deployment", "tags": [ { "key": "Environment", "value": "Production" }, { "key": "Application", "value": "CustomerSupport" }, { "key": "CostCenter", "value": "Engineering" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateCustomModelDeployment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateCustomModelDeployment) # CreateEvaluationJob Creates an evaluation job. For code examples that demonstrate how to create evaluation jobs, see [Create a model evaluation job in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-jobs-management-create.html#model-evaluation-jobs-management-create-auto). ## Request Syntax ``` POST /evaluation-jobs HTTP/1.1 Content-type: application/json { "applicationType": "string", "clientRequestToken": "string", "customerEncryptionKeyId": "string", "evaluationConfig": { ... }, "inferenceConfig": { ... }, "jobDescription": "string", "jobName": "string", "jobTags": [ { "key": "string", "value": "string" } ], "outputDataConfig": { "s3Uri": "string" }, "roleArn": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [applicationType](#API_CreateEvaluationJob_RequestSyntax) ** Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation). Type: String Valid Values: `ModelEvaluation | RagEvaluation` Required: No ** [clientRequestToken](#API_CreateEvaluationJob_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [customerEncryptionKeyId](#API_CreateEvaluationJob_RequestSyntax) ** Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` Required: No ** [evaluationConfig](#API_CreateEvaluationJob_RequestSyntax) ** Contains the configuration details of either an automated or human-based evaluation job. Type: [EvaluationConfig](API_EvaluationConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [inferenceConfig](#API_CreateEvaluationJob_RequestSyntax) ** Contains the configuration details of the inference model for the evaluation job. For model evaluation jobs, automated jobs support a single model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html), and jobs that use human workers support two models or inference profiles. Type: [EvaluationInferenceConfig](API_EvaluationInferenceConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [jobDescription](#API_CreateEvaluationJob_RequestSyntax) ** A description of the evaluation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `.+` Required: No ** [jobName](#API_CreateEvaluationJob_RequestSyntax) ** A name for the evaluation job. Names must unique with your AWS account, and your account's AWS region. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9]){0,62}` Required: Yes ** [jobTags](#API_CreateEvaluationJob_RequestSyntax) ** Tags to attach to the model evaluation job. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [outputDataConfig](#API_CreateEvaluationJob_RequestSyntax) ** Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job. Type: [EvaluationOutputDataConfig](API_EvaluationOutputDataConfig.md) object Required: Yes ** [roleArn](#API_CreateEvaluationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see [Required permissions for model evaluations](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` Required: Yes ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "jobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [jobArn](#API_CreateEvaluationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the evaluation job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateEvaluationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateEvaluationJob) # CreateFoundationModelAgreement Request a model access agreement for the specified model. ## Request Syntax ``` POST /create-foundation-model-agreement HTTP/1.1 Content-type: application/json { "modelId": "string", "offerToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [modelId](#API_CreateFoundationModelAgreement_RequestSyntax) ** Model Id of the model for the access request. Type: String Length Constraints: Minimum length of 0. Maximum length of 140. Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)` Required: Yes ** [offerToken](#API_CreateFoundationModelAgreement_RequestSyntax) ** An offer token encapsulates the information for an offer. Type: String Required: Yes ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "modelId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [modelId](#API_CreateFoundationModelAgreement_ResponseSyntax) ** Model Id of the model for the access request. Type: String Length Constraints: Minimum length of 0. Maximum length of 140. Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateFoundationModelAgreement) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateFoundationModelAgreement) # CreateGuardrail Creates a guardrail to detect and filter harmful content in your generative AI application. Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content: + **Content filters** - Detect and filter harmful text or image content in input prompts or model responses. Filtering is done based on detection of certain predefined harmful content categories: Hate, Insults, Sexual, Violence, Misconduct and Prompt Attack. You also can adjust the filter strength for each of these categories. + **Denied topics** - Define a set of topics that are undesirable in the context of your application. The filter will help block them if detected in user queries or model responses. + **Word filters** - Configure filters to help block undesirable words, phrases, and profanity (exact match). Such words can include offensive terms, competitor names, etc. + **Sensitive information filters** - Configure filters to help block or mask sensitive information, such as personally identifiable information (PII), or custom regex in user inputs and model responses. Blocking or masking is done based on probabilistic detection of sensitive information in standard formats in entities such as SSN number, Date of Birth, address, etc. This also allows configuring regular expression based detection of patterns for identifiers. + **Contextual grounding check** - Help detect and filter hallucinations in model responses based on grounding in a source and relevance to the user query. For more information, see [How Amazon Bedrock Guardrails works](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-how.html). ## Request Syntax ``` POST /guardrails HTTP/1.1 Content-type: application/json { "automatedReasoningPolicyConfig": { "confidenceThreshold": number, "policies": [ "string" ] }, "blockedInputMessaging": "string", "blockedOutputsMessaging": "string", "clientRequestToken": "string", "contentPolicyConfig": { "filtersConfig": [ { "inputAction": "string", "inputEnabled": boolean, "inputModalities": [ "string" ], "inputStrength": "string", "outputAction": "string", "outputEnabled": boolean, "outputModalities": [ "string" ], "outputStrength": "string", "type": "string" } ], "tierConfig": { "tierName": "string" } }, "contextualGroundingPolicyConfig": { "filtersConfig": [ { "action": "string", "enabled": boolean, "threshold": number, "type": "string" } ] }, "crossRegionConfig": { "guardrailProfileIdentifier": "string" }, "description": "string", "kmsKeyId": "string", "name": "string", "sensitiveInformationPolicyConfig": { "piiEntitiesConfig": [ { "action": "string", "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "type": "string" } ], "regexesConfig": [ { "action": "string", "description": "string", "inputAction": "string", "inputEnabled": boolean, "name": "string", "outputAction": "string", "outputEnabled": boolean, "pattern": "string" } ] }, "tags": [ { "key": "string", "value": "string" } ], "topicPolicyConfig": { "tierConfig": { "tierName": "string" }, "topicsConfig": [ { "definition": "string", "examples": [ "string" ], "inputAction": "string", "inputEnabled": boolean, "name": "string", "outputAction": "string", "outputEnabled": boolean, "type": "string" } ] }, "wordPolicyConfig": { "managedWordListsConfig": [ { "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "type": "string" } ], "wordsConfig": [ { "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "text": "string" } ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [automatedReasoningPolicyConfig](#API_CreateGuardrail_RequestSyntax) ** Optional configuration for integrating Automated Reasoning policies with the new guardrail. Type: [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md) object Required: No ** [blockedInputMessaging](#API_CreateGuardrail_RequestSyntax) ** The message to return when the guardrail blocks a prompt. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: Yes ** [blockedOutputsMessaging](#API_CreateGuardrail_RequestSyntax) ** The message to return when the guardrail blocks a model response. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: Yes ** [clientRequestToken](#API_CreateGuardrail_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) in the *Amazon S3 User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [contentPolicyConfig](#API_CreateGuardrail_RequestSyntax) ** The content filter policies to configure for the guardrail. Type: [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md) object Required: No ** [contextualGroundingPolicyConfig](#API_CreateGuardrail_RequestSyntax) ** The contextual grounding policy configuration used to create a guardrail. Type: [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md) object Required: No ** [crossRegionConfig](#API_CreateGuardrail_RequestSyntax) ** The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html). Type: [GuardrailCrossRegionConfig](API_GuardrailCrossRegionConfig.md) object Required: No ** [description](#API_CreateGuardrail_RequestSyntax) ** A description of the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No ** [kmsKeyId](#API_CreateGuardrail_RequestSyntax) ** The ARN of the AWS KMS key that you use to encrypt the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` Required: No ** [name](#API_CreateGuardrail_RequestSyntax) ** The name to give the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[0-9a-zA-Z-_]+` Required: Yes ** [sensitiveInformationPolicyConfig](#API_CreateGuardrail_RequestSyntax) ** The sensitive information policy to configure for the guardrail. Type: [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md) object Required: No ** [tags](#API_CreateGuardrail_RequestSyntax) ** The tags that you want to attach to the guardrail. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [topicPolicyConfig](#API_CreateGuardrail_RequestSyntax) ** The topic policies to configure for the guardrail. Type: [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md) object Required: No ** [wordPolicyConfig](#API_CreateGuardrail_RequestSyntax) ** The word policy you configure for the guardrail. Type: [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md) object Required: No ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "createdAt": "string", "guardrailArn": "string", "guardrailId": "string", "version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [createdAt](#API_CreateGuardrail_ResponseSyntax) ** The time at which the guardrail was created. Type: Timestamp ** [guardrailArn](#API_CreateGuardrail_ResponseSyntax) ** The ARN of the guardrail. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+` ** [guardrailId](#API_CreateGuardrail_ResponseSyntax) ** The unique identifier of the guardrail that was created. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `[a-z0-9]+` ** [version](#API_CreateGuardrail_ResponseSyntax) ** The version of the guardrail that was created. This value will always be `DRAFT`. Type: String Length Constraints: Fixed length of 5. Pattern: `DRAFT` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateGuardrail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateGuardrail) # CreateGuardrailVersion 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. ## Request Syntax ``` POST /guardrails/guardrailIdentifier HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "description": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [guardrailIdentifier](#API_CreateGuardrailVersion_RequestSyntax) ** The unique identifier of the guardrail. This can be an ID or the ARN. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateGuardrailVersion_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) in the *Amazon S3 User Guide*. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [description](#API_CreateGuardrailVersion_RequestSyntax) ** A description of the guardrail version. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "guardrailId": "string", "version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [guardrailId](#API_CreateGuardrailVersion_ResponseSyntax) ** The unique identifier of the guardrail. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `[a-z0-9]+` ** [version](#API_CreateGuardrailVersion_ResponseSyntax) ** The number of the version of the guardrail. Type: String Pattern: `[1-9][0-9]{0,7}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateGuardrailVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateGuardrailVersion) # CreateInferenceProfile Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide. ## Request Syntax ``` POST /inference-profiles HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "description": "string", "inferenceProfileName": "string", "modelSource": { ... }, "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateInferenceProfile_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [description](#API_CreateInferenceProfile_RequestSyntax) ** A description for the inference profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `([0-9a-zA-Z:.][ _-]?)+` Required: No ** [inferenceProfileName](#API_CreateInferenceProfile_RequestSyntax) ** A name for the inference profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `([0-9a-zA-Z][ _-]?)+` Required: Yes ** [modelSource](#API_CreateInferenceProfile_RequestSyntax) ** The foundation model or system-defined inference profile that the inference profile will track metrics and costs for. Type: [InferenceProfileModelSource](API_InferenceProfileModelSource.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [tags](#API_CreateInferenceProfile_RequestSyntax) ** An array of objects, each of which contains a tag and its value. For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "inferenceProfileArn": "string", "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ** [inferenceProfileArn](#API_CreateInferenceProfile_ResponseSyntax) ** The ARN of the inference profile that you created. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+` ** [status](#API_CreateInferenceProfile_ResponseSyntax) ** The status of the inference profile. `ACTIVE` means that the inference profile is ready to be used. Type: String Valid Values: `ACTIVE` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Create an application inference profile from a foundation model Run the following example to create an application inference profile from the Anthropic Claude 3 Sonnet model in the `us-west-2` region, replacing `${AccountId}` with your AWS account ID: #### Sample Request ``` POST /inference-profiles HTTP/1.1 Content-type: application/json { "inferenceProfileName": "USClaudeSonnetApplicationIP", "modelSource": { "copyFrom": "arn:aws:bedrock:us-west-2::foundation-model/anthropic.claude-3-sonnet-20240229-v1:0" }, "tags": [ { "key": "projectId", "value": "abcdef123456" } ] } ``` ### Create an application inference profile from a cross-region (system-defined) inference profile Run the following example to create an application inference profile from the US Anthropic Claude 3 Sonnet inference profile in the `us-west-2` region, replacing `${AccountId}` with your AWS account ID: #### Sample Request ``` POST /inference-profiles HTTP/1.1 Content-type: application/json { "inferenceProfileName": "USClaudeSonnetApplicationIP", "modelSource": { "copyFrom": "arn:aws:bedrock:us-west-2:${AccountId}:inference-profile/us.anthropic.claude-3-sonnet-20240229-v1:0" }, "tags": [ { "key": "projectId", "value": "abcdef123456" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateInferenceProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateInferenceProfile) # CreateMarketplaceModelEndpoint Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker. ## Request Syntax ``` POST /marketplace-model/endpoints HTTP/1.1 Content-type: application/json { "acceptEula": boolean, "clientRequestToken": "string", "endpointConfig": { ... }, "endpointName": "string", "modelSourceIdentifier": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [acceptEula](#API_CreateMarketplaceModelEndpoint_RequestSyntax) ** Indicates whether you accept the end-user license agreement (EULA) for the model. Set to `true` to accept the EULA. Type: Boolean Required: No ** [clientRequestToken](#API_CreateMarketplaceModelEndpoint_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because AWS SDKs automatically generate it for you and set this parameter. If you're not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [endpointConfig](#API_CreateMarketplaceModelEndpoint_RequestSyntax) ** The configuration for the endpoint, including the number and type of instances to use. Type: [EndpointConfig](API_EndpointConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [endpointName](#API_CreateMarketplaceModelEndpoint_RequestSyntax) ** The name of the endpoint. This name must be unique within your AWS account and region. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Required: Yes ** [modelSourceIdentifier](#API_CreateMarketplaceModelEndpoint_RequestSyntax) ** The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*` Required: Yes ** [tags](#API_CreateMarketplaceModelEndpoint_RequestSyntax) ** An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your AWS resources. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "marketplaceModelEndpoint": { "createdAt": "string", "endpointArn": "string", "endpointConfig": { ... }, "endpointStatus": "string", "endpointStatusMessage": "string", "modelSourceIdentifier": "string", "status": "string", "statusMessage": "string", "updatedAt": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [marketplaceModelEndpoint](#API_CreateMarketplaceModelEndpoint_ResponseSyntax) ** Details about the created endpoint. Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint) # CreateModelCopyJob 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](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` POST /model-copy-jobs HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "modelKmsKeyId": "string", "sourceModelArn": "string", "targetModelName": "string", "targetModelTags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateModelCopyJob_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [modelKmsKeyId](#API_CreateModelCopyJob_RequestSyntax) ** The ARN of the AWS KMS key that you use to encrypt the model copy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` Required: No ** [sourceModelArn](#API_CreateModelCopyJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the model to be copied. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` Required: Yes ** [targetModelName](#API_CreateModelCopyJob_RequestSyntax) ** A name for the copied model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` Required: Yes ** [targetModelTags](#API_CreateModelCopyJob_RequestSyntax) ** Tags to associate with the target model. For more information, see [Tag resources](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "jobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ** [jobArn](#API_CreateModelCopyJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model copy job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ## Examples ### Create a model copy job (CLI) The following example shows how to copy a custom model from `us-west-2` into the region from which the request is made, using the AWS CLI. ``` aws bedrock create-model-copy-job --source-model-arn arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-lite-v1:0:4k/MyCustomModel --target-model-name MyCustomModelCopy ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelCopyJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelCopyJob) # CreateModelCustomizationJob 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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-prepare.html). Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the `GetModelCustomizationJob` operation to retrieve the job status. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` POST /model-customization-jobs HTTP/1.1 Content-type: application/json { "baseModelIdentifier": "string", "clientRequestToken": "string", "customizationConfig": { ... }, "customizationType": "string", "customModelKmsKeyId": "string", "customModelName": "string", "customModelTags": [ { "key": "string", "value": "string" } ], "hyperParameters": { "string" : "string" }, "jobName": "string", "jobTags": [ { "key": "string", "value": "string" } ], "outputDataConfig": { "s3Uri": "string" }, "roleArn": "string", "trainingDataConfig": { "invocationLogsConfig": { "invocationLogSource": { ... }, "requestMetadataFilters": { ... }, "usePromptResponse": boolean }, "s3Uri": "string" }, "validationDataConfig": { "validators": [ { "s3Uri": "string" } ] }, "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [baseModelIdentifier](#API_CreateModelCustomizationJob_RequestSyntax) ** Name of the base model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)` Required: Yes ** [clientRequestToken](#API_CreateModelCustomizationJob_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [customizationConfig](#API_CreateModelCustomizationJob_RequestSyntax) ** The customization configuration for the model customization job. Type: [CustomizationConfig](API_CustomizationConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ** [customizationType](#API_CreateModelCustomizationJob_RequestSyntax) ** The customization type. Type: String Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION` Required: No ** [customModelKmsKeyId](#API_CreateModelCustomizationJob_RequestSyntax) ** The custom model is encrypted at rest using this key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` Required: No ** [customModelName](#API_CreateModelCustomizationJob_RequestSyntax) ** A name for the resulting custom model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` Required: Yes ** [customModelTags](#API_CreateModelCustomizationJob_RequestSyntax) ** Tags to attach to the resulting custom model. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [hyperParameters](#API_CreateModelCustomizationJob_RequestSyntax) ** Parameters related to tuning the model. For details on the format for different models, see [Custom model hyperparameters](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html). Type: String to string map Required: No ** [jobName](#API_CreateModelCustomizationJob_RequestSyntax) ** A name for the fine-tuning job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` Required: Yes ** [jobTags](#API_CreateModelCustomizationJob_RequestSyntax) ** Tags to attach to the job. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [outputDataConfig](#API_CreateModelCustomizationJob_RequestSyntax) ** S3 location for the output data. Type: [OutputDataConfig](API_OutputDataConfig.md) object Required: Yes ** [roleArn](#API_CreateModelCustomizationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the `iam:PassRole` permission. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` Required: Yes ** [trainingDataConfig](#API_CreateModelCustomizationJob_RequestSyntax) ** Information about the training dataset. Type: [TrainingDataConfig](API_TrainingDataConfig.md) object Required: Yes ** [validationDataConfig](#API_CreateModelCustomizationJob_RequestSyntax) ** Information about the validation dataset. Type: [ValidationDataConfig](API_ValidationDataConfig.md) object Required: No ** [vpcConfig](#API_CreateModelCustomizationJob_RequestSyntax) ** The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see [Protect your model customization jobs using a VPC](https://docs.aws.amazon.com/bedrock/latest/userguide/vpc-model-customization.html). Type: [VpcConfig](API_VpcConfig.md) object Required: No ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "jobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ** [jobArn](#API_CreateModelCustomizationJob_ResponseSyntax) ** Amazon Resource Name (ARN) of the fine tuning job Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelCustomizationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelCustomizationJob) # CreateModelImportJob 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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) ## Request Syntax ``` POST /model-import-jobs HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "importedModelKmsKeyId": "string", "importedModelName": "string", "importedModelTags": [ { "key": "string", "value": "string" } ], "jobName": "string", "jobTags": [ { "key": "string", "value": "string" } ], "modelDataSource": { ... }, "roleArn": "string", "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateModelImportJob_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [importedModelKmsKeyId](#API_CreateModelImportJob_RequestSyntax) ** The imported model is encrypted at rest using this key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` Required: No ** [importedModelName](#API_CreateModelImportJob_RequestSyntax) ** The name of the imported model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` Required: Yes ** [importedModelTags](#API_CreateModelImportJob_RequestSyntax) ** Tags to attach to the imported model. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [jobName](#API_CreateModelImportJob_RequestSyntax) ** The name of the import job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` Required: Yes ** [jobTags](#API_CreateModelImportJob_RequestSyntax) ** Tags to attach to this import job. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [modelDataSource](#API_CreateModelImportJob_RequestSyntax) ** The data source for the imported model. Type: [ModelDataSource](API_ModelDataSource.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [roleArn](#API_CreateModelImportJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the service role with the proper custom model import permissions. You can use the console to automatically create a service role with the proper permissions or create a custom service role. For more information about creating a custom service role, see [Create a service role for model import](https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` Required: Yes ** [vpcConfig](#API_CreateModelImportJob_RequestSyntax) ** VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job. Type: [VpcConfig](API_VpcConfig.md) object Required: No ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "jobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ** [jobArn](#API_CreateModelImportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model import job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Create a model import job Creates a model import job. ``` POST /model-import-jobs/ HTTP/1.1 Content-type: application/json { "importedModelName": "ImportedModelName", "jobName": "MyImportedModelJobName", "modelDataSource": { "s3DataSource": { "s3Uri": "S3://amzn-s3-demo-bucket/key-name" } }, "roleArn": "arn:aws:iam::111122223333:role/Role_Name" } ``` ### Example response Response for the above request. ``` HTTP/1.1 200 Content-type: application/json { "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelImportJob) # CreateModelInvocationJob Creates a batch inference job to invoke a model on multiple prompts. Format your data according to [Format your inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data) and upload it to an Amazon S3 bucket. For more information, see [Process multiple prompts with batch inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference.html). The response returns a `jobArn` that you can use to stop or get details about the job. ## Request Syntax ``` POST /model-invocation-job HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "inputDataConfig": { ... }, "jobName": "string", "modelId": "string", "modelInvocationType": "string", "outputDataConfig": { ... }, "roleArn": "string", "tags": [ { "key": "string", "value": "string" } ], "timeoutDurationInHours": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateModelInvocationJob_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}` Required: No ** [inputDataConfig](#API_CreateModelInvocationJob_RequestSyntax) ** Details about the location of the input to the batch inference job. Type: [ModelInvocationJobInputDataConfig](API_ModelInvocationJobInputDataConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [jobName](#API_CreateModelInvocationJob_RequestSyntax) ** A name to give the batch inference job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}` Required: Yes ** [modelId](#API_CreateModelInvocationJob_RequestSyntax) ** The unique identifier of the foundation model to use for the batch inference job. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)` Required: Yes ** [modelInvocationType](#API_CreateModelInvocationJob_RequestSyntax) ** The invocation endpoint for ModelInvocationJob Type: String Valid Values: `InvokeModel | Converse` Required: No ** [outputDataConfig](#API_CreateModelInvocationJob_RequestSyntax) ** Details about the location of the output of the batch inference job. Type: [ModelInvocationJobOutputDataConfig](API_ModelInvocationJobOutputDataConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [roleArn](#API_CreateModelInvocationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at [Create a service role for batch inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` Required: Yes ** [tags](#API_CreateModelInvocationJob_RequestSyntax) ** Any tags to associate with the batch inference job. For more information, see [Tagging Amazon Bedrock resources](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html). Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [timeoutDurationInHours](#API_CreateModelInvocationJob_RequestSyntax) ** The number of hours after which to force the batch inference job to time out. Type: Integer Valid Range: Minimum value of 24. Maximum value of 168. Required: No ** [vpcConfig](#API_CreateModelInvocationJob_RequestSyntax) ** The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see [Protect batch inference jobs using a VPC](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc). Type: [VpcConfig](API_VpcConfig.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "jobArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [jobArn](#API_CreateModelInvocationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the batch inference job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Create a batch inference job This example illustrates one usage of CreateModelInvocationJob. ``` POST /model-invocation-job HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "inputDataConfig": { "s3InputDataConfig": { "s3Uri": "s3://input-bucket/abc.jsonl" } }, "jobName": "my-batch-job", "modelId": "anthropic.claude-3-haiku-20240307-v1:0", "outputDataConfig": { "s3OutputDataConfig": { "s3Uri": "s3://output-bucket/" } }, "roleArn": "arn:aws:iam::123456789012:role/MyBatchInferenceRole" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelInvocationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelInvocationJob) # CreatePromptRouter Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria. ## Request Syntax ``` POST /prompt-routers HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "description": "string", "fallbackModel": { "modelArn": "string" }, "models": [ { "modelArn": "string" } ], "promptRouterName": "string", "routingCriteria": { "responseQualityDifference": number }, "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreatePromptRouter_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the AWS SDK automatically generates one for you. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [description](#API_CreatePromptRouter_RequestSyntax) ** An optional description of the prompt router to help identify its purpose. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `([0-9a-zA-Z:.][ _-]?)+` Required: No ** [fallbackModel](#API_CreatePromptRouter_RequestSyntax) ** The default model to use when the routing criteria is not met. Type: [PromptRouterTargetModel](API_PromptRouterTargetModel.md) object Required: Yes ** [models](#API_CreatePromptRouter_RequestSyntax) ** A list of foundation models that the prompt router can route requests to. At least one model must be specified. Type: Array of [PromptRouterTargetModel](API_PromptRouterTargetModel.md) objects Required: Yes ** [promptRouterName](#API_CreatePromptRouter_RequestSyntax) ** The name of the prompt router. The name must be unique within your AWS account in the current region. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `([0-9a-zA-Z][ _-]?)+` Required: Yes ** [routingCriteria](#API_CreatePromptRouter_RequestSyntax) ** The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models. Type: [RoutingCriteria](API_RoutingCriteria.md) object Required: Yes ** [tags](#API_CreatePromptRouter_RequestSyntax) ** An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your AWS resources. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "promptRouterArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [promptRouterArn](#API_CreatePromptRouter_ResponseSyntax) ** The Amazon Resource Name (ARN) that uniquely identifies the prompt router. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreatePromptRouter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreatePromptRouter) # CreateProvisionedModelThroughput 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](http://aws.amazon.com/bedrock/pricing/). For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` POST /provisioned-model-throughput HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "commitmentDuration": "string", "modelId": "string", "modelUnits": number, "provisionedModelName": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_CreateProvisionedModelThroughput_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) in the Amazon S3 User Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [commitmentDuration](#API_CreateProvisionedModelThroughput_RequestSyntax) ** The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field. Custom models support all levels of commitment. To see which base models support no commitment, see [Supported regions and models for Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) Type: String Valid Values: `OneMonth | SixMonths` Required: No ** [modelId](#API_CreateProvisionedModelThroughput_RequestSyntax) ** The model ID (for a foundation model), name (for a custom model), or Amazon Resource Name (ARN) of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see [Amazon Bedrock model IDs for purchasing Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)` Required: Yes ** [modelUnits](#API_CreateProvisionedModelThroughput_RequestSyntax) ** Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the [AWS support center](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase) to request MUs. For model unit quotas, see [Provisioned Throughput quotas](https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). For more information about what an MU specifies, contact your AWS account manager. Type: Integer Valid Range: Minimum value of 1. Required: Yes ** [provisionedModelName](#API_CreateProvisionedModelThroughput_RequestSyntax) ** The name for this Provisioned Throughput. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` Required: Yes ** [tags](#API_CreateProvisionedModelThroughput_RequestSyntax) ** Tags to associate with this Provisioned Throughput. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "provisionedModelArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ** [provisionedModelArn](#API_CreateProvisionedModelThroughput_ResponseSyntax) ** The Amazon Resource Name (ARN) for this Provisioned Throughput. Type: String Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateProvisionedModelThroughput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateProvisionedModelThroughput) # DeleteAutomatedReasoningPolicy Deletes 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. ## Request Syntax ``` DELETE /automated-reasoning-policies/policyArn?force=force HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [force](#API_DeleteAutomatedReasoningPolicy_RequestSyntax) ** Specifies whether to force delete the automated reasoning policy even if it has active resources. When `false`, Amazon Bedrock validates if all artifacts have been deleted (e.g. policy version, test case, test result) for a policy before deletion. When `true`, Amazon Bedrock will delete the policy and all its artifacts without validation. Default is `false`. ** [policyArn](#API_DeleteAutomatedReasoningPolicy_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy to delete. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 202 ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceInUseException ** Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy) # DeleteAutomatedReasoningPolicyBuildWorkflow Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets. ## Request Syntax ``` DELETE /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId?updatedAt=lastUpdatedAt HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The unique identifier of the build workflow to delete. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [lastUpdatedAt](#API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The timestamp when the build workflow was last updated. This is used for optimistic concurrency control to prevent accidental deletion of workflows that have been modified. Required: Yes ** [policyArn](#API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to delete. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 202 ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceInUseException ** Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow) # DeleteAutomatedReasoningPolicyTestCase Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds. ## Request Syntax ``` DELETE /automated-reasoning-policies/policyArn/test-cases/testCaseId?updatedAt=lastUpdatedAt HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [lastUpdatedAt](#API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax) ** The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications. Required: Yes ** [policyArn](#API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ** [testCaseId](#API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax) ** The unique identifier of the test to delete. Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[0-9A-Z]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 202 ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceInUseException ** Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase) # DeleteCustomModel Deletes a custom model that you created earlier. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` DELETE /custom-models/modelIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [modelIdentifier](#API_DeleteCustomModel_RequestSyntax) ** Name of the model to delete. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteCustomModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteCustomModel) # DeleteCustomModelDeployment Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests. The following actions are related to the `DeleteCustomModelDeployment` operation: + [CreateCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html) + [GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html) + [ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html) ## Request Syntax ``` DELETE /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [customModelDeploymentIdentifier](#API_DeleteCustomModelDeployment_RequestSyntax) ** The Amazon Resource Name (ARN) or name of the custom model deployment to delete. Length Constraints: Minimum length of 1. Maximum length of 93. Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteCustomModelDeployment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteCustomModelDeployment) # DeleteEnforcedGuardrailConfiguration Deletes the account-level enforced guardrail configuration. ## Request Syntax ``` DELETE /enforcedGuardrailsConfiguration/configId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [configId](#API_DeleteEnforcedGuardrailConfiguration_RequestSyntax) ** Unique ID for the account enforced configuration. Pattern: `[a-z0-9]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration) # DeleteFoundationModelAgreement Delete the model access agreement for the specified model. ## Request Syntax ``` POST /delete-foundation-model-agreement HTTP/1.1 Content-type: application/json { "modelId": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [modelId](#API_DeleteFoundationModelAgreement_RequestSyntax) ** Model Id of the model access to delete. Type: String Length Constraints: Minimum length of 0. Maximum length of 140. Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)` Required: Yes ## Response Syntax ``` HTTP/1.1 202 ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteFoundationModelAgreement) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteFoundationModelAgreement) # DeleteGuardrail Deletes a guardrail. + To delete a guardrail, only specify the ARN of the guardrail in the `guardrailIdentifier` field. If you delete a guardrail, all of its versions will be deleted. + To delete a version of a guardrail, specify the ARN of the guardrail in the `guardrailIdentifier` field and the version in the `guardrailVersion` field. ## Request Syntax ``` DELETE /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [guardrailIdentifier](#API_DeleteGuardrail_RequestSyntax) ** The unique identifier of the guardrail. This can be an ID or the ARN. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))` Required: Yes ** [guardrailVersion](#API_DeleteGuardrail_RequestSyntax) ** The version of the guardrail. Pattern: `[1-9][0-9]{0,7}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 202 ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceInUseException ** Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteGuardrail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteGuardrail) # DeleteImportedModel Deletes a custom model that you imported earlier. For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` DELETE /imported-models/modelIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [modelIdentifier](#API_DeleteImportedModel_RequestSyntax) ** Name of the imported model to delete. Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12})|(([0-9a-zA-Z][_-]?)+)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Delete an imported model Deletes a model that you have previously imported. ``` DELETE /imported-models/{modelIdentifier} HTTP/1.1 Content-type: application/json ``` ### Example response Response for the above request. ``` HTTP/1.1 200 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteImportedModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteImportedModel) # DeleteInferenceProfile Deletes an application inference profile. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide. ## Request Syntax ``` DELETE /inference-profiles/inferenceProfileIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [inferenceProfileIdentifier](#API_DeleteInferenceProfile_RequestSyntax) ** The Amazon Resource Name (ARN) or ID of the application inference profile to delete. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Delete an application inference profile Assuming you've created an application inference profile called `USClaudeSonnetApplicationIP`, run the following example to delete it: #### Sample Request ``` DELETE /inference-profiles/USClaudeSonnetApplicationIP HTTP/1.1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteInferenceProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteInferenceProfile) # DeleteMarketplaceModelEndpoint Deletes an endpoint for a model from Amazon Bedrock Marketplace. ## Request Syntax ``` DELETE /marketplace-model/endpoints/endpointArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [endpointArn](#API_DeleteMarketplaceModelEndpoint_RequestSyntax) ** The Amazon Resource Name (ARN) of the endpoint you want to delete. Length Constraints: Minimum length of 0. Maximum length of 2048. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint) # DeleteModelInvocationLoggingConfiguration Delete the invocation logging. ## Request Syntax ``` DELETE /logging/modelinvocations HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration) # DeletePromptRouter Deletes a specified prompt router. This action cannot be undone. ## Request Syntax ``` DELETE /prompt-routers/promptRouterArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [promptRouterArn](#API_DeletePromptRouter_RequestSyntax) ** The Amazon Resource Name (ARN) of the prompt router to delete. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeletePromptRouter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeletePromptRouter) # DeleteProvisionedModelThroughput Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` DELETE /provisioned-model-throughput/provisionedModelId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [provisionedModelId](#API_DeleteProvisionedModelThroughput_RequestSyntax) ** The Amazon Resource Name (ARN) or ID of the Provisioned Throughput. Pattern: `((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteProvisionedModelThroughput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteProvisionedModelThroughput) # DeleteResourcePolicy Deletes a previously created Bedrock resource policy. ## Request Syntax ``` DELETE /resource-policy/resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_DeleteResourcePolicy_RequestSyntax) ** The ARN of the Bedrock resource to which this resource policy applies. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteResourcePolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteResourcePolicy) # DeregisterMarketplaceModelEndpoint Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint. ## Request Syntax ``` DELETE /marketplace-model/endpoints/endpointArn/registration HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [endpointArn](#API_DeregisterMarketplaceModelEndpoint_RequestSyntax) ** The Amazon Resource Name (ARN) of the endpoint you want to deregister. Length Constraints: Minimum length of 0. Maximum length of 2048. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceUnavailableException ** Returned if the service cannot complete the request. HTTP Status Code: 503 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint) # ExportAutomatedReasoningPolicyVersion Exports 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. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/export HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [policyArn](#API_ExportAutomatedReasoningPolicyVersion_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy to export. Can be either the unversioned ARN for the draft policy or a versioned ARN for a specific policy version. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "rules": [ { "alternateExpression": "string", "expression": "string", "id": "string" } ], "types": [ { "description": "string", "name": "string", "values": [ { "description": "string", "value": "string" } ] } ], "variables": [ { "description": "string", "name": "string", "type": "string" } ], "version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [rules](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) ** The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable. Type: Array of [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md) objects Array Members: Minimum number of 0 items. Maximum number of 1500 items. ** [types](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) ** The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types. Type: Array of [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md) objects Array Members: Minimum number of 0 items. Maximum number of 150 items. ** [variables](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) ** The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation. Type: Array of [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md) objects Array Members: Minimum number of 0 items. Maximum number of 600 items. ** [version](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) ** The version of the policy definition format. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion) # GetAutomatedReasoningPolicy Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [policyArn](#API_GetAutomatedReasoningPolicy_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy to retrieve. Can be either the unversioned ARN for the draft policy or an ARN for a specific policy version. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "definitionHash": "string", "description": "string", "kmsKeyArn": "string", "name": "string", "policyArn": "string", "policyId": "string", "updatedAt": "string", "version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [createdAt](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The timestamp when the policy was created. Type: Timestamp ** [definitionHash](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The hash of the policy definition used as a concurrency token. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` ** [description](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The description of the policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\s\S]+` ** [kmsKeyArn](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the automated reasoning policy and its associated artifacts. If a AWS KMS key is not provided during the initial CreateAutomatedReasoningPolicyRequest, the kmsKeyArn won't be included in the GetAutomatedReasoningPolicyResponse. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` ** [name](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The name of the policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[0-9a-zA-Z-_ ]+` ** [policyArn](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The Amazon Resource Name (ARN) of the policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [policyId](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The unique identifier of the policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `[a-z0-9]{12}` ** [updatedAt](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The timestamp when the policy was last updated. Type: Timestamp ** [version](#API_GetAutomatedReasoningPolicy_ResponseSyntax) ** The version of the policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `([1-9][0-9]{0,11})` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicy) # GetAutomatedReasoningPolicyAnnotations Retrieves 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. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/annotations HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyAnnotations_RequestSyntax) ** The unique identifier of the build workflow whose annotations you want to retrieve. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_GetAutomatedReasoningPolicyAnnotations_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to retrieve. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "annotations": [ { ... } ], "annotationSetHash": "string", "buildWorkflowId": "string", "name": "string", "policyArn": "string", "updatedAt": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [annotations](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The current set of annotations containing rules, variables, and types extracted from the source documents. These can be modified before finalizing the policy. Type: Array of [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. ** [annotationSetHash](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** A hash value representing the current state of the annotations. This is used for optimistic concurrency control when updating annotations. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The unique identifier of the build workflow. Type: String Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` ** [name](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The name of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[0-9a-zA-Z-_ ]+` ** [policyArn](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [updatedAt](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The timestamp when the annotations were last updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations) # GetAutomatedReasoningPolicyBuildWorkflow Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The unique identifier of the build workflow to retrieve. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to retrieve. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "buildWorkflowId": "string", "buildWorkflowType": "string", "createdAt": "string", "documentContentType": "string", "documentDescription": "string", "documentName": "string", "policyArn": "string", "status": "string", "updatedAt": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The unique identifier of the build workflow. Type: String Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` ** [buildWorkflowType](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The type of build workflow being executed (e.g., DOCUMENT\$1INGESTION, POLICY\$1REPAIR). Type: String Valid Values: `INGEST_CONTENT | REFINE_POLICY | IMPORT_POLICY | GENERATE_FIDELITY_REPORT` ** [createdAt](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The timestamp when the build workflow was created. Type: Timestamp ** [documentContentType](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The content type of the source document (e.g., text/plain, application/pdf). Type: String Valid Values: `pdf | txt` ** [documentDescription](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** A detailed description of the document's content and how it should be used in the policy generation process. Type: String Length Constraints: Minimum length of 0. Maximum length of 4000. ** [documentName](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The name of the source document used in the build workflow. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. ** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [status](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED). Type: String Valid Values: `SCHEDULED | CANCEL_REQUESTED | PREPROCESSING | BUILDING | TESTING | COMPLETED | FAILED | CANCELLED` ** [updatedAt](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The timestamp when the build workflow was last updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow) # GetAutomatedReasoningPolicyBuildWorkflowResultAssets Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/result-assets?assetId=assetId&assetType=assetType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [assetId](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) ** The unique identifier of the specific asset to retrieve when multiple assets of the same type exist. This is required when retrieving SOURCE\$1DOCUMENT assets, as multiple source documents may have been used in the workflow. The asset ID can be obtained from the asset manifest. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[0-9a-fA-F\-]+` ** [assetType](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) ** The type of asset to retrieve (e.g., BUILD\$1LOG, QUALITY\$1REPORT, POLICY\$1DEFINITION, GENERATED\$1TEST\$1CASES, POLICY\$1SCENARIOS, FIDELITY\$1REPORT, ASSET\$1MANIFEST, SOURCE\$1DOCUMENT). Valid Values: `BUILD_LOG | QUALITY_REPORT | POLICY_DEFINITION | GENERATED_TEST_CASES | POLICY_SCENARIOS | FIDELITY_REPORT | ASSET_MANIFEST | SOURCE_DOCUMENT` Required: Yes ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) ** The unique identifier of the build workflow whose result assets you want to retrieve. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow assets you want to retrieve. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "buildWorkflowAssets": { ... }, "buildWorkflowId": "string", "policyArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [buildWorkflowAssets](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseSyntax) ** The requested build workflow asset. This is a union type that returns only one of the available asset types (logs, reports, or generated artifacts) based on the specific asset type requested in the API call. Type: [AutomatedReasoningPolicyBuildResultAssets](API_AutomatedReasoningPolicyBuildResultAssets.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseSyntax) ** The unique identifier of the build workflow. Type: String Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` ** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets) # GetAutomatedReasoningPolicyNextScenario Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/scenarios HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyNextScenario_RequestSyntax) ** The unique identifier of the build workflow associated with the test scenarios. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_GetAutomatedReasoningPolicyNextScenario_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy for which you want to get the next test scenario. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "policyArn": "string", "scenario": { "alternateExpression": "string", "expectedResult": "string", "expression": "string", "ruleIds": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyArn](#API_GetAutomatedReasoningPolicyNextScenario_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [scenario](#API_GetAutomatedReasoningPolicyNextScenario_ResponseSyntax) ** The next test scenario to validate, including the test expression and expected results. Type: [AutomatedReasoningPolicyScenario](API_AutomatedReasoningPolicyScenario.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario) # GetAutomatedReasoningPolicyTestCase Retrieves details about a specific Automated Reasoning policy test. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/test-cases/testCaseId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [policyArn](#API_GetAutomatedReasoningPolicyTestCase_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ** [testCaseId](#API_GetAutomatedReasoningPolicyTestCase_RequestSyntax) ** The unique identifier of the test to retrieve. Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[0-9A-Z]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "policyArn": "string", "testCase": { "confidenceThreshold": number, "createdAt": "string", "expectedAggregatedFindingsResult": "string", "guardContent": "string", "queryContent": "string", "testCaseId": "string", "updatedAt": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyArn](#API_GetAutomatedReasoningPolicyTestCase_ResponseSyntax) ** The Amazon Resource Name (ARN) of the policy that contains the test. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [testCase](#API_GetAutomatedReasoningPolicyTestCase_ResponseSyntax) ** The test details including the content, query, expected result, and metadata. Type: [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase) # GetAutomatedReasoningPolicyTestResult Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-cases/testCaseId/test-results HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyTestResult_RequestSyntax) ** The build workflow identifier. The build workflow must display a `COMPLETED` status to get results. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_GetAutomatedReasoningPolicyTestResult_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ** [testCaseId](#API_GetAutomatedReasoningPolicyTestResult_RequestSyntax) ** The unique identifier of the test for which to retrieve results. Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[0-9A-Z]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "testResult": { "aggregatedTestFindingsResult": "string", "policyArn": "string", "testCase": { "confidenceThreshold": number, "createdAt": "string", "expectedAggregatedFindingsResult": "string", "guardContent": "string", "queryContent": "string", "testCaseId": "string", "updatedAt": "string" }, "testFindings": [ { ... } ], "testRunResult": "string", "testRunStatus": "string", "updatedAt": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [testResult](#API_GetAutomatedReasoningPolicyTestResult_ResponseSyntax) ** The test result containing validation findings, execution status, and detailed analysis. Type: [AutomatedReasoningPolicyTestResult](API_AutomatedReasoningPolicyTestResult.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult) # GetCustomModel Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /custom-models/modelIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [modelIdentifier](#API_GetCustomModel_RequestSyntax) ** Name or Amazon Resource Name (ARN) of the custom model. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "baseModelArn": "string", "creationTime": "string", "customizationConfig": { ... }, "customizationType": "string", "failureMessage": "string", "hyperParameters": { "string" : "string" }, "jobArn": "string", "jobName": "string", "modelArn": "string", "modelKmsKeyArn": "string", "modelName": "string", "modelStatus": "string", "outputDataConfig": { "s3Uri": "string" }, "trainingDataConfig": { "invocationLogsConfig": { "invocationLogSource": { ... }, "requestMetadataFilters": { ... }, "usePromptResponse": boolean }, "s3Uri": "string" }, "trainingMetrics": { "trainingLoss": number }, "validationDataConfig": { "validators": [ { "s3Uri": "string" } ] }, "validationMetrics": [ { "validationLoss": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [baseModelArn](#API_GetCustomModel_ResponseSyntax) ** Amazon Resource Name (ARN) of the base model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [creationTime](#API_GetCustomModel_ResponseSyntax) ** Creation time of the model. Type: Timestamp ** [customizationConfig](#API_GetCustomModel_ResponseSyntax) ** The customization configuration for the custom model. Type: [CustomizationConfig](API_CustomizationConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [customizationType](#API_GetCustomModel_ResponseSyntax) ** The type of model customization. Type: String Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED` ** [failureMessage](#API_GetCustomModel_ResponseSyntax) ** A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [hyperParameters](#API_GetCustomModel_ResponseSyntax) ** Hyperparameter values associated with this model. For details on the format for different models, see [Custom model hyperparameters](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html). Type: String to string map ** [jobArn](#API_GetCustomModel_ResponseSyntax) ** Job Amazon Resource Name (ARN) associated with this model. For models that you create with the [CreateCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html) API operation, this is `NULL`. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}` ** [jobName](#API_GetCustomModel_ResponseSyntax) ** Job name associated with this model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` ** [modelArn](#API_GetCustomModel_ResponseSyntax) ** Amazon Resource Name (ARN) associated with this model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [modelKmsKeyArn](#API_GetCustomModel_ResponseSyntax) ** The custom model is encrypted at rest using this key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` ** [modelName](#API_GetCustomModel_ResponseSyntax) ** Model name associated with this model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ** [modelStatus](#API_GetCustomModel_ResponseSyntax) ** The current status of the custom model. Possible values include: + `Creating` - The model is being created and validated. + `Active` - The model has been successfully created and is ready for use. + `Failed` - The model creation process failed. Check the `failureMessage` field for details. Type: String Valid Values: `Active | Creating | Failed` ** [outputDataConfig](#API_GetCustomModel_ResponseSyntax) ** Output data configuration associated with this custom model. Type: [OutputDataConfig](API_OutputDataConfig.md) object ** [trainingDataConfig](#API_GetCustomModel_ResponseSyntax) ** Contains information about the training dataset. Type: [TrainingDataConfig](API_TrainingDataConfig.md) object ** [trainingMetrics](#API_GetCustomModel_ResponseSyntax) ** Contains training metrics from the job creation. Type: [TrainingMetrics](API_TrainingMetrics.md) object ** [validationDataConfig](#API_GetCustomModel_ResponseSyntax) ** Contains information about the validation dataset. Type: [ValidationDataConfig](API_ValidationDataConfig.md) object ** [validationMetrics](#API_GetCustomModel_ResponseSyntax) ** The validation metrics from the job creation. Type: Array of [ValidatorMetric](API_ValidatorMetric.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetCustomModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetCustomModel) # GetCustomModelDeployment Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests. The following actions are related to the `GetCustomModelDeployment` operation: + [CreateCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html) + [ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html) + [DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html) ## Request Syntax ``` GET /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [customModelDeploymentIdentifier](#API_GetCustomModelDeployment_RequestSyntax) ** The Amazon Resource Name (ARN) or name of the custom model deployment to retrieve information about. Length Constraints: Minimum length of 1. Maximum length of 93. Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "customModelDeploymentArn": "string", "description": "string", "failureMessage": "string", "lastUpdatedAt": "string", "modelArn": "string", "modelDeploymentName": "string", "status": "string", "updateDetails": { "modelArn": "string", "updateStatus": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [createdAt](#API_GetCustomModelDeployment_ResponseSyntax) ** The date and time when the custom model deployment was created. Type: Timestamp ** [customModelDeploymentArn](#API_GetCustomModelDeployment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the custom model deployment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}` ** [description](#API_GetCustomModelDeployment_ResponseSyntax) ** The description of the custom model deployment. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `.*` ** [failureMessage](#API_GetCustomModelDeployment_ResponseSyntax) ** If the deployment status is `FAILED`, this field contains a message describing the failure reason. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [lastUpdatedAt](#API_GetCustomModelDeployment_ResponseSyntax) ** The date and time when the custom model deployment was last updated. Type: Timestamp ** [modelArn](#API_GetCustomModelDeployment_ResponseSyntax) ** The Amazon Resource Name (ARN) of the custom model associated with this deployment. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}` ** [modelDeploymentName](#API_GetCustomModelDeployment_ResponseSyntax) ** The name of the custom model deployment. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ** [status](#API_GetCustomModelDeployment_ResponseSyntax) ** The status of the custom model deployment. Possible values are: + `CREATING` - The deployment is being set up and prepared for inference. + `ACTIVE` - The deployment is ready and available for inference requests. + `FAILED` - The deployment failed to be created or became unavailable. Type: String Valid Values: `Creating | Active | Failed` ** [updateDetails](#API_GetCustomModelDeployment_ResponseSyntax) ** Details about any pending or completed updates to the custom model deployment, including the new model ARN and update status. Type: [CustomModelDeploymentUpdateDetails](API_CustomModelDeploymentUpdateDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetCustomModelDeployment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetCustomModelDeployment) # GetEvaluationJob Gets information about an evaluation job, such as the status of the job. ## Request Syntax ``` GET /evaluation-jobs/jobIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobIdentifier](#API_GetEvaluationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the evaluation job you want get information on. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "applicationType": "string", "creationTime": "string", "customerEncryptionKeyId": "string", "evaluationConfig": { ... }, "failureMessages": [ "string" ], "inferenceConfig": { ... }, "jobArn": "string", "jobDescription": "string", "jobName": "string", "jobType": "string", "lastModifiedTime": "string", "outputDataConfig": { "s3Uri": "string" }, "roleArn": "string", "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [applicationType](#API_GetEvaluationJob_ResponseSyntax) ** Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation). Type: String Valid Values: `ModelEvaluation | RagEvaluation` ** [creationTime](#API_GetEvaluationJob_ResponseSyntax) ** The time the evaluation job was created. Type: Timestamp ** [customerEncryptionKeyId](#API_GetEvaluationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` ** [evaluationConfig](#API_GetEvaluationJob_ResponseSyntax) ** Contains the configuration details of either an automated or human-based evaluation job. Type: [EvaluationConfig](API_EvaluationConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [failureMessages](#API_GetEvaluationJob_ResponseSyntax) ** A list of strings that specify why the evaluation job failed to create. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 20 items. Length Constraints: Minimum length of 0. Maximum length of 2048. ** [inferenceConfig](#API_GetEvaluationJob_ResponseSyntax) ** Contains the configuration details of the inference model used for the evaluation job. Type: [EvaluationInferenceConfig](API_EvaluationInferenceConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [jobArn](#API_GetEvaluationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the evaluation job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}` ** [jobDescription](#API_GetEvaluationJob_ResponseSyntax) ** The description of the evaluation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `.+` ** [jobName](#API_GetEvaluationJob_ResponseSyntax) ** The name for the evaluation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9]){0,62}` ** [jobType](#API_GetEvaluationJob_ResponseSyntax) ** Specifies whether the evaluation job is automated or human-based. Type: String Valid Values: `Human | Automated` ** [lastModifiedTime](#API_GetEvaluationJob_ResponseSyntax) ** The time the evaluation job was last modified. Type: Timestamp ** [outputDataConfig](#API_GetEvaluationJob_ResponseSyntax) ** Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job. Type: [EvaluationOutputDataConfig](API_EvaluationOutputDataConfig.md) object ** [roleArn](#API_GetEvaluationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` ** [status](#API_GetEvaluationJob_ResponseSyntax) ** The current status of the evaluation job. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetEvaluationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetEvaluationJob) # GetFoundationModel Get details about a Amazon Bedrock foundation model. ## Request Syntax ``` GET /foundation-models/modelIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [modelIdentifier](#API_GetFoundationModel_RequestSyntax) ** The model identifier. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelDetails": { "customizationsSupported": [ "string" ], "inferenceTypesSupported": [ "string" ], "inputModalities": [ "string" ], "modelArn": "string", "modelId": "string", "modelLifecycle": { "endOfLifeTime": "string", "legacyTime": "string", "publicExtendedAccessTime": "string", "startOfLifeTime": "string", "status": "string" }, "modelName": "string", "outputModalities": [ "string" ], "providerName": "string", "responseStreamingSupported": boolean } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelDetails](#API_GetFoundationModel_ResponseSyntax) ** Information about the foundation model. Type: [FoundationModelDetails](API_FoundationModelDetails.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetFoundationModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetFoundationModel) # GetFoundationModelAvailability Get information about the Foundation model availability. ## Request Syntax ``` GET /foundation-model-availability/modelId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [modelId](#API_GetFoundationModelAvailability_RequestSyntax) ** The model Id of the foundation model. Length Constraints: Minimum length of 0. Maximum length of 140. Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "agreementAvailability": { "errorMessage": "string", "status": "string" }, "authorizationStatus": "string", "entitlementAvailability": "string", "modelId": "string", "regionAvailability": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [agreementAvailability](#API_GetFoundationModelAvailability_ResponseSyntax) ** Agreement availability. Type: [AgreementAvailability](API_AgreementAvailability.md) object ** [authorizationStatus](#API_GetFoundationModelAvailability_ResponseSyntax) ** Authorization status. Type: String Valid Values: `AUTHORIZED | NOT_AUTHORIZED` ** [entitlementAvailability](#API_GetFoundationModelAvailability_ResponseSyntax) ** Entitlement availability. Type: String Valid Values: `AVAILABLE | NOT_AVAILABLE` ** [modelId](#API_GetFoundationModelAvailability_ResponseSyntax) ** The model Id of the foundation model. Type: String Length Constraints: Minimum length of 0. Maximum length of 140. Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)` ** [regionAvailability](#API_GetFoundationModelAvailability_ResponseSyntax) ** Region availability. Type: String Valid Values: `AVAILABLE | NOT_AVAILABLE` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetFoundationModelAvailability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetFoundationModelAvailability) # GetGuardrail Gets details about a guardrail. If you don't specify a version, the response returns details for the `DRAFT` version. ## Request Syntax ``` GET /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [guardrailIdentifier](#API_GetGuardrail_RequestSyntax) ** The unique identifier of the guardrail for which to get details. This can be an ID or the ARN. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))` Required: Yes ** [guardrailVersion](#API_GetGuardrail_RequestSyntax) ** The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the `DRAFT` version. Pattern: `(([1-9][0-9]{0,7})|(DRAFT))` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "automatedReasoningPolicy": { "confidenceThreshold": number, "policies": [ "string" ] }, "blockedInputMessaging": "string", "blockedOutputsMessaging": "string", "contentPolicy": { "filters": [ { "inputAction": "string", "inputEnabled": boolean, "inputModalities": [ "string" ], "inputStrength": "string", "outputAction": "string", "outputEnabled": boolean, "outputModalities": [ "string" ], "outputStrength": "string", "type": "string" } ], "tier": { "tierName": "string" } }, "contextualGroundingPolicy": { "filters": [ { "action": "string", "enabled": boolean, "threshold": number, "type": "string" } ] }, "createdAt": "string", "crossRegionDetails": { "guardrailProfileArn": "string", "guardrailProfileId": "string" }, "description": "string", "failureRecommendations": [ "string" ], "guardrailArn": "string", "guardrailId": "string", "kmsKeyArn": "string", "name": "string", "sensitiveInformationPolicy": { "piiEntities": [ { "action": "string", "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "type": "string" } ], "regexes": [ { "action": "string", "description": "string", "inputAction": "string", "inputEnabled": boolean, "name": "string", "outputAction": "string", "outputEnabled": boolean, "pattern": "string" } ] }, "status": "string", "statusReasons": [ "string" ], "topicPolicy": { "tier": { "tierName": "string" }, "topics": [ { "definition": "string", "examples": [ "string" ], "inputAction": "string", "inputEnabled": boolean, "name": "string", "outputAction": "string", "outputEnabled": boolean, "type": "string" } ] }, "updatedAt": "string", "version": "string", "wordPolicy": { "managedWordLists": [ { "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "type": "string" } ], "words": [ { "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "text": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [automatedReasoningPolicy](#API_GetGuardrail_ResponseSyntax) ** The current Automated Reasoning policy configuration for the guardrail, if any is configured. Type: [GuardrailAutomatedReasoningPolicy](API_GuardrailAutomatedReasoningPolicy.md) object ** [blockedInputMessaging](#API_GetGuardrail_ResponseSyntax) ** The message that the guardrail returns when it blocks a prompt. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. ** [blockedOutputsMessaging](#API_GetGuardrail_ResponseSyntax) ** The message that the guardrail returns when it blocks a model response. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. ** [contentPolicy](#API_GetGuardrail_ResponseSyntax) ** The content policy that was configured for the guardrail. Type: [GuardrailContentPolicy](API_GuardrailContentPolicy.md) object ** [contextualGroundingPolicy](#API_GetGuardrail_ResponseSyntax) ** The contextual grounding policy used in the guardrail. Type: [GuardrailContextualGroundingPolicy](API_GuardrailContextualGroundingPolicy.md) object ** [createdAt](#API_GetGuardrail_ResponseSyntax) ** The date and time at which the guardrail was created. Type: Timestamp ** [crossRegionDetails](#API_GetGuardrail_ResponseSyntax) ** Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN). Type: [GuardrailCrossRegionDetails](API_GuardrailCrossRegionDetails.md) object ** [description](#API_GetGuardrail_ResponseSyntax) ** The description of the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. ** [failureRecommendations](#API_GetGuardrail_ResponseSyntax) ** Appears if the `status` of the guardrail is `FAILED`. A list of recommendations to carry out before retrying the request. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 200. ** [guardrailArn](#API_GetGuardrail_ResponseSyntax) ** The ARN of the guardrail. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+` ** [guardrailId](#API_GetGuardrail_ResponseSyntax) ** The unique identifier of the guardrail. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `[a-z0-9]+` ** [kmsKeyArn](#API_GetGuardrail_ResponseSyntax) ** The ARN of the AWS KMS key that encrypts the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` ** [name](#API_GetGuardrail_ResponseSyntax) ** The name of the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[0-9a-zA-Z-_]+` ** [sensitiveInformationPolicy](#API_GetGuardrail_ResponseSyntax) ** The sensitive information policy that was configured for the guardrail. Type: [GuardrailSensitiveInformationPolicy](API_GuardrailSensitiveInformationPolicy.md) object ** [status](#API_GetGuardrail_ResponseSyntax) ** The status of the guardrail. Type: String Valid Values: `CREATING | UPDATING | VERSIONING | READY | FAILED | DELETING` ** [statusReasons](#API_GetGuardrail_ResponseSyntax) ** Appears if the `status` is `FAILED`. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 200. ** [topicPolicy](#API_GetGuardrail_ResponseSyntax) ** The topic policy that was configured for the guardrail. Type: [GuardrailTopicPolicy](API_GuardrailTopicPolicy.md) object ** [updatedAt](#API_GetGuardrail_ResponseSyntax) ** The date and time at which the guardrail was updated. Type: Timestamp ** [version](#API_GetGuardrail_ResponseSyntax) ** The version of the guardrail. Type: String Pattern: `(([1-9][0-9]{0,7})|(DRAFT))` ** [wordPolicy](#API_GetGuardrail_ResponseSyntax) ** The word policy that was configured for the guardrail. Type: [GuardrailWordPolicy](API_GuardrailWordPolicy.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetGuardrail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetGuardrail) # GetImportedModel Gets properties associated with a customized model you imported. ## Request Syntax ``` GET /imported-models/modelIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [modelIdentifier](#API_GetImportedModel_RequestSyntax) ** Name or Amazon Resource Name (ARN) of the imported model. Length Constraints: Minimum length of 1. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12})|(([0-9a-zA-Z][_-]?)+)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "creationTime": "string", "customModelUnits": { "customModelUnitsPerModelCopy": number, "customModelUnitsVersion": "string" }, "instructSupported": boolean, "jobArn": "string", "jobName": "string", "modelArchitecture": "string", "modelArn": "string", "modelDataSource": { ... }, "modelKmsKeyArn": "string", "modelName": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [creationTime](#API_GetImportedModel_ResponseSyntax) ** Creation time of the imported model. Type: Timestamp ** [customModelUnits](#API_GetImportedModel_ResponseSyntax) ** Information about the hardware utilization for a single copy of the model. Type: [CustomModelUnits](API_CustomModelUnits.md) object ** [instructSupported](#API_GetImportedModel_ResponseSyntax) ** Specifies if the imported model supports converse. Type: Boolean ** [jobArn](#API_GetImportedModel_ResponseSyntax) ** Job Amazon Resource Name (ARN) associated with the imported model. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}` ** [jobName](#API_GetImportedModel_ResponseSyntax) ** Job name associated with the imported model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` ** [modelArchitecture](#API_GetImportedModel_ResponseSyntax) ** The architecture of the imported model. Type: String ** [modelArn](#API_GetImportedModel_ResponseSyntax) ** The Amazon Resource Name (ARN) associated with this imported model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}` ** [modelDataSource](#API_GetImportedModel_ResponseSyntax) ** The data source for this imported model. Type: [ModelDataSource](API_ModelDataSource.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [modelKmsKeyArn](#API_GetImportedModel_ResponseSyntax) ** The imported model is encrypted at rest using this key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` ** [modelName](#API_GetImportedModel_ResponseSyntax) ** The name of the imported model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Get model properties Get the properties associated with a customized model that you imported. ``` GET /imported-models/{modelIdentifier} HTTP/1.1 Content-type: application/json ``` ### Example response Response for the above request. ``` HTTP/1.1 200 Content-type: application/json { "modelArn": "arn:aws:bedrock:us-east-1:111122223333:imported-model/s4dt0wly5gud", "modelName": "SomeImportedModelName", "jobName": "importJob-20240713T121942", "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/dchh9ny8e0dv", "modelDataSource": { "s3DataSource": { "s3Uri": "S3://amzn-s3-demo-bucket/key-name" } }, "creationTime": "2024-08-13T19:20:14.058Z", "modelArchitecture": "mistral", "customModelUnits": { "customModelUnitsPerModelCopy": 8, "customModelUnitsVersion": "v1.0" } } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetImportedModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetImportedModel) # GetInferenceProfile Gets information about an inference profile. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide. ## Request Syntax ``` GET /inference-profiles/inferenceProfileIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [inferenceProfileIdentifier](#API_GetInferenceProfile_RequestSyntax) ** The ID or Amazon Resource Name (ARN) of the inference profile. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "description": "string", "inferenceProfileArn": "string", "inferenceProfileId": "string", "inferenceProfileName": "string", "models": [ { "modelArn": "string" } ], "status": "string", "type": "string", "updatedAt": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [createdAt](#API_GetInferenceProfile_ResponseSyntax) ** The time at which the inference profile was created. Type: Timestamp ** [description](#API_GetInferenceProfile_ResponseSyntax) ** The description of the inference profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `([0-9a-zA-Z:.][ _-]?)+` ** [inferenceProfileArn](#API_GetInferenceProfile_ResponseSyntax) ** The Amazon Resource Name (ARN) of the inference profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+` ** [inferenceProfileId](#API_GetInferenceProfile_ResponseSyntax) ** The unique identifier of the inference profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `[a-zA-Z0-9-:.]+` ** [inferenceProfileName](#API_GetInferenceProfile_ResponseSyntax) ** The name of the inference profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `([0-9a-zA-Z][ _-]?)+` ** [models](#API_GetInferenceProfile_ResponseSyntax) ** A list of information about each model in the inference profile. Type: Array of [InferenceProfileModel](API_InferenceProfileModel.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [status](#API_GetInferenceProfile_ResponseSyntax) ** The status of the inference profile. `ACTIVE` means that the inference profile is ready to be used. Type: String Valid Values: `ACTIVE` ** [type](#API_GetInferenceProfile_ResponseSyntax) ** The type of the inference profile. The following types are possible: + `SYSTEM_DEFINED` – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles. + `APPLICATION` – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions. Type: String Valid Values: `SYSTEM_DEFINED | APPLICATION` ** [updatedAt](#API_GetInferenceProfile_ResponseSyntax) ** The time at which the inference profile was last updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Get information about an inference profile Run the following example to get information about the US Anthropic Claude 3 Sonnet inference profile: #### Sample Request ``` GET /inference-profiles/us.anthropic.claude-3-sonnet-20240229-v1:0 HTTP/1.1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetInferenceProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetInferenceProfile) # GetMarketplaceModelEndpoint Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace. ## Request Syntax ``` GET /marketplace-model/endpoints/endpointArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [endpointArn](#API_GetMarketplaceModelEndpoint_RequestSyntax) ** The Amazon Resource Name (ARN) of the endpoint you want to get information about. Length Constraints: Minimum length of 0. Maximum length of 2048. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "marketplaceModelEndpoint": { "createdAt": "string", "endpointArn": "string", "endpointConfig": { ... }, "endpointStatus": "string", "endpointStatusMessage": "string", "modelSourceIdentifier": "string", "status": "string", "statusMessage": "string", "updatedAt": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [marketplaceModelEndpoint](#API_GetMarketplaceModelEndpoint_ResponseSyntax) ** Details about the requested endpoint. Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetMarketplaceModelEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetMarketplaceModelEndpoint) # GetModelCopyJob Retrieves information about a model copy job. For more information, see [Copy models to be used in other regions](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /model-copy-jobs/jobArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobArn](#API_GetModelCopyJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the model copy job. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "creationTime": "string", "failureMessage": "string", "jobArn": "string", "sourceAccountId": "string", "sourceModelArn": "string", "sourceModelName": "string", "status": "string", "targetModelArn": "string", "targetModelKmsKeyArn": "string", "targetModelName": "string", "targetModelTags": [ { "key": "string", "value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [creationTime](#API_GetModelCopyJob_ResponseSyntax) ** The time at which the model copy job was created. Type: Timestamp ** [failureMessage](#API_GetModelCopyJob_ResponseSyntax) ** An error message for why the model copy job failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [jobArn](#API_GetModelCopyJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model copy job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}` ** [sourceAccountId](#API_GetModelCopyJob_ResponseSyntax) ** The unique identifier of the account that the model being copied originated from. Type: String Pattern: `[0-9]{12}` ** [sourceModelArn](#API_GetModelCopyJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the original model being copied. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [sourceModelName](#API_GetModelCopyJob_ResponseSyntax) ** The name of the original model being copied. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ** [status](#API_GetModelCopyJob_ResponseSyntax) ** The status of the model copy job. Type: String Valid Values: `InProgress | Completed | Failed` ** [targetModelArn](#API_GetModelCopyJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the copied model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}` ** [targetModelKmsKeyArn](#API_GetModelCopyJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the KMS key encrypting the copied model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` ** [targetModelName](#API_GetModelCopyJob_ResponseSyntax) ** The name of the copied model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ** [targetModelTags](#API_GetModelCopyJob_ResponseSyntax) ** The tags associated with the copied model. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Get a model copy job (CLI) The following example shows how to get information about a model copy job using the AWS CLI. ``` aws bedrock get-model-copy-job --job-arn arn:aws:bedrock:us-east-1:123456789012:model-copy-job/amazon.titan-text-lite-v1:0:4k/abcdef123456 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelCopyJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelCopyJob) # GetModelCustomizationJob Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /model-customization-jobs/jobIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobIdentifier](#API_GetModelCustomizationJob_RequestSyntax) ** Identifier for the customization job. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "baseModelArn": "string", "clientRequestToken": "string", "creationTime": "string", "customizationConfig": { ... }, "customizationType": "string", "endTime": "string", "failureMessage": "string", "hyperParameters": { "string" : "string" }, "jobArn": "string", "jobName": "string", "lastModifiedTime": "string", "outputDataConfig": { "s3Uri": "string" }, "outputModelArn": "string", "outputModelKmsKeyArn": "string", "outputModelName": "string", "roleArn": "string", "status": "string", "statusDetails": { "dataProcessingDetails": { "creationTime": "string", "lastModifiedTime": "string", "status": "string" }, "trainingDetails": { "creationTime": "string", "lastModifiedTime": "string", "status": "string" }, "validationDetails": { "creationTime": "string", "lastModifiedTime": "string", "status": "string" } }, "trainingDataConfig": { "invocationLogsConfig": { "invocationLogSource": { ... }, "requestMetadataFilters": { ... }, "usePromptResponse": boolean }, "s3Uri": "string" }, "trainingMetrics": { "trainingLoss": number }, "validationDataConfig": { "validators": [ { "s3Uri": "string" } ] }, "validationMetrics": [ { "validationLoss": number } ], "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [baseModelArn](#API_GetModelCustomizationJob_ResponseSyntax) ** Amazon Resource Name (ARN) of the base model. Type: String Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}` ** [clientRequestToken](#API_GetModelCustomizationJob_ResponseSyntax) ** The token that you specified in the `CreateCustomizationJob` request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` ** [creationTime](#API_GetModelCustomizationJob_ResponseSyntax) ** Time that the resource was created. Type: Timestamp ** [customizationConfig](#API_GetModelCustomizationJob_ResponseSyntax) ** The customization configuration for the model customization job. Type: [CustomizationConfig](API_CustomizationConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [customizationType](#API_GetModelCustomizationJob_ResponseSyntax) ** The type of model customization. Type: String Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED` ** [endTime](#API_GetModelCustomizationJob_ResponseSyntax) ** Time that the resource transitioned to terminal state. Type: Timestamp ** [failureMessage](#API_GetModelCustomizationJob_ResponseSyntax) ** Information about why the job failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [hyperParameters](#API_GetModelCustomizationJob_ResponseSyntax) ** The hyperparameter values for the job. For details on the format for different models, see [Custom model hyperparameters](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html). Type: String to string map ** [jobArn](#API_GetModelCustomizationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the customization job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}` ** [jobName](#API_GetModelCustomizationJob_ResponseSyntax) ** The name of the customization job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` ** [lastModifiedTime](#API_GetModelCustomizationJob_ResponseSyntax) ** Time that the resource was last modified. Type: Timestamp ** [outputDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) ** Output data configuration Type: [OutputDataConfig](API_OutputDataConfig.md) object ** [outputModelArn](#API_GetModelCustomizationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the output model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}` ** [outputModelKmsKeyArn](#API_GetModelCustomizationJob_ResponseSyntax) ** The custom model is encrypted at rest using this key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` ** [outputModelName](#API_GetModelCustomizationJob_ResponseSyntax) ** The name of the output model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ** [roleArn](#API_GetModelCustomizationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` ** [status](#API_GetModelCustomizationJob_ResponseSyntax) ** The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed. Type: String Valid Values: `InProgress | Completed | Failed | Stopping | Stopped` ** [statusDetails](#API_GetModelCustomizationJob_ResponseSyntax) ** For a Distillation job, the details about the statuses of the sub-tasks of the customization job. Type: [StatusDetails](API_StatusDetails.md) object ** [trainingDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) ** Contains information about the training dataset. Type: [TrainingDataConfig](API_TrainingDataConfig.md) object ** [trainingMetrics](#API_GetModelCustomizationJob_ResponseSyntax) ** Contains training metrics from the job creation. Type: [TrainingMetrics](API_TrainingMetrics.md) object ** [validationDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) ** Contains information about the validation dataset. Type: [ValidationDataConfig](API_ValidationDataConfig.md) object ** [validationMetrics](#API_GetModelCustomizationJob_ResponseSyntax) ** The loss metric for each validator that you provided in the createjob request. Type: Array of [ValidatorMetric](API_ValidatorMetric.md) objects ** [vpcConfig](#API_GetModelCustomizationJob_ResponseSyntax) ** VPC configuration for the custom model job. Type: [VpcConfig](API_VpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelCustomizationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelCustomizationJob) # GetModelImportJob Retrieves the properties associated with import model job, including the status of the job. For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /model-import-jobs/jobIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobIdentifier](#API_GetModelImportJob_RequestSyntax) ** The identifier of the import job. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "creationTime": "string", "endTime": "string", "failureMessage": "string", "importedModelArn": "string", "importedModelKmsKeyArn": "string", "importedModelName": "string", "jobArn": "string", "jobName": "string", "lastModifiedTime": "string", "modelDataSource": { ... }, "roleArn": "string", "status": "string", "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [creationTime](#API_GetModelImportJob_ResponseSyntax) ** The time the resource was created. Type: Timestamp ** [endTime](#API_GetModelImportJob_ResponseSyntax) ** Time that the resource transitioned to terminal state. Type: Timestamp ** [failureMessage](#API_GetModelImportJob_ResponseSyntax) ** Information about why the import job failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [importedModelArn](#API_GetModelImportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the imported model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}` ** [importedModelKmsKeyArn](#API_GetModelImportJob_ResponseSyntax) ** The imported model is encrypted at rest using this key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}` ** [importedModelName](#API_GetModelImportJob_ResponseSyntax) ** The name of the imported model. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` ** [jobArn](#API_GetModelImportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the import job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}` ** [jobName](#API_GetModelImportJob_ResponseSyntax) ** The name of the import job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` ** [lastModifiedTime](#API_GetModelImportJob_ResponseSyntax) ** Time the resource was last modified. Type: Timestamp ** [modelDataSource](#API_GetModelImportJob_ResponseSyntax) ** The data source for the imported model. Type: [ModelDataSource](API_ModelDataSource.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [roleArn](#API_GetModelImportJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the IAM role associated with this job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` ** [status](#API_GetModelImportJob_ResponseSyntax) ** The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed. Type: String Valid Values: `InProgress | Completed | Failed` ** [vpcConfig](#API_GetModelImportJob_ResponseSyntax) ** The Virtual Private Cloud (VPC) configuration of the import model job. Type: [VpcConfig](API_VpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Get model import job Gets the properties of a model import job. ``` GET /model-import-jobs/{jobIdentifier} HTTP/1.1 Content-type: application/json ``` ### Example response Response for the above request. ``` HTTP/1.1 200 Content-type: application/json { "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml", "jobName": "MyImportedModelJobName", "importedModelName": "ImportedModelName", "roleArn": "arn:aws:iam::111122223333:role/Role_Name", "modelDataSource": { "s3DataSource": { "s3Uri": "S3://amzn-s3-demo-bucket/key-name" } }, "status": "InProgress", "creationTime": "2024-08-13T23:38:42.457Z", "lastModifiedTime": "2024-08-13T23:39:25.158Z" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelImportJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelImportJob) # GetModelInvocationJob Gets details about a batch inference job. For more information, see [Monitor batch inference jobs](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-monitor) ## Request Syntax ``` GET /model-invocation-job/jobIdentifier HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobIdentifier](#API_GetModelInvocationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the batch inference job. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "clientRequestToken": "string", "endTime": "string", "errorRecordCount": number, "inputDataConfig": { ... }, "jobArn": "string", "jobExpirationTime": "string", "jobName": "string", "lastModifiedTime": "string", "message": "string", "modelId": "string", "modelInvocationType": "string", "outputDataConfig": { ... }, "processedRecordCount": number, "roleArn": "string", "status": "string", "submitTime": "string", "successRecordCount": number, "timeoutDurationInHours": number, "totalRecordCount": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [clientRequestToken](#API_GetModelInvocationJob_ResponseSyntax) ** A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}` ** [endTime](#API_GetModelInvocationJob_ResponseSyntax) ** The time at which the batch inference job ended. Type: Timestamp ** [errorRecordCount](#API_GetModelInvocationJob_ResponseSyntax) ** The number of records that failed to process in the batch inference job. Type: Long Valid Range: Minimum value of 0. ** [inputDataConfig](#API_GetModelInvocationJob_ResponseSyntax) ** Details about the location of the input to the batch inference job. Type: [ModelInvocationJobInputDataConfig](API_ModelInvocationJobInputDataConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [jobArn](#API_GetModelInvocationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the batch inference job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})` ** [jobExpirationTime](#API_GetModelInvocationJob_ResponseSyntax) ** The time at which the batch inference job times or timed out. Type: Timestamp ** [jobName](#API_GetModelInvocationJob_ResponseSyntax) ** The name of the batch inference job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}` ** [lastModifiedTime](#API_GetModelInvocationJob_ResponseSyntax) ** The time at which the batch inference job was last modified. Type: Timestamp ** [message](#API_GetModelInvocationJob_ResponseSyntax) ** If the batch inference job failed, this field contains a message describing why the job failed. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [modelId](#API_GetModelInvocationJob_ResponseSyntax) ** The unique identifier of the foundation model used for model inference. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)` ** [modelInvocationType](#API_GetModelInvocationJob_ResponseSyntax) ** The invocation endpoint for ModelInvocationJob Type: String Valid Values: `InvokeModel | Converse` ** [outputDataConfig](#API_GetModelInvocationJob_ResponseSyntax) ** Details about the location of the output of the batch inference job. Type: [ModelInvocationJobOutputDataConfig](API_ModelInvocationJobOutputDataConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [processedRecordCount](#API_GetModelInvocationJob_ResponseSyntax) ** The number of records that have been processed in the batch inference job. Type: Long Valid Range: Minimum value of 0. ** [roleArn](#API_GetModelInvocationJob_ResponseSyntax) ** The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at [Create a service role for batch inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html). Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+` ** [status](#API_GetModelInvocationJob_ResponseSyntax) ** The status of the batch inference job. The following statuses are possible: + Submitted – This job has been submitted to a queue for validation. + Validating – This job is being validated for the requirements described in [Format and upload your batch inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html). The criteria include the following: + Your IAM service role has access to the Amazon S3 buckets containing your files. + Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the `modelInput` value matches the request body for the model. + Your files fulfill the requirements for file size and number of records. For more information, see [Quotas for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html). + Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn. + Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request. + InProgress – This job has begun. You can start viewing the results in the output S3 location. + Completed – This job has successfully completed. View the output files in the output S3 location. + PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location. + Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the [Support Center](https://console.aws.amazon.com/support/home/). + Stopped – This job was stopped by a user. + Stopping – This job is being stopped by a user. Type: String Valid Values: `Submitted | InProgress | Completed | Failed | Stopping | Stopped | PartiallyCompleted | Expired | Validating | Scheduled` ** [submitTime](#API_GetModelInvocationJob_ResponseSyntax) ** The time at which the batch inference job was submitted. Type: Timestamp ** [successRecordCount](#API_GetModelInvocationJob_ResponseSyntax) ** The number of records that were successfully processed in the batch inference job. Type: Long Valid Range: Minimum value of 0. ** [timeoutDurationInHours](#API_GetModelInvocationJob_ResponseSyntax) ** The number of hours after which batch inference job was set to time out. Type: Integer Valid Range: Minimum value of 24. Maximum value of 168. ** [totalRecordCount](#API_GetModelInvocationJob_ResponseSyntax) ** The total number of records in the batch inference job. Type: Long Valid Range: Minimum value of 0. ** [vpcConfig](#API_GetModelInvocationJob_ResponseSyntax) ** The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see [Protect batch inference jobs using a VPC](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc). Type: [VpcConfig](API_VpcConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Get a batch inference job This example illustrates one usage of GetModelInvocationJob. ``` GET /model-invocation-job/BATCHJOB1234 HTTP/1.1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelInvocationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelInvocationJob) # GetModelInvocationLoggingConfiguration Get the current configuration values for model invocation logging. ## Request Syntax ``` GET /logging/modelinvocations HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "loggingConfig": { "audioDataDeliveryEnabled": boolean, "cloudWatchConfig": { "largeDataDeliveryS3Config": { "bucketName": "string", "keyPrefix": "string" }, "logGroupName": "string", "roleArn": "string" }, "embeddingDataDeliveryEnabled": boolean, "imageDataDeliveryEnabled": boolean, "s3Config": { "bucketName": "string", "keyPrefix": "string" }, "textDataDeliveryEnabled": boolean, "videoDataDeliveryEnabled": boolean } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [loggingConfig](#API_GetModelInvocationLoggingConfiguration_ResponseSyntax) ** The current configuration values. Type: [LoggingConfig](API_LoggingConfig.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration) # GetPromptRouter Retrieves details about a prompt router. ## Request Syntax ``` GET /prompt-routers/promptRouterArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [promptRouterArn](#API_GetPromptRouter_RequestSyntax) ** The prompt router's ARN Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "description": "string", "fallbackModel": { "modelArn": "string" }, "models": [ { "modelArn": "string" } ], "promptRouterArn": "string", "promptRouterName": "string", "routingCriteria": { "responseQualityDifference": number }, "status": "string", "type": "string", "updatedAt": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [createdAt](#API_GetPromptRouter_ResponseSyntax) ** When the router was created. Type: Timestamp ** [description](#API_GetPromptRouter_ResponseSyntax) ** The router's description. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: `([0-9a-zA-Z:.][ _-]?)+` ** [fallbackModel](#API_GetPromptRouter_ResponseSyntax) ** The router's fallback model. Type: [PromptRouterTargetModel](API_PromptRouterTargetModel.md) object ** [models](#API_GetPromptRouter_ResponseSyntax) ** The router's models. Type: Array of [PromptRouterTargetModel](API_PromptRouterTargetModel.md) objects ** [promptRouterArn](#API_GetPromptRouter_ResponseSyntax) ** The prompt router's ARN Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+` ** [promptRouterName](#API_GetPromptRouter_ResponseSyntax) ** The router's name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `([0-9a-zA-Z][ _-]?)+` ** [routingCriteria](#API_GetPromptRouter_ResponseSyntax) ** The router's routing criteria. Type: [RoutingCriteria](API_RoutingCriteria.md) object ** [status](#API_GetPromptRouter_ResponseSyntax) ** The router's status. Type: String Valid Values: `AVAILABLE` ** [type](#API_GetPromptRouter_ResponseSyntax) ** The router's type. Type: String Valid Values: `custom | default` ** [updatedAt](#API_GetPromptRouter_ResponseSyntax) ** When the router was updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetPromptRouter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetPromptRouter) # GetProvisionedModelThroughput Returns details for a Provisioned Throughput. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /provisioned-model-throughput/provisionedModelId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [provisionedModelId](#API_GetProvisionedModelThroughput_RequestSyntax) ** The Amazon Resource Name (ARN) or ID of the Provisioned Throughput. Pattern: `((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "commitmentDuration": "string", "commitmentExpirationTime": "string", "creationTime": "string", "desiredModelArn": "string", "desiredModelUnits": number, "failureMessage": "string", "foundationModelArn": "string", "lastModifiedTime": "string", "modelArn": "string", "modelUnits": number, "provisionedModelArn": "string", "provisionedModelName": "string", "status": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [commitmentDuration](#API_GetProvisionedModelThroughput_ResponseSyntax) ** Commitment duration of the Provisioned Throughput. Type: String Valid Values: `OneMonth | SixMonths` ** [commitmentExpirationTime](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The timestamp for when the commitment term for the Provisioned Throughput expires. Type: Timestamp ** [creationTime](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The timestamp of the creation time for this Provisioned Throughput. Type: Timestamp ** [desiredModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the `modelArn` if updating hasn't completed. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [desiredModelUnits](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The number of model units that was requested for this Provisioned Throughput. Type: Integer Valid Range: Minimum value of 1. ** [failureMessage](#API_GetProvisionedModelThroughput_ResponseSyntax) ** A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. ** [foundationModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized. Type: String Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}` ** [lastModifiedTime](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The timestamp of the last time that this Provisioned Throughput was modified. Type: Timestamp ** [modelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [modelUnits](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The number of model units allocated to this Provisioned Throughput. Type: Integer Valid Range: Minimum value of 1. ** [provisionedModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Provisioned Throughput. Type: String Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}` ** [provisionedModelName](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The name of the Provisioned Throughput. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` ** [status](#API_GetProvisionedModelThroughput_ResponseSyntax) ** The status of the Provisioned Throughput. Type: String Valid Values: `Creating | InService | Updating | Failed` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetProvisionedModelThroughput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetProvisionedModelThroughput) # GetResourcePolicy Gets the resource policy document for a Bedrock resource ## Request Syntax ``` GET /resource-policy/resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_GetResourcePolicy_RequestSyntax) ** The ARN of the Bedrock resource to which this resource policy applies. Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "resourcePolicy": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [resourcePolicy](#API_GetResourcePolicy_ResponseSyntax) ** The JSON string representing the Bedrock resource policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 20480. Pattern: `[ -ÿ]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetResourcePolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetResourcePolicy) # GetUseCaseForModelAccess Returns the use case for requesting access to Anthropic models. ## Request Syntax ``` GET /use-case-for-model-access HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "formData": blob } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [formData](#API_GetUseCaseForModelAccess_ResponseSyntax) ** Returns form data from the Anthropic first time user request. Type: Base64-encoded binary data object Length Constraints: Minimum length of 10. Maximum length of 16384. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetUseCaseForModelAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetUseCaseForModelAccess) # ListAutomatedReasoningPolicies Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies. ## Request Syntax ``` GET /automated-reasoning-policies?maxResults=maxResults&nextToken=nextToken&policyArn=policyArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAutomatedReasoningPolicies_RequestSyntax) ** The maximum number of policies to return in a single call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAutomatedReasoningPolicies_RequestSyntax) ** The pagination token from a previous request to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [policyArn](#API_ListAutomatedReasoningPolicies_RequestSyntax) ** Optional filter to list only the policy versions with the specified Amazon Resource Name (ARN). If not provided, the DRAFT versions for all policies are listed. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "automatedReasoningPolicySummaries": [ { "createdAt": "string", "description": "string", "name": "string", "policyArn": "string", "policyId": "string", "updatedAt": "string", "version": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [automatedReasoningPolicySummaries](#API_ListAutomatedReasoningPolicies_ResponseSyntax) ** A list of Automated Reasoning policy summaries. Type: Array of [AutomatedReasoningPolicySummary](API_AutomatedReasoningPolicySummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 1000 items. ** [nextToken](#API_ListAutomatedReasoningPolicies_ResponseSyntax) ** The pagination token to use in a subsequent request to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicies) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicies) # ListAutomatedReasoningPolicyBuildWorkflows Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/build-workflows?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax) ** The maximum number of build workflows to return in a single response. Valid range is 1-100. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax) ** A pagination token from a previous request to continue listing build workflows from where the previous request left off. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [policyArn](#API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflows you want to list. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "automatedReasoningPolicyBuildWorkflowSummaries": [ { "buildWorkflowId": "string", "buildWorkflowType": "string", "createdAt": "string", "policyArn": "string", "status": "string", "updatedAt": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [automatedReasoningPolicyBuildWorkflowSummaries](#API_ListAutomatedReasoningPolicyBuildWorkflows_ResponseSyntax) ** A list of build workflow summaries, each containing key information about a build workflow including its status and timestamps. Type: Array of [AutomatedReasoningPolicyBuildWorkflowSummary](API_AutomatedReasoningPolicyBuildWorkflowSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 1000 items. ** [nextToken](#API_ListAutomatedReasoningPolicyBuildWorkflows_ResponseSyntax) ** A pagination token to use in subsequent requests to retrieve additional build workflows. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows) # ListAutomatedReasoningPolicyTestCases Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/test-cases?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAutomatedReasoningPolicyTestCases_RequestSyntax) ** The maximum number of tests to return in a single call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAutomatedReasoningPolicyTestCases_RequestSyntax) ** The pagination token from a previous request to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [policyArn](#API_ListAutomatedReasoningPolicyTestCases_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to list tests. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "testCases": [ { "confidenceThreshold": number, "createdAt": "string", "expectedAggregatedFindingsResult": "string", "guardContent": "string", "queryContent": "string", "testCaseId": "string", "updatedAt": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListAutomatedReasoningPolicyTestCases_ResponseSyntax) ** The pagination token to use in a subsequent request to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [testCases](#API_ListAutomatedReasoningPolicyTestCases_ResponseSyntax) ** A list of tests for the specified policy. Type: Array of [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.md) objects Array Members: Minimum number of 0 items. Maximum number of 1000 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases) # ListAutomatedReasoningPolicyTestResults Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks. ## Request Syntax ``` GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-results?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) ** The unique identifier of the build workflow whose test results you want to list. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [maxResults](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) ** The maximum number of test results to return in a single response. Valid range is 1-100. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) ** A pagination token from a previous request to continue listing test results from where the previous request left off. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [policyArn](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose test results you want to list. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "testResults": [ { "aggregatedTestFindingsResult": "string", "policyArn": "string", "testCase": { "confidenceThreshold": number, "createdAt": "string", "expectedAggregatedFindingsResult": "string", "guardContent": "string", "queryContent": "string", "testCaseId": "string", "updatedAt": "string" }, "testFindings": [ { ... } ], "testRunResult": "string", "testRunStatus": "string", "updatedAt": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListAutomatedReasoningPolicyTestResults_ResponseSyntax) ** A pagination token to use in subsequent requests to retrieve additional test results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [testResults](#API_ListAutomatedReasoningPolicyTestResults_ResponseSyntax) ** A list of test results, each containing information about how the policy performed on specific test scenarios. Type: Array of [AutomatedReasoningPolicyTestResult](API_AutomatedReasoningPolicyTestResult.md) objects Array Members: Minimum number of 0 items. Maximum number of 5000 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults) # ListCustomModelDeployments Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments. We recommend using pagination to ensure that the operation returns quickly and successfully. The following actions are related to the `ListCustomModelDeployments` operation: + [CreateCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html) + [GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html) + [DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html) ## Request Syntax ``` GET /model-customization/custom-model-deployments?createdAfter=createdAfter&createdBefore=createdBefore&maxResults=maxResults&modelArnEquals=modelArnEquals&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [createdAfter](#API_ListCustomModelDeployments_RequestSyntax) ** Filters deployments created after the specified date and time. ** [createdBefore](#API_ListCustomModelDeployments_RequestSyntax) ** Filters deployments created before the specified date and time. ** [maxResults](#API_ListCustomModelDeployments_RequestSyntax) ** The maximum number of results to return in a single call. Valid Range: Minimum value of 1. Maximum value of 1000. ** [modelArnEquals](#API_ListCustomModelDeployments_RequestSyntax) ** Filters deployments by the Amazon Resource Name (ARN) of the associated custom model. Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}` ** [nameContains](#API_ListCustomModelDeployments_RequestSyntax) ** Filters deployments whose names contain the specified string. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ** [nextToken](#API_ListCustomModelDeployments_RequestSyntax) ** The token for the next set of results. Use this token to retrieve additional results when the response is truncated. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListCustomModelDeployments_RequestSyntax) ** The field to sort the results by. The only supported value is `CreationTime`. Valid Values: `CreationTime` ** [sortOrder](#API_ListCustomModelDeployments_RequestSyntax) ** The sort order for the results. Valid values are `Ascending` and `Descending`. Default is `Descending`. Valid Values: `Ascending | Descending` ** [statusEquals](#API_ListCustomModelDeployments_RequestSyntax) ** Filters deployments by status. Valid values are `CREATING`, `ACTIVE`, and `FAILED`. Valid Values: `Creating | Active | Failed` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelDeploymentSummaries": [ { "createdAt": "string", "customModelDeploymentArn": "string", "customModelDeploymentName": "string", "failureMessage": "string", "lastUpdatedAt": "string", "modelArn": "string", "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelDeploymentSummaries](#API_ListCustomModelDeployments_ResponseSyntax) ** A list of custom model deployment summaries. Type: Array of [CustomModelDeploymentSummary](API_CustomModelDeploymentSummary.md) objects ** [nextToken](#API_ListCustomModelDeployments_ResponseSyntax) ** The token for the next set of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListCustomModelDeployments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListCustomModelDeployments) # ListCustomModels Returns a list of the custom models that you have created with the `CreateModelCustomizationJob` operation. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /custom-models?baseModelArnEquals=baseModelArnEquals&creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&foundationModelArnEquals=foundationModelArnEquals&isOwned=isOwned&maxResults=maxResults&modelStatus=modelStatus&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [baseModelArnEquals](#API_ListCustomModels_RequestSyntax) ** Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter. Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [creationTimeAfter](#API_ListCustomModels_RequestSyntax) ** Return custom models created after the specified time. ** [creationTimeBefore](#API_ListCustomModels_RequestSyntax) ** Return custom models created before the specified time. ** [foundationModelArnEquals](#API_ListCustomModels_RequestSyntax) ** Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}` ** [isOwned](#API_ListCustomModels_RequestSyntax) ** Return custom models depending on if the current account owns them (`true`) or if they were shared with the current account (`false`). ** [maxResults](#API_ListCustomModels_RequestSyntax) ** The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the `nextToken` field when making another request to return the next batch of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [modelStatus](#API_ListCustomModels_RequestSyntax) ** The status of them model to filter results by. Possible values include: + `Creating` - Include only models that are currently being created and validated. + `Active` - Include only models that have been successfully created and are ready for use. + `Failed` - Include only models where the creation process failed. If you don't specify a status, the API returns models in all states. Valid Values: `Active | Creating | Failed` ** [nameContains](#API_ListCustomModels_RequestSyntax) ** Return custom models only if the job name contains these characters. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ** [nextToken](#API_ListCustomModels_RequestSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, enter the token returned in the `nextToken` field in the response in this field to return the next batch of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListCustomModels_RequestSyntax) ** The field to sort by in the returned list of models. Valid Values: `CreationTime` ** [sortOrder](#API_ListCustomModels_RequestSyntax) ** The sort order of the results. Valid Values: `Ascending | Descending` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelSummaries": [ { "baseModelArn": "string", "baseModelName": "string", "creationTime": "string", "customizationType": "string", "modelArn": "string", "modelName": "string", "modelStatus": "string", "ownerAccountId": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelSummaries](#API_ListCustomModels_ResponseSyntax) ** Model summaries. Type: Array of [CustomModelSummary](API_CustomModelSummary.md) objects ** [nextToken](#API_ListCustomModels_ResponseSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, use this token when making another request in the `nextToken` field to return the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListCustomModels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListCustomModels) # ListEnforcedGuardrailsConfiguration Lists the account-level enforced guardrail configurations. ## Request Syntax ``` GET /enforcedGuardrailsConfiguration?nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [nextToken](#API_ListEnforcedGuardrailsConfiguration_RequestSyntax) ** Opaque continuation token of previous paginated response. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "guardrailsConfig": [ { "configId": "string", "createdAt": "string", "createdBy": "string", "guardrailArn": "string", "guardrailId": "string", "guardrailVersion": "string", "inputTags": "string", "modelEnforcement": { "excludedModels": [ "string" ], "includedModels": [ "string" ] }, "owner": "string", "selectiveContentGuarding": { "messages": "string", "system": "string" }, "updatedAt": "string", "updatedBy": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [guardrailsConfig](#API_ListEnforcedGuardrailsConfiguration_ResponseSyntax) ** Array of AccountEnforcedGuardrailOutputConfiguration objects. Type: Array of [AccountEnforcedGuardrailOutputConfiguration](API_AccountEnforcedGuardrailOutputConfiguration.md) objects Array Members: Minimum number of 0 items. Maximum number of 1 item. ** [nextToken](#API_ListEnforcedGuardrailsConfiguration_ResponseSyntax) ** Opaque continuation token of previous paginated response. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration) # ListEvaluationJobs Lists all existing evaluation jobs. ## Request Syntax ``` GET /evaluation-jobs?applicationTypeEquals=applicationTypeEquals&creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [applicationTypeEquals](#API_ListEvaluationJobs_RequestSyntax) ** A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations. Valid Values: `ModelEvaluation | RagEvaluation` ** [creationTimeAfter](#API_ListEvaluationJobs_RequestSyntax) ** A filter to only list evaluation jobs created after a specified time. ** [creationTimeBefore](#API_ListEvaluationJobs_RequestSyntax) ** A filter to only list evaluation jobs created before a specified time. ** [maxResults](#API_ListEvaluationJobs_RequestSyntax) ** The maximum number of results to return. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nameContains](#API_ListEvaluationJobs_RequestSyntax) ** A filter to only list evaluation jobs that contain a specified string in the job name. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-z0-9](-*[a-z0-9]){0,62}` ** [nextToken](#API_ListEvaluationJobs_RequestSyntax) ** Continuation token from the previous response, for Amazon Bedrock to list the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListEvaluationJobs_RequestSyntax) ** Specifies a creation time to sort the list of evaluation jobs by when they were created. Valid Values: `CreationTime` ** [sortOrder](#API_ListEvaluationJobs_RequestSyntax) ** Specifies whether to sort the list of evaluation jobs by either ascending or descending order. Valid Values: `Ascending | Descending` ** [statusEquals](#API_ListEvaluationJobs_RequestSyntax) ** A filter to only list evaluation jobs that are of a certain status. Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "jobSummaries": [ { "applicationType": "string", "creationTime": "string", "customMetricsEvaluatorModelIdentifiers": [ "string" ], "evaluationTaskTypes": [ "string" ], "evaluatorModelIdentifiers": [ "string" ], "inferenceConfigSummary": { "modelConfigSummary": { "bedrockModelIdentifiers": [ "string" ], "precomputedInferenceSourceIdentifiers": [ "string" ] }, "ragConfigSummary": { "bedrockKnowledgeBaseIdentifiers": [ "string" ], "precomputedRagSourceIdentifiers": [ "string" ] } }, "jobArn": "string", "jobName": "string", "jobType": "string", "modelIdentifiers": [ "string" ], "ragIdentifiers": [ "string" ], "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [jobSummaries](#API_ListEvaluationJobs_ResponseSyntax) ** A list of summaries of the evaluation jobs. Type: Array of [EvaluationSummary](API_EvaluationSummary.md) objects Array Members: Minimum number of 1 item. Maximum number of 5 items. ** [nextToken](#API_ListEvaluationJobs_ResponseSyntax) ** Continuation token from the previous response, for Amazon Bedrock to list the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListEvaluationJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListEvaluationJobs) # ListFoundationModelAgreementOffers Get the offers associated with the specified model. ## Request Syntax ``` GET /list-foundation-model-agreement-offers/modelId?offerType=offerType HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [modelId](#API_ListFoundationModelAgreementOffers_RequestSyntax) ** Model Id of the foundation model. Length Constraints: Minimum length of 0. Maximum length of 140. Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)` Required: Yes ** [offerType](#API_ListFoundationModelAgreementOffers_RequestSyntax) ** Type of offer associated with the model. Valid Values: `ALL | PUBLIC` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelId": "string", "offers": [ { "offerId": "string", "offerToken": "string", "termDetails": { "legalTerm": { "url": "string" }, "supportTerm": { "refundPolicyDescription": "string" }, "usageBasedPricingTerm": { "rateCard": [ { "description": "string", "dimension": "string", "price": "string", "unit": "string" } ] }, "validityTerm": { "agreementDuration": "string" } } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelId](#API_ListFoundationModelAgreementOffers_ResponseSyntax) ** Model Id of the foundation model. Type: String Length Constraints: Minimum length of 0. Maximum length of 140. Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)` ** [offers](#API_ListFoundationModelAgreementOffers_ResponseSyntax) ** List of the offers associated with the specified model. Type: Array of [Offer](API_Offer.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListFoundationModelAgreementOffers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListFoundationModelAgreementOffers) # ListFoundationModels Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see [Foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /foundation-models?byCustomizationType=byCustomizationType&byInferenceType=byInferenceType&byOutputModality=byOutputModality&byProvider=byProvider HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [byCustomizationType](#API_ListFoundationModels_RequestSyntax) ** Return models that support the customization type that you specify. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION` ** [byInferenceType](#API_ListFoundationModels_RequestSyntax) ** Return models that support the inference type that you specify. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). Valid Values: `ON_DEMAND | PROVISIONED` ** [byOutputModality](#API_ListFoundationModels_RequestSyntax) ** Return models that support the output modality that you specify. Valid Values: `TEXT | IMAGE | EMBEDDING` ** [byProvider](#API_ListFoundationModels_RequestSyntax) ** Return models belonging to the model provider that you specify. Pattern: `[A-Za-z0-9- ]{1,63}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelSummaries": [ { "customizationsSupported": [ "string" ], "inferenceTypesSupported": [ "string" ], "inputModalities": [ "string" ], "modelArn": "string", "modelId": "string", "modelLifecycle": { "endOfLifeTime": "string", "legacyTime": "string", "publicExtendedAccessTime": "string", "startOfLifeTime": "string", "status": "string" }, "modelName": "string", "outputModalities": [ "string" ], "providerName": "string", "responseStreamingSupported": boolean } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelSummaries](#API_ListFoundationModels_ResponseSyntax) ** A list of Amazon Bedrock foundation models. Type: Array of [FoundationModelSummary](API_FoundationModelSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListFoundationModels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListFoundationModels) # ListGuardrails Lists details about all the guardrails in an account. To list the `DRAFT` version of all your guardrails, don't specify the `guardrailIdentifier` field. To list all versions of a guardrail, specify the ARN of the guardrail in the `guardrailIdentifier` field. You can set the maximum number of results to return in a response in the `maxResults` field. If there are more results than the number you set, the response returns a `nextToken` that you can send in another `ListGuardrails` request to see the next batch of results. ## Request Syntax ``` GET /guardrails?guardrailIdentifier=guardrailIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [guardrailIdentifier](#API_ListGuardrails_RequestSyntax) ** The unique identifier of the guardrail. This can be an ID or the ARN. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))` ** [maxResults](#API_ListGuardrails_RequestSyntax) ** The maximum number of results to return in the response. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListGuardrails_RequestSyntax) ** If there are more results than were returned in the response, the response returns a `nextToken` that you can send in another `ListGuardrails` request to see the next batch of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "guardrails": [ { "arn": "string", "createdAt": "string", "crossRegionDetails": { "guardrailProfileArn": "string", "guardrailProfileId": "string" }, "description": "string", "id": "string", "name": "string", "status": "string", "updatedAt": "string", "version": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [guardrails](#API_ListGuardrails_ResponseSyntax) ** A list of objects, each of which contains details about a guardrail. Type: Array of [GuardrailSummary](API_GuardrailSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 1000 items. ** [nextToken](#API_ListGuardrails_ResponseSyntax) ** If there are more results than were returned in the response, the response returns a `nextToken` that you can send in another `ListGuardrails` request to see the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListGuardrails) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListGuardrails) # ListImportedModels 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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /imported-models?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [creationTimeAfter](#API_ListImportedModels_RequestSyntax) ** Return imported models that were created after the specified time. ** [creationTimeBefore](#API_ListImportedModels_RequestSyntax) ** Return imported models that created before the specified time. ** [maxResults](#API_ListImportedModels_RequestSyntax) ** The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the `nextToken` field when making another request to return the next batch of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nameContains](#API_ListImportedModels_RequestSyntax) ** Return imported models only if the model name contains these characters. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` ** [nextToken](#API_ListImportedModels_RequestSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, enter the token returned in the `nextToken` field in the response in this field to return the next batch of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListImportedModels_RequestSyntax) ** The field to sort by in the returned list of imported models. Valid Values: `CreationTime` ** [sortOrder](#API_ListImportedModels_RequestSyntax) ** Specifies whetehr to sort the results in ascending or descending order. Valid Values: `Ascending | Descending` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelSummaries": [ { "creationTime": "string", "instructSupported": boolean, "modelArchitecture": "string", "modelArn": "string", "modelName": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelSummaries](#API_ListImportedModels_ResponseSyntax) ** Model summaries. Type: Array of [ImportedModelSummary](API_ImportedModelSummary.md) objects ** [nextToken](#API_ListImportedModels_ResponseSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, use this token when making another request in the `nextToken` field to return the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### List the imported models Lists the models that you have imported. ``` GET /imported-models/ HTTP/1.1 Content-type: application/json ``` ### Example response Response for the above request. ``` HTTP/1.1 200 Content-type: application/json { "modelSummaries": [ { "modelArn": "arn:aws:bedrock:us-east-1:111122223333:imported-model/s4dt0wly5gud", "modelName": "SomeImportedModelName", "creationTime": "2024-08-13T19:20:14.058Z" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListImportedModels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListImportedModels) # ListInferenceProfiles Returns a list of inference profiles that you can use. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide. ## Request Syntax ``` GET /inference-profiles?maxResults=maxResults&nextToken=nextToken&type=typeEquals HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListInferenceProfiles_RequestSyntax) ** The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the `nextToken` field when making another request to return the next batch of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListInferenceProfiles_RequestSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, enter the token returned in the `nextToken` field in the response in this field to return the next batch of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [typeEquals](#API_ListInferenceProfiles_RequestSyntax) ** Filters for inference profiles that match the type you specify. + `SYSTEM_DEFINED` – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles. + `APPLICATION` – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions. Valid Values: `SYSTEM_DEFINED | APPLICATION` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "inferenceProfileSummaries": [ { "createdAt": "string", "description": "string", "inferenceProfileArn": "string", "inferenceProfileId": "string", "inferenceProfileName": "string", "models": [ { "modelArn": "string" } ], "status": "string", "type": "string", "updatedAt": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [inferenceProfileSummaries](#API_ListInferenceProfiles_ResponseSyntax) ** A list of information about each inference profile that you can use. Type: Array of [InferenceProfileSummary](API_InferenceProfileSummary.md) objects ** [nextToken](#API_ListInferenceProfiles_ResponseSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, use this token when making another request in the `nextToken` field to return the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### List information about inference profiles in your Region Run the following example to list information for up to 5 inference profiles in your region: #### Sample Request ``` GET /inference-profiles?maxResults=5 HTTP/1.1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListInferenceProfiles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListInferenceProfiles) # ListMarketplaceModelEndpoints Lists the endpoints for models from Amazon Bedrock Marketplace in your AWS account. ## Request Syntax ``` GET /marketplace-model/endpoints?maxResults=maxResults&modelSourceIdentifier=modelSourceEquals&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListMarketplaceModelEndpoints_RequestSyntax) ** The maximum number of results to return in a single call. If more results are available, the operation returns a `NextToken` value. Valid Range: Minimum value of 1. Maximum value of 1000. ** [modelSourceEquals](#API_ListMarketplaceModelEndpoints_RequestSyntax) ** If specified, only endpoints for the given model source identifier are returned. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*` ** [nextToken](#API_ListMarketplaceModelEndpoints_RequestSyntax) ** The token for the next set of results. You receive this token from a previous `ListMarketplaceModelEndpoints` call. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "marketplaceModelEndpoints": [ { "createdAt": "string", "endpointArn": "string", "modelSourceIdentifier": "string", "status": "string", "statusMessage": "string", "updatedAt": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [marketplaceModelEndpoints](#API_ListMarketplaceModelEndpoints_ResponseSyntax) ** An array of endpoint summaries. Type: Array of [MarketplaceModelEndpointSummary](API_MarketplaceModelEndpointSummary.md) objects Array Members: Minimum number of 0 items. Maximum number of 1000 items. ** [nextToken](#API_ListMarketplaceModelEndpoints_ResponseSyntax) ** The token for the next set of results. Use this token to get the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListMarketplaceModelEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListMarketplaceModelEndpoints) # ListModelCopyJobs 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](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /model-copy-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nextToken=nextToken&outputModelNameContains=targetModelNameContains&sortBy=sortBy&sortOrder=sortOrder&sourceAccountEquals=sourceAccountEquals&sourceModelArnEquals=sourceModelArnEquals&statusEquals=statusEquals HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [creationTimeAfter](#API_ListModelCopyJobs_RequestSyntax) ** Filters for model copy jobs created after the specified time. ** [creationTimeBefore](#API_ListModelCopyJobs_RequestSyntax) ** Filters for model copy jobs created before the specified time. ** [maxResults](#API_ListModelCopyJobs_RequestSyntax) ** The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the `nextToken` field when making another request to return the next batch of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListModelCopyJobs_RequestSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, enter the token returned in the `nextToken` field in the response in this field to return the next batch of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListModelCopyJobs_RequestSyntax) ** The field to sort by in the returned list of model copy jobs. Valid Values: `CreationTime` ** [sortOrder](#API_ListModelCopyJobs_RequestSyntax) ** Specifies whether to sort the results in ascending or descending order. Valid Values: `Ascending | Descending` ** [sourceAccountEquals](#API_ListModelCopyJobs_RequestSyntax) ** Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify. Pattern: `[0-9]{12}` ** [sourceModelArnEquals](#API_ListModelCopyJobs_RequestSyntax) ** Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify. Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [statusEquals](#API_ListModelCopyJobs_RequestSyntax) ** Filters for model copy jobs whose status matches the value that you specify. Valid Values: `InProgress | Completed | Failed` ** [targetModelNameContains](#API_ListModelCopyJobs_RequestSyntax) ** Filters for model copy jobs in which the name of the copied model contains the string that you specify. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?){1,63}` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelCopyJobSummaries": [ { "creationTime": "string", "failureMessage": "string", "jobArn": "string", "sourceAccountId": "string", "sourceModelArn": "string", "sourceModelName": "string", "status": "string", "targetModelArn": "string", "targetModelKmsKeyArn": "string", "targetModelName": "string", "targetModelTags": [ { "key": "string", "value": "string" } ] } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelCopyJobSummaries](#API_ListModelCopyJobs_ResponseSyntax) ** A list of information about each model copy job. Type: Array of [ModelCopyJobSummary](API_ModelCopyJobSummary.md) objects ** [nextToken](#API_ListModelCopyJobs_ResponseSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, use this token when making another request in the `nextToken` field to return the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### List model copy jobs (CLI) The following example shows how to return information about ten model copy jobs in an account, using the AWS CLI. ``` aws bedrock list-model-copy-jobs --max-results 10 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelCopyJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelCopyJobs) # ListModelCustomizationJobs 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](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /model-customization-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [creationTimeAfter](#API_ListModelCustomizationJobs_RequestSyntax) ** Return customization jobs created after the specified time. ** [creationTimeBefore](#API_ListModelCustomizationJobs_RequestSyntax) ** Return customization jobs created before the specified time. ** [maxResults](#API_ListModelCustomizationJobs_RequestSyntax) ** The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the `nextToken` field when making another request to return the next batch of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nameContains](#API_ListModelCustomizationJobs_RequestSyntax) ** Return customization jobs only if the job name contains these characters. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` ** [nextToken](#API_ListModelCustomizationJobs_RequestSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, enter the token returned in the `nextToken` field in the response in this field to return the next batch of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListModelCustomizationJobs_RequestSyntax) ** The field to sort by in the returned list of jobs. Valid Values: `CreationTime` ** [sortOrder](#API_ListModelCustomizationJobs_RequestSyntax) ** The sort order of the results. Valid Values: `Ascending | Descending` ** [statusEquals](#API_ListModelCustomizationJobs_RequestSyntax) ** Return customization jobs with the specified status. Valid Values: `InProgress | Completed | Failed | Stopping | Stopped` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelCustomizationJobSummaries": [ { "baseModelArn": "string", "creationTime": "string", "customizationType": "string", "customModelArn": "string", "customModelName": "string", "endTime": "string", "jobArn": "string", "jobName": "string", "lastModifiedTime": "string", "status": "string", "statusDetails": { "dataProcessingDetails": { "creationTime": "string", "lastModifiedTime": "string", "status": "string" }, "trainingDetails": { "creationTime": "string", "lastModifiedTime": "string", "status": "string" }, "validationDetails": { "creationTime": "string", "lastModifiedTime": "string", "status": "string" } } } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelCustomizationJobSummaries](#API_ListModelCustomizationJobs_ResponseSyntax) ** Job summaries. Type: Array of [ModelCustomizationJobSummary](API_ModelCustomizationJobSummary.md) objects ** [nextToken](#API_ListModelCustomizationJobs_ResponseSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, use this token when making another request in the `nextToken` field to return the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelCustomizationJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelCustomizationJobs) # ListModelImportJobs 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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /model-import-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [creationTimeAfter](#API_ListModelImportJobs_RequestSyntax) ** Return import jobs that were created after the specified time. ** [creationTimeBefore](#API_ListModelImportJobs_RequestSyntax) ** Return import jobs that were created before the specified time. ** [maxResults](#API_ListModelImportJobs_RequestSyntax) ** The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the `nextToken` field when making another request to return the next batch of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nameContains](#API_ListModelImportJobs_RequestSyntax) ** Return imported jobs only if the job name contains these characters. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*` ** [nextToken](#API_ListModelImportJobs_RequestSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, enter the token returned in the `nextToken` field in the response in this field to return the next batch of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListModelImportJobs_RequestSyntax) ** The field to sort by in the returned list of imported jobs. Valid Values: `CreationTime` ** [sortOrder](#API_ListModelImportJobs_RequestSyntax) ** Specifies whether to sort the results in ascending or descending order. Valid Values: `Ascending | Descending` ** [statusEquals](#API_ListModelImportJobs_RequestSyntax) ** Return imported jobs with the specified status. Valid Values: `InProgress | Completed | Failed` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "modelImportJobSummaries": [ { "creationTime": "string", "endTime": "string", "importedModelArn": "string", "importedModelName": "string", "jobArn": "string", "jobName": "string", "lastModifiedTime": "string", "status": "string" } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [modelImportJobSummaries](#API_ListModelImportJobs_ResponseSyntax) ** Import job summaries. Type: Array of [ModelImportJobSummary](API_ModelImportJobSummary.md) objects ** [nextToken](#API_ListModelImportJobs_ResponseSyntax) ** If the total number of results is greater than the `maxResults` value provided in the request, enter the token returned in the `nextToken` field in the response in this field to return the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### List model import jobs Gets a list of the import jobs that you have submitted. ``` GET /model-import-jobs/ HTTP/1.1 Content-type: application/json ``` ### Example response Response for the above request. ``` HTTP/1.1 200 Content-type: application/json { "modelImportJobSummaries": [ { "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml", "jobName": "MyImportedModelJobName", "status": "InProgress", "lastModifiedTime": "2024-08-13T23:40:47.517Z", "creationTime": "2024-08-13T23:38:42.457Z", "importedModelName": "ImportedModelName" }, { "jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/dchh9ny8e0dv", "jobName": "SomeJobName", "status": "Completed", "lastModifiedTime": "2024-08-13T19:36:33.674Z", "creationTime": "2024-08-13T19:20:14.058Z", "endTime": "2024-08-13T19:36:33.492Z", "importedModelArn": "arn:aws:bedrock:us-east-1:111122223333:imported-model/s4dt0wly5gud", "importedModelName": "SomeImportedModelName" } ] } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelImportJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelImportJobs) # ListModelInvocationJobs Lists all batch inference jobs in the account. For more information, see [View details about a batch inference job](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-view.html). ## Request Syntax ``` GET /model-invocation-jobs?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals&submitTimeAfter=submitTimeAfter&submitTimeBefore=submitTimeBefore HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListModelInvocationJobs_RequestSyntax) ** The maximum number of results to return. If there are more results than the number that you specify, a `nextToken` value is returned. Use the `nextToken` in a request to return the next batch of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nameContains](#API_ListModelInvocationJobs_RequestSyntax) ** Specify a string to filter for batch inference jobs whose names contain the string. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}` ** [nextToken](#API_ListModelInvocationJobs_RequestSyntax) ** If there were more results than the value you specified in the `maxResults` field in a previous `ListModelInvocationJobs` request, the response would have returned a `nextToken` value. To see the next batch of results, send the `nextToken` value in another request. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListModelInvocationJobs_RequestSyntax) ** An attribute by which to sort the results. Valid Values: `CreationTime` ** [sortOrder](#API_ListModelInvocationJobs_RequestSyntax) ** Specifies whether to sort the results by ascending or descending order. Valid Values: `Ascending | Descending` ** [statusEquals](#API_ListModelInvocationJobs_RequestSyntax) ** Specify a status to filter for batch inference jobs whose statuses match the string you specify. The following statuses are possible: + Submitted – This job has been submitted to a queue for validation. + Validating – This job is being validated for the requirements described in [Format and upload your batch inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html). The criteria include the following: + Your IAM service role has access to the Amazon S3 buckets containing your files. + Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the `modelInput` value matches the request body for the model. + Your files fulfill the requirements for file size and number of records. For more information, see [Quotas for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html). + Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn. + Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request. + InProgress – This job has begun. You can start viewing the results in the output S3 location. + Completed – This job has successfully completed. View the output files in the output S3 location. + PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location. + Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the [Support Center](https://console.aws.amazon.com/support/home/). + Stopped – This job was stopped by a user. + Stopping – This job is being stopped by a user. Valid Values: `Submitted | InProgress | Completed | Failed | Stopping | Stopped | PartiallyCompleted | Expired | Validating | Scheduled` ** [submitTimeAfter](#API_ListModelInvocationJobs_RequestSyntax) ** Specify a time to filter for batch inference jobs that were submitted after the time you specify. ** [submitTimeBefore](#API_ListModelInvocationJobs_RequestSyntax) ** Specify a time to filter for batch inference jobs that were submitted before the time you specify. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "invocationJobSummaries": [ { "clientRequestToken": "string", "endTime": "string", "errorRecordCount": number, "inputDataConfig": { ... }, "jobArn": "string", "jobExpirationTime": "string", "jobName": "string", "lastModifiedTime": "string", "message": "string", "modelId": "string", "modelInvocationType": "string", "outputDataConfig": { ... }, "processedRecordCount": number, "roleArn": "string", "status": "string", "submitTime": "string", "successRecordCount": number, "timeoutDurationInHours": number, "totalRecordCount": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnetIds": [ "string" ] } } ], "nextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [invocationJobSummaries](#API_ListModelInvocationJobs_ResponseSyntax) ** A list of items, each of which contains a summary about a batch inference job. Type: Array of [ModelInvocationJobSummary](API_ModelInvocationJobSummary.md) objects ** [nextToken](#API_ListModelInvocationJobs_ResponseSyntax) ** If there are more results than can fit in the response, a `nextToken` is returned. Use the `nextToken` in a request to return the next batch of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### List up to ten model invocation jobs This example illustrates one usage of ListModelInvocationJobs. ``` GET /model-invocation-jobs?maxResults=10&sortBy=CreationTime&sortOrder=Descending HTTP/1.1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelInvocationJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelInvocationJobs) # ListPromptRouters Retrieves a list of prompt routers. ## Request Syntax ``` GET /prompt-routers?maxResults=maxResults&nextToken=nextToken&type=type HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListPromptRouters_RequestSyntax) ** The maximum number of prompt routers to return in one page of results. Valid Range: Minimum value of 1. Maximum value of 1000. ** [nextToken](#API_ListPromptRouters_RequestSyntax) ** Specify the pagination token from a previous request to retrieve the next page of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [type](#API_ListPromptRouters_RequestSyntax) ** The type of the prompt routers, such as whether it's default or custom. Valid Values: `custom | default` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "promptRouterSummaries": [ { "createdAt": "string", "description": "string", "fallbackModel": { "modelArn": "string" }, "models": [ { "modelArn": "string" } ], "promptRouterArn": "string", "promptRouterName": "string", "routingCriteria": { "responseQualityDifference": number }, "status": "string", "type": "string", "updatedAt": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListPromptRouters_ResponseSyntax) ** Specify the pagination token from a previous request to retrieve the next page of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [promptRouterSummaries](#API_ListPromptRouters_ResponseSyntax) ** A list of prompt router summaries. Type: Array of [PromptRouterSummary](API_PromptRouterSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListPromptRouters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListPromptRouters) # ListProvisionedModelThroughputs Lists the Provisioned Throughputs in the account. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` GET /provisioned-model-throughputs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&modelArnEquals=modelArnEquals&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [creationTimeAfter](#API_ListProvisionedModelThroughputs_RequestSyntax) ** A filter that returns Provisioned Throughputs created after the specified time. ** [creationTimeBefore](#API_ListProvisionedModelThroughputs_RequestSyntax) ** A filter that returns Provisioned Throughputs created before the specified time. ** [maxResults](#API_ListProvisionedModelThroughputs_RequestSyntax) ** THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a `nextToken` value. To see the next batch of results, send the `nextToken` value in another list request. Valid Range: Minimum value of 1. Maximum value of 1000. ** [modelArnEquals](#API_ListProvisionedModelThroughputs_RequestSyntax) ** A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify. Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))` ** [nameContains](#API_ListProvisionedModelThroughputs_RequestSyntax) ** A filter that returns Provisioned Throughputs if their name contains the expression that you specify. Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` ** [nextToken](#API_ListProvisionedModelThroughputs_RequestSyntax) ** If there are more results than the number you specified in the `maxResults` field, the response returns a `nextToken` value. To see the next batch of results, specify the `nextToken` value in this field. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [sortBy](#API_ListProvisionedModelThroughputs_RequestSyntax) ** The field by which to sort the returned list of Provisioned Throughputs. Valid Values: `CreationTime` ** [sortOrder](#API_ListProvisionedModelThroughputs_RequestSyntax) ** The sort order of the results. Valid Values: `Ascending | Descending` ** [statusEquals](#API_ListProvisionedModelThroughputs_RequestSyntax) ** A filter that returns Provisioned Throughputs if their statuses matches the value that you specify. Valid Values: `Creating | InService | Updating | Failed` ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "provisionedModelSummaries": [ { "commitmentDuration": "string", "commitmentExpirationTime": "string", "creationTime": "string", "desiredModelArn": "string", "desiredModelUnits": number, "foundationModelArn": "string", "lastModifiedTime": "string", "modelArn": "string", "modelUnits": number, "provisionedModelArn": "string", "provisionedModelName": "string", "status": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [nextToken](#API_ListProvisionedModelThroughputs_ResponseSyntax) ** If there are more results than the number you specified in the `maxResults` field, this value is returned. To see the next batch of results, include this value in the `nextToken` field in another list request. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [provisionedModelSummaries](#API_ListProvisionedModelThroughputs_ResponseSyntax) ** A list of summaries, one for each Provisioned Throughput in the response. Type: Array of [ProvisionedModelSummary](API_ProvisionedModelSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListProvisionedModelThroughputs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListProvisionedModelThroughputs) # ListTagsForResource List the tags associated with the specified resource. For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` POST /listTagsForResource HTTP/1.1 Content-type: application/json { "resourceARN": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [resourceARN](#API_ListTagsForResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `.*(^[a-zA-Z0-9][a-zA-Z0-9\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$))).*` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": [ { "key": "string", "value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** An array of the tags associated with this resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListTagsForResource) # PutEnforcedGuardrailConfiguration Sets the account-level enforced guardrail configuration. ## Request Syntax ``` PUT /enforcedGuardrailsConfiguration HTTP/1.1 Content-type: application/json { "configId": "string", "guardrailInferenceConfig": { "guardrailIdentifier": "string", "guardrailVersion": "string", "modelEnforcement": { "excludedModels": [ "string" ], "includedModels": [ "string" ] }, "selectiveContentGuarding": { "messages": "string", "system": "string" } } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [configId](#API_PutEnforcedGuardrailConfiguration_RequestSyntax) ** Unique ID for the account enforced configuration. Type: String Pattern: `[a-z0-9]+` Required: No ** [guardrailInferenceConfig](#API_PutEnforcedGuardrailConfiguration_RequestSyntax) ** Account-level enforced guardrail input configuration. Type: [AccountEnforcedGuardrailInferenceInputConfiguration](API_AccountEnforcedGuardrailInferenceInputConfiguration.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "configId": "string", "updatedAt": "string", "updatedBy": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [configId](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) ** Unique ID for the account enforced configuration. Type: String Pattern: `[a-z0-9]+` ** [updatedAt](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) ** Timestamp. Type: Timestamp ** [updatedBy](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) ** The ARN of the role used to update the configuration. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration) # PutModelInvocationLoggingConfiguration Set the configuration values for model invocation logging. ## Request Syntax ``` PUT /logging/modelinvocations HTTP/1.1 Content-type: application/json { "loggingConfig": { "audioDataDeliveryEnabled": boolean, "cloudWatchConfig": { "largeDataDeliveryS3Config": { "bucketName": "string", "keyPrefix": "string" }, "logGroupName": "string", "roleArn": "string" }, "embeddingDataDeliveryEnabled": boolean, "imageDataDeliveryEnabled": boolean, "s3Config": { "bucketName": "string", "keyPrefix": "string" }, "textDataDeliveryEnabled": boolean, "videoDataDeliveryEnabled": boolean } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [loggingConfig](#API_PutModelInvocationLoggingConfiguration_RequestSyntax) ** The logging configuration values to set. Type: [LoggingConfig](API_LoggingConfig.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration) # PutResourcePolicy Adds a resource policy for a Bedrock resource. ## Request Syntax ``` POST /resource-policy HTTP/1.1 Content-type: application/json { "resourceArn": "string", "resourcePolicy": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [resourceArn](#API_PutResourcePolicy_RequestSyntax) ** The ARN of the Bedrock resource to which this resource policy applies. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes ** [resourcePolicy](#API_PutResourcePolicy_RequestSyntax) ** The JSON string representing the Bedrock resource policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 20480. Pattern: `[ -ÿ]+` Required: Yes ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "resourceArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ** [resourceArn](#API_PutResourcePolicy_ResponseSyntax) ** The ARN of the Bedrock resource to which this resource policy applies. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutResourcePolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutResourcePolicy) # PutUseCaseForModelAccess Returns the use case for model access. The example shown below under *Examples* shows the form data json configuration. ## Request Syntax ``` POST /use-case-for-model-access HTTP/1.1 Content-type: application/json { "formData": blob } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [formData](#API_PutUseCaseForModelAccess_RequestSyntax) ** Returns the form data from the Anthropic first time user request. Type: Base64-encoded binary data object Length Constraints: Minimum length of 10. Maximum length of 16384. Required: Yes ## Response Syntax ``` HTTP/1.1 201 ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Example This example illustrates one usage of PutUseCaseForModelAccess. ``` form_data = { "companyName": COMPANY_NAME, "companyWebsite": COMPANY_WEBSITE, "intendedUsers": INTENDED_USERS, "industryOption": INDUSTRY_OPTION, "otherIndustryOption": OTHER_INDUSTRY_OPTION, "useCases": USE_CASES } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutUseCaseForModelAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutUseCaseForModelAccess) # RegisterMarketplaceModelEndpoint Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs. ## Request Syntax ``` POST /marketplace-model/endpoints/endpointIdentifier/registration HTTP/1.1 Content-type: application/json { "modelSourceIdentifier": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [endpointIdentifier](#API_RegisterMarketplaceModelEndpoint_RequestSyntax) ** The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace. Length Constraints: Minimum length of 0. Maximum length of 2048. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [modelSourceIdentifier](#API_RegisterMarketplaceModelEndpoint_RequestSyntax) ** The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "marketplaceModelEndpoint": { "createdAt": "string", "endpointArn": "string", "endpointConfig": { ... }, "endpointStatus": "string", "endpointStatusMessage": "string", "modelSourceIdentifier": "string", "status": "string", "statusMessage": "string", "updatedAt": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [marketplaceModelEndpoint](#API_RegisterMarketplaceModelEndpoint_ResponseSyntax) ** Details about the registered endpoint. Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceUnavailableException ** Returned if the service cannot complete the request. HTTP Status Code: 503 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint) # StartAutomatedReasoningPolicyBuildWorkflow Starts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types. ## Request Syntax ``` POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowType/start HTTP/1.1 x-amz-client-token: clientRequestToken Content-type: application/json { "policyDefinition": { "rules": [ { "alternateExpression": "string", "expression": "string", "id": "string" } ], "types": [ { "description": "string", "name": "string", "values": [ { "description": "string", "value": "string" } ] } ], "variables": [ { "description": "string", "name": "string", "type": "string" } ], "version": "string" }, "workflowContent": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowType](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The type of build workflow to start (e.g., DOCUMENT\$1INGESTION for processing new documents, POLICY\$1REPAIR for fixing existing policies). Valid Values: `INGEST_CONTENT | REFINE_POLICY | IMPORT_POLICY | GENERATE_FIDELITY_REPORT` Required: Yes ** [clientRequestToken](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` ** [policyArn](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to start the build workflow. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [policyDefinition](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** An existing policy definition that serves as the starting point for the build workflow, typically used in policy repair or update scenarios. Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object Required: No ** [workflowContent](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) ** The actual content to be processed in the build workflow, such as documents to analyze or repair instructions to apply. Type: [AutomatedReasoningPolicyWorkflowTypeContent](API_AutomatedReasoningPolicyWorkflowTypeContent.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "buildWorkflowId": "string", "policyArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [buildWorkflowId](#API_StartAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The unique identifier of the newly started build workflow. Use this ID to track the workflow's progress and retrieve its results. Type: String Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` ** [policyArn](#API_StartAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceInUseException ** Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow) # StartAutomatedReasoningPolicyTestWorkflow Initiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results. ## Request Syntax ``` POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-workflows HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "testCaseIds": [ "string" ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) ** The build workflow identifier. The build workflow must show a `COMPLETED` status before running tests. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy to test. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [testCaseIds](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) ** The list of test identifiers to run. If not provided, all tests for the policy are run. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[0-9A-Z]{12}` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "policyArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyArn](#API_StartAutomatedReasoningPolicyTestWorkflow_ResponseSyntax) ** The Amazon Resource Name (ARN) of the policy for which the test workflow was started. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceInUseException ** Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow) # StopEvaluationJob Stops an evaluation job that is current being created or running. ## Request Syntax ``` POST /evaluation-job/jobIdentifier/stop HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobIdentifier](#API_StopEvaluationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the evaluation job you want to stop. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StopEvaluationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StopEvaluationJob) # StopModelCustomizationJob Stops an active model customization job. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` POST /model-customization-jobs/jobIdentifier/stop HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobIdentifier](#API_StopModelCustomizationJob_RequestSyntax) ** Job identifier of the job to stop. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*)` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StopModelCustomizationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StopModelCustomizationJob) # StopModelInvocationJob Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see [Stop a batch inference job](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-stop.html). ## Request Syntax ``` POST /model-invocation-job/jobIdentifier/stop HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobIdentifier](#API_StopModelInvocationJob_RequestSyntax) ** The Amazon Resource Name (ARN) of the batch inference job to stop. Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## Examples ### Stop a model invocation job This example illustrates one usage of StopModelInvocationJob. ``` POST /model-invocation-job/BATCHJOB1234/stop HTTP/1.1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StopModelInvocationJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StopModelInvocationJob) # TagResource Associate tags with a resource. For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` POST /tagResource HTTP/1.1 Content-type: application/json { "resourceARN": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [resourceARN](#API_TagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to tag. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `.*(^[a-zA-Z0-9][a-zA-Z0-9\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$))).*` Required: Yes ** [tags](#API_TagResource_RequestSyntax) ** Tags to associate with the resource. Type: Array of [Tag](API_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TagResource) # UntagResource Remove one or more tags from a resource. For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` POST /untagResource HTTP/1.1 Content-type: application/json { "resourceARN": "string", "tagKeys": [ "string" ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [resourceARN](#API_UntagResource_RequestSyntax) ** The Amazon Resource Name (ARN) of the resource to untag. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `.*(^[a-zA-Z0-9][a-zA-Z0-9\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$))).*` Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** Tag keys of the tags to remove from the resource. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9\s._:/=+@-]*` Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UntagResource) # UpdateAutomatedReasoningPolicy Updates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version. ## Request Syntax ``` PATCH /automated-reasoning-policies/policyArn HTTP/1.1 Content-type: application/json { "description": "string", "name": "string", "policyDefinition": { "rules": [ { "alternateExpression": "string", "expression": "string", "id": "string" } ], "types": [ { "description": "string", "name": "string", "values": [ { "description": "string", "value": "string" } ] } ], "variables": [ { "description": "string", "name": "string", "type": "string" } ], "version": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [policyArn](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy to update. This must be the ARN of a draft policy. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [description](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) ** The updated description for the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Pattern: `[\s\S]+` Required: No ** [name](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) ** The updated name for the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[0-9a-zA-Z-_ ]+` Required: No ** [policyDefinition](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) ** The updated policy definition containing the formal logic rules, variables, and types. Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "definitionHash": "string", "name": "string", "policyArn": "string", "updatedAt": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [definitionHash](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) ** The hash of the updated policy definition. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` ** [name](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) ** The updated name of the policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[0-9a-zA-Z-_ ]+` ** [policyArn](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) ** The Amazon Resource Name (ARN) of the updated policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [updatedAt](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) ** The timestamp when the policy was last updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** TooManyTagsException ** The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request. ** resourceName ** The name of the resource with too many tags. HTTP Status Code: 400 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy) # UpdateAutomatedReasoningPolicyAnnotations Updates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy. ## Request Syntax ``` PATCH /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/annotations HTTP/1.1 Content-type: application/json { "annotations": [ { ... } ], "lastUpdatedAnnotationSetHash": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [buildWorkflowId](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) ** The unique identifier of the build workflow whose annotations you want to update. Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` Required: Yes ** [policyArn](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to update. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [annotations](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) ** The updated annotations containing modified rules, variables, and types for the policy. Type: Array of [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: Yes ** [lastUpdatedAnnotationSetHash](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) ** The hash value of the annotation set that you're updating. This is used for optimistic concurrency control to prevent conflicting updates. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "annotationSetHash": "string", "buildWorkflowId": "string", "policyArn": "string", "updatedAt": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [annotationSetHash](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The new hash value representing the updated state of the annotations. Type: String Length Constraints: Fixed length of 128. Pattern: `[0-9a-z]{128}` ** [buildWorkflowId](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The unique identifier of the build workflow. Type: String Length Constraints: Minimum length of 0. Maximum length of 36. Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}` ** [policyArn](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [updatedAt](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) ** The timestamp when the annotations were updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations) # UpdateAutomatedReasoningPolicyTestCase Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold. ## Request Syntax ``` PATCH /automated-reasoning-policies/policyArn/test-cases/testCaseId HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "confidenceThreshold": number, "expectedAggregatedFindingsResult": "string", "guardContent": "string", "lastUpdatedAt": "string", "queryContent": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [policyArn](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` Required: Yes ** [testCaseId](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The unique identifier of the test to update. Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[0-9A-Z]{12}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [confidenceThreshold](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The updated minimum confidence level for logic validation. If null is provided, the threshold will be removed. Type: Double Valid Range: Minimum value of 0. Maximum value of 1. Required: No ** [expectedAggregatedFindingsResult](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The updated expected result of the Automated Reasoning check. Type: String Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION` Required: Yes ** [guardContent](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The updated content to be validated by the Automated Reasoning policy. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: Yes ** [lastUpdatedAt](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications. Type: Timestamp Required: Yes ** [queryContent](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) ** The updated input query or prompt that generated the content. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "policyArn": "string", "testCaseId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [policyArn](#API_UpdateAutomatedReasoningPolicyTestCase_ResponseSyntax) ** The Amazon Resource Name (ARN) of the policy that contains the updated test. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?` ** [testCaseId](#API_UpdateAutomatedReasoningPolicyTestCase_ResponseSyntax) ** The unique identifier of the updated test. Type: String Length Constraints: Minimum length of 0. Maximum length of 12. Pattern: `[0-9A-Z]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceInUseException ** Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail. HTTP Status Code: 400 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase) # UpdateCustomModelDeployment Updates a custom model deployment with a new custom model. This allows you to deploy updated models without creating new deployment endpoints. ## Request Syntax ``` PATCH /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1 Content-type: application/json { "modelArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [customModelDeploymentIdentifier](#API_UpdateCustomModelDeployment_RequestSyntax) ** Identifier of the custom model deployment to update with the new custom model. Length Constraints: Minimum length of 1. Maximum length of 93. Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [modelArn](#API_UpdateCustomModelDeployment_RequestSyntax) ** ARN of the new custom model to deploy. This replaces the currently deployed model. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}` Required: Yes ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "customModelDeploymentArn": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [customModelDeploymentArn](#API_UpdateCustomModelDeployment_ResponseSyntax) ** ARN of the custom model deployment being updated. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateCustomModelDeployment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateCustomModelDeployment) # UpdateGuardrail Updates a guardrail with the values you specify. + Specify a `name` and optional `description`. + Specify messages for when the guardrail successfully blocks a prompt or a model response in the `blockedInputMessaging` and `blockedOutputsMessaging` fields. + Specify topics for the guardrail to deny in the `topicPolicyConfig` object. Each [GuardrailTopicConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html) object in the `topicsConfig` list pertains to one topic. + Give a `name` and `description` so that the guardrail can properly identify the topic. + Specify `DENY` in the `type` field. + (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the `examples` list. + Specify filter strengths for the harmful categories defined in Amazon Bedrock in the `contentPolicyConfig` object. Each [GuardrailContentFilterConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) object in the `filtersConfig` list pertains to a harmful category. For more information, see [Content filters](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-content-filters). For more information about the fields in a content filter, see [GuardrailContentFilterConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html). + Specify the category in the `type` field. + Specify the strength of the filter for prompts in the `inputStrength` field and for model responses in the `strength` field of the [GuardrailContentFilterConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html). + (Optional) For security, include the ARN of a AWS KMS key in the `kmsKeyId` field. ## Request Syntax ``` PUT /guardrails/guardrailIdentifier HTTP/1.1 Content-type: application/json { "automatedReasoningPolicyConfig": { "confidenceThreshold": number, "policies": [ "string" ] }, "blockedInputMessaging": "string", "blockedOutputsMessaging": "string", "contentPolicyConfig": { "filtersConfig": [ { "inputAction": "string", "inputEnabled": boolean, "inputModalities": [ "string" ], "inputStrength": "string", "outputAction": "string", "outputEnabled": boolean, "outputModalities": [ "string" ], "outputStrength": "string", "type": "string" } ], "tierConfig": { "tierName": "string" } }, "contextualGroundingPolicyConfig": { "filtersConfig": [ { "action": "string", "enabled": boolean, "threshold": number, "type": "string" } ] }, "crossRegionConfig": { "guardrailProfileIdentifier": "string" }, "description": "string", "kmsKeyId": "string", "name": "string", "sensitiveInformationPolicyConfig": { "piiEntitiesConfig": [ { "action": "string", "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "type": "string" } ], "regexesConfig": [ { "action": "string", "description": "string", "inputAction": "string", "inputEnabled": boolean, "name": "string", "outputAction": "string", "outputEnabled": boolean, "pattern": "string" } ] }, "topicPolicyConfig": { "tierConfig": { "tierName": "string" }, "topicsConfig": [ { "definition": "string", "examples": [ "string" ], "inputAction": "string", "inputEnabled": boolean, "name": "string", "outputAction": "string", "outputEnabled": boolean, "type": "string" } ] }, "wordPolicyConfig": { "managedWordListsConfig": [ { "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "type": "string" } ], "wordsConfig": [ { "inputAction": "string", "inputEnabled": boolean, "outputAction": "string", "outputEnabled": boolean, "text": "string" } ] } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [guardrailIdentifier](#API_UpdateGuardrail_RequestSyntax) ** The unique identifier of the guardrail. This can be an ID or the ARN. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [automatedReasoningPolicyConfig](#API_UpdateGuardrail_RequestSyntax) ** Updated configuration for Automated Reasoning policies associated with the guardrail. Type: [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md) object Required: No ** [blockedInputMessaging](#API_UpdateGuardrail_RequestSyntax) ** The message to return when the guardrail blocks a prompt. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: Yes ** [blockedOutputsMessaging](#API_UpdateGuardrail_RequestSyntax) ** The message to return when the guardrail blocks a model response. Type: String Length Constraints: Minimum length of 1. Maximum length of 500. Required: Yes ** [contentPolicyConfig](#API_UpdateGuardrail_RequestSyntax) ** The content policy to configure for the guardrail. Type: [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md) object Required: No ** [contextualGroundingPolicyConfig](#API_UpdateGuardrail_RequestSyntax) ** The contextual grounding policy configuration used to update a guardrail. Type: [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md) object Required: No ** [crossRegionConfig](#API_UpdateGuardrail_RequestSyntax) ** The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html). Type: [GuardrailCrossRegionConfig](API_GuardrailCrossRegionConfig.md) object Required: No ** [description](#API_UpdateGuardrail_RequestSyntax) ** A description of the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No ** [kmsKeyId](#API_UpdateGuardrail_RequestSyntax) ** The ARN of the AWS KMS key with which to encrypt the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)` Required: No ** [name](#API_UpdateGuardrail_RequestSyntax) ** A name for the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: `[0-9a-zA-Z-_]+` Required: Yes ** [sensitiveInformationPolicyConfig](#API_UpdateGuardrail_RequestSyntax) ** The sensitive information policy to configure for the guardrail. Type: [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md) object Required: No ** [topicPolicyConfig](#API_UpdateGuardrail_RequestSyntax) ** The topic policy to configure for the guardrail. Type: [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md) object Required: No ** [wordPolicyConfig](#API_UpdateGuardrail_RequestSyntax) ** The word policy to configure for the guardrail. Type: [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md) object Required: No ## Response Syntax ``` HTTP/1.1 202 Content-type: application/json { "guardrailArn": "string", "guardrailId": "string", "updatedAt": "string", "version": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ** [guardrailArn](#API_UpdateGuardrail_ResponseSyntax) ** The ARN of the guardrail. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+` ** [guardrailId](#API_UpdateGuardrail_ResponseSyntax) ** The unique identifier of the guardrail Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: `[a-z0-9]+` ** [updatedAt](#API_UpdateGuardrail_ResponseSyntax) ** The date and time at which the guardrail was updated. Type: Timestamp ** [version](#API_UpdateGuardrail_ResponseSyntax) ** The version of the guardrail. Type: String Length Constraints: Fixed length of 5. Pattern: `DRAFT` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateGuardrail) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateGuardrail) # UpdateMarketplaceModelEndpoint Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace. ## Request Syntax ``` PATCH /marketplace-model/endpoints/endpointArn HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "endpointConfig": { ... } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [endpointArn](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) ** The Amazon Resource Name (ARN) of the endpoint you want to update. Length Constraints: Minimum length of 0. Maximum length of 2048. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientRequestToken](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) ** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because AWS SDKs automatically generate it for you and set this parameter. If you're not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?` Required: No ** [endpointConfig](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) ** The new configuration for the endpoint, including the number and type of instances to use. Type: [EndpointConfig](API_EndpointConfig.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "marketplaceModelEndpoint": { "createdAt": "string", "endpointArn": "string", "endpointConfig": { ... }, "endpointStatus": "string", "endpointStatusMessage": "string", "modelSourceIdentifier": "string", "status": "string", "statusMessage": "string", "updatedAt": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [marketplaceModelEndpoint](#API_UpdateMarketplaceModelEndpoint_ResponseSyntax) ** Details about the updated endpoint. Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** ConflictException ** Error occurred because of a conflict while performing an operation. HTTP Status Code: 400 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ServiceQuotaExceededException ** The number of requests exceeds the service quota. Resubmit your request later. HTTP Status Code: 400 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint) # UpdateProvisionedModelThroughput Updates the name or associated model for a Provisioned Throughput. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html). ## Request Syntax ``` PATCH /provisioned-model-throughput/provisionedModelId HTTP/1.1 Content-type: application/json { "desiredModelId": "string", "desiredProvisionedModelName": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [provisionedModelId](#API_UpdateProvisionedModelThroughput_RequestSyntax) ** The Amazon Resource Name (ARN) or ID of the Provisioned Throughput to update. Pattern: `((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [desiredModelId](#API_UpdateProvisionedModelThroughput_RequestSyntax) ** The model ID (for a foundation model), name (for a custom model), or Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model. If this Provisioned Throughput is associated with a custom model, you can specify one of the following options: + The base model from which the custom model was customized. + Another custom model that was customized from the same base model as the custom model. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)` Required: No ** [desiredProvisionedModelName](#API_UpdateProvisionedModelThroughput_RequestSyntax) ** The new name for this Provisioned Throughput. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: `([0-9a-zA-Z][_-]?)+` Required: No ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The request is denied because of missing access permissions. HTTP Status Code: 403 ** InternalServerException ** An internal server error occurred. Retry your request. HTTP Status Code: 500 ** ResourceNotFoundException ** The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 ** ThrottlingException ** The number of requests exceeds the limit. Resubmit your request later. HTTP Status Code: 429 ** ValidationException ** Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateProvisionedModelThroughput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateProvisionedModelThroughput)