Amazon Bedrock API Reference PDF

API Reference Amazon Bedrock Copyright © 2024 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon Bedrock API Reference Amazon Bedrock: API Reference Copyright © 2024 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon Bedrock API Reference Table of Contents Amazon Bedrock API Reference..................................................................................................... 1 Amazon Bedrock endpoints....................................................................................................................... 1 AWS Command Line Interface references............................................................................................... 1 AWS SDK references.................................................................................................................................... 2 Actions............................................................................................................................................................ 4 Amazon Bedrock...................................................................................................................................... 8 Agents for Amazon Bedrock............................................................................................................ 227 Amazon Bedrock Agents Runtime.................................................................................................. 541 Amazon Bedrock Runtime................................................................................................................ 587 Data Types................................................................................................................................................. 638 Amazon Bedrock................................................................................................................................. 651 Agents for Amazon Bedrock............................................................................................................ 772 Amazon Bedrock Agents Runtime.................................................................................................. 986 Amazon Bedrock Runtime.............................................................................................................. 1151 Common Parameters............................................................................................................................ 1237 Common Errors...................................................................................................................................... 1239 iii Amazon Bedrock API Reference Amazon Bedrock API Reference This document provides detailed information about the Bedrock API actions and their parameters. For more information about setting up the Amazon Bedrock APIs, see Set up the Amazon Bedrock API. Amazon Bedrock endpoints To connect programmatically to an AWS service, you use an endpoint. Refer to the Amazon Bedrock endpoints and quotas chapter in the AWS General Reference for information about the endpoints that you can use for Amazon Bedrock. Amazon Bedrock provides the following service endpoints. bedrock – Contains control plane APIs for managing, training, and deploying models. For more information, see Amazon Bedrock Actions and Amazon Bedrock Data Types. bedrock-runtime – Contains data plane APIs for making inference requests for models hosted in Amazon Bedrock. For more information, see Amazon Bedrock Runtime Actions and Amazon Bedrock Runtime Data Types. bedrock-agent – Contains control plane APIs for creating and managing agents, knowledge bases, prompt management, and prompt ﬂows. For more information, see Amazon Bedrock Agents Actions and Amazon Bedrock Agents Data Types. bedrock-agent-runtime – Contains data plane APIs for invoking agents and ﬂows, and querying knowledge bases. For more information, see Amazon Bedrock Agents Runtime Actions and Amazon Bedrock Agents Runtime Data Types. Note Check that you're using the correct endpoint when making an API request. AWS Command Line Interface references Refer to the following references for AWS CLI commands and operations: Amazon Bedrock CLI commands Amazon Bedrock endpoints 1 Amazon Bedrock API Reference Amazon Bedrock Runtime CLI commands Amazon Bedrock Agents CLI commands Amazon Bedrock Agents Runtime CLI commands AWS SDK references AWS software development kits (SDKs) are available for many popular programming languages. Each SDK provides an API, code examples, and documentation that make it easier for developers to build applications in their preferred language. SDKs automatically perform useful tasks for you, such as: Cryptographically sign your service requests Retry requests Handle error responses Refer to the following table to ﬁnd general information about and code examples for each SDK, as well as the Amazon Bedrock API references for each SDK. You can also ﬁnd code examples at Code examples for Amazon Bedrock using AWS SDKs. SDK Code Amazon Amazon Amazon Amazon documenta examples Bedrock Bedrock Bedrock Bedrock tion preﬁx runtime Agents Agents preﬁx preﬁx runtime preﬁx AWS SDK for AWS SDK bedrock bedrock-r bedrock-a bedrock-a C++ for C++ code untime gent gent-runtime examples AWS SDK for AWS SDK bedrock bedrockru bedrockag bedrockag Go for Go code ntime ent entruntime examples AWS SDK for AWS SDK for bedrock bedrockru bedrockag bedrockag Java Java code ntime ent entruntime examples AWS SDK references 2 Amazon Bedrock API Reference SDK Code Amazon Amazon Amazon Amazon documenta examples Bedrock Bedrock Bedrock Bedrock tion preﬁx runtime Agents Agents preﬁx preﬁx runtime preﬁx AWS SDK for AWS SDK for bedrock bedrock-r bedrock-a bedrock-a JavaScript JavaScrip untime gent gent-runtime t code examples AWS SDK for AWS SDK for bedrock bedrockru bedrockag bedrockag Kotlin Kotlin code ntime ent entruntime examples AWS SDK AWS SDK Bedrock BedrockRu BedrockAg BedrockAg for.NET for.NET code ntime ent entRuntime examples AWS SDK for AWS SDK for Bedrock BedrockRu BedrockAg BedrockAg PHP PHP code ntime ent entRuntime examples AWS SDK AWS SDK bedrock bedrock-r bedrock-a bedrock-a for Python for Python untime gent gent-runtime (Boto3) (Boto3) code examples AWS SDK for AWS SDK for Bedrock BedrockRu BedrockAg BedrockAg Ruby Ruby code ntime ent entRuntime examples AWS SDK for AWS SDK for aws-sdk-b aws-sdk-b aws-sdk-b aws-sdk-b Rust Rust code edrock edrockrun edrockagent edrockage examples time ntruntime AWS SDK references 3 Amazon Bedrock API Reference SDK Code Amazon Amazon Amazon Amazon documenta examples Bedrock Bedrock Bedrock Bedrock tion preﬁx runtime Agents Agents preﬁx preﬁx runtime preﬁx AWS SDK for AWS SDK BDK BDR BDA BDZ SAP ABAP for SAP ABAP code examples AWS SDK for AWS SDK for AWSBedrock AWSBedroc AWSBedroc AWSBedroc Swift Swift code kRuntime kAgent kAgentRun examples time Topics Actions Data Types Common Parameters Common Errors Actions The following actions are supported by Amazon Bedrock: BatchDeleteEvaluationJob CreateEvaluationJob CreateGuardrail CreateGuardrailVersion CreateModelCopyJob CreateModelCustomizationJob CreateModelImportJob CreateModelInvocationJob CreateProvisionedModelThroughput Actions 4 Amazon Bedrock API Reference DeleteCustomModel DeleteGuardrail DeleteImportedModel DeleteModelInvocationLoggingConﬁguration DeleteProvisionedModelThroughput GetCustomModel GetEvaluationJob GetFoundationModel GetGuardrail GetImportedModel GetInferenceProﬁle GetModelCopyJob GetModelCustomizationJob GetModelImportJob GetModelInvocationJob GetModelInvocationLoggingConﬁguration GetProvisionedModelThroughput ListCustomModels ListEvaluationJobs ListFoundationModels ListGuardrails ListImportedModels ListInferenceProﬁles ListModelCopyJobs ListModelCustomizationJobs ListModelImportJobs ListModelInvocationJobs ListProvisionedModelThroughputs ListTagsForResource PutModelInvocationLoggingConﬁguration Actions 5 Amazon Bedrock API Reference StopEvaluationJob StopModelCustomizationJob StopModelInvocationJob TagResource UntagResource UpdateGuardrail UpdateProvisionedModelThroughput The following actions are supported by Agents for Amazon Bedrock: AssociateAgentKnowledgeBase CreateAgent CreateAgentActionGroup CreateAgentAlias CreateDataSource CreateFlow CreateFlowAlias CreateFlowVersion CreateKnowledgeBase CreatePrompt CreatePromptVersion DeleteAgent DeleteAgentActionGroup DeleteAgentAlias DeleteAgentVersion DeleteDataSource DeleteFlow DeleteFlowAlias DeleteFlowVersion DeleteKnowledgeBase DeletePrompt Actions 6 Amazon Bedrock API Reference DisassociateAgentKnowledgeBase GetAgent GetAgentActionGroup GetAgentAlias GetAgentKnowledgeBase GetAgentVersion GetDataSource GetFlow GetFlowAlias GetFlowVersion GetIngestionJob GetKnowledgeBase GetPrompt ListAgentActionGroups ListAgentAliases ListAgentKnowledgeBases ListAgents ListAgentVersions ListDataSources ListFlowAliases ListFlows ListFlowVersions ListIngestionJobs ListKnowledgeBases ListPrompts ListTagsForResource PrepareAgent PrepareFlow StartIngestionJob StopIngestionJob Actions 7 Amazon Bedrock API Reference TagResource UntagResource UpdateAgent UpdateAgentActionGroup UpdateAgentAlias UpdateAgentKnowledgeBase UpdateDataSource UpdateFlow UpdateFlowAlias UpdateKnowledgeBase UpdatePrompt The following actions are supported by Amazon Bedrock Agents Runtime: DeleteAgentMemory GetAgentMemory InvokeAgent InvokeFlow Retrieve RetrieveAndGenerate The following actions are supported by Amazon Bedrock Runtime: ApplyGuardrail Converse ConverseStream InvokeModel InvokeModelWithResponseStream Amazon Bedrock The following actions are supported by Amazon Bedrock: Amazon Bedrock 8 Amazon Bedrock API Reference BatchDeleteEvaluationJob CreateEvaluationJob CreateGuardrail CreateGuardrailVersion CreateModelCopyJob CreateModelCustomizationJob CreateModelImportJob CreateModelInvocationJob CreateProvisionedModelThroughput DeleteCustomModel DeleteGuardrail DeleteImportedModel DeleteModelInvocationLoggingConﬁguration DeleteProvisionedModelThroughput GetCustomModel GetEvaluationJob GetFoundationModel GetGuardrail GetImportedModel GetInferenceProﬁle GetModelCopyJob GetModelCustomizationJob GetModelImportJob GetModelInvocationJob GetModelInvocationLoggingConﬁguration GetProvisionedModelThroughput ListCustomModels ListEvaluationJobs ListFoundationModels ListGuardrails Amazon Bedrock 9 Amazon Bedrock API Reference ListImportedModels ListInferenceProﬁles ListModelCopyJobs ListModelCustomizationJobs ListModelImportJobs ListModelInvocationJobs ListProvisionedModelThroughputs ListTagsForResource PutModelInvocationLoggingConﬁguration StopEvaluationJob StopModelCustomizationJob StopModelInvocationJob TagResource UntagResource UpdateGuardrail UpdateProvisionedModelThroughput Amazon Bedrock 10 Amazon Bedrock API Reference BatchDeleteEvaluationJob Service: Amazon Bedrock Creates a batch deletion job. A model 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. jobIdentiﬁers An array of model evaluation job ARNs to be deleted. 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 Amazon Bedrock 11 Amazon Bedrock API Reference 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 A JSON object containing the HTTP status codes and the ARNs of model evaluation jobs that failed to be deleted. Type: Array of BatchDeleteEvaluationJobError objects Array Members: Minimum number of 0 items. Maximum number of 25 items. evaluationJobs The list of model evaluation jobs to be deleted. Type: Array of BatchDeleteEvaluationJobItem objects Errors For information about the errors that are common to all actions, see Common Errors. Amazon Bedrock 12 Amazon Bedrock API Reference AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ Amazon Bedrock 13 Amazon Bedrock API Reference AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 14 Amazon Bedrock API Reference CreateEvaluationJob Service: Amazon Bedrock API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation. Request Syntax POST /evaluation-jobs HTTP/1.1 Content-type: application/json { "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. Amazon Bedrock 15 Amazon Bedrock API Reference clientRequestToken A unique, case-sensitive identiﬁer 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ Required: No customerEncryptionKeyId Specify your customer managed key ARN that will be used to encrypt your model 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 evaluationConﬁg Speciﬁes whether the model evaluation job is automatic or uses human worker. Type: EvaluationConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes inferenceConﬁg Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model or inference proﬁle, and model evaluation job that use human workers support two models or inference proﬁles. Amazon Bedrock 16 Amazon Bedrock API Reference Type: EvaluationInferenceConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes jobDescription A description of the model evaluation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^.+$ Required: No jobName The name of the model evaluation job. Model 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 Tags to attach to the model evaluation job. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No outputDataConﬁg An object that deﬁnes where the results of model evaluation job will be saved in Amazon S3. Type: EvaluationOutputDataConﬁg object Amazon Bedrock 17 Amazon Bedrock API Reference Required: Yes roleArn The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3 buckets speciﬁed in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission. To learn more about the required permissions, see Required permissions. 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 The ARN of the model evaluation job. Type: String Length Constraints: Minimum length of 0. Maximum length of 1011. Amazon Bedrock 18 Amazon Bedrock API Reference 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 Errors. AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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. Amazon Bedrock 19 Amazon Bedrock API Reference HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 20 Amazon Bedrock API Reference CreateGuardrail Service: Amazon Bedrock Creates a guardrail to block topics and to implement safeguards for your generative AI applications. You can conﬁgure the following policies in a guardrail to avoid undesirable and harmful content, ﬁlter out denied topics and words, and remove sensitive information for privacy protection. Content ﬁlters - Adjust ﬁlter strengths to block input prompts or model responses containing harmful content. Denied topics - Deﬁne a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses. Word ﬁlters - Conﬁgure ﬁlters to block undesirable words, phrases, and profanity. Such words can include oﬀensive terms, competitor names etc. Sensitive information ﬁlters - Block or mask sensitive information such as personally identiﬁable information (PII) or custom regex in user inputs and model responses. In addition to the above policies, you can also conﬁgure the messages to be returned to the user if a user input or model response is in violation of the policies deﬁned in the guardrail. For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide. Request Syntax POST /guardrails HTTP/1.1 Content-type: application/json { "blockedInputMessaging": "string", "blockedOutputsMessaging": "string", "clientRequestToken": "string", "contentPolicyConfig": { "filtersConfig": [ { "inputStrength": "string", "outputStrength": "string", "type": "string" } ] Amazon Bedrock 21 Amazon Bedrock API Reference }, "contextualGroundingPolicyConfig": { "filtersConfig": [ { "threshold": number, "type": "string" } ] }, "description": "string", "kmsKeyId": "string", "name": "string", "sensitiveInformationPolicyConfig": { "piiEntitiesConfig": [ { "action": "string", "type": "string" } ], "regexesConfig": [ { "action": "string", "description": "string", "name": "string", "pattern": "string" } ] }, "tags": [ { "key": "string", "value": "string" } ], "topicPolicyConfig": { "topicsConfig": [ { "definition": "string", "examples": [ "string" ], "name": "string", "type": "string" } ] }, Amazon Bedrock 22 Amazon Bedrock API Reference "wordPolicyConfig": { "managedWordListsConfig": [ { "type": "string" } ], "wordsConfig": [ { "text": "string" } ] } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. blockedInputMessaging 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 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 Amazon Bedrock 23 Amazon Bedrock API Reference clientRequestToken A unique, case-sensitive identiﬁer 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 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])*$ Required: No contentPolicyConﬁg The content ﬁlter policies to conﬁgure for the guardrail. Type: GuardrailContentPolicyConﬁg object Required: No contextualGroundingPolicyConﬁg The contextual grounding policy conﬁguration used to create a guardrail. Type: GuardrailContextualGroundingPolicyConﬁg object Required: No description A description of the guardrail. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Required: No kmsKeyId 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. Amazon Bedrock 24 Amazon Bedrock API Reference 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 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 sensitiveInformationPolicyConﬁg The sensitive information policy to conﬁgure for the guardrail. Type: GuardrailSensitiveInformationPolicyConﬁg object Required: No tags The tags that you want to attach to the guardrail. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No topicPolicyConﬁg The topic policies to conﬁgure for the guardrail. Type: GuardrailTopicPolicyConﬁg object Required: No wordPolicyConﬁg The word policy you conﬁgure for the guardrail. Amazon Bedrock 25 Amazon Bedrock API Reference Type: GuardrailWordPolicyConﬁg 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 The time at which the guardrail was created. Type: Timestamp guardrailArn 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 The unique identiﬁer of the guardrail that was created. Type: String Amazon Bedrock 26 Amazon Bedrock API Reference Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^[a-z0-9]+$ version 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 Errors. AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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. Amazon Bedrock 27 Amazon Bedrock API Reference 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. 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 28 Amazon Bedrock API Reference CreateGuardrailVersion Service: Amazon Bedrock Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisﬁed with a conﬁguration, or to compare the conﬁguration 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. guardrailIdentiﬁer The unique identiﬁer 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 A unique, case-sensitive identiﬁer 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 in the Amazon S3 User Guide. Type: String Amazon Bedrock 29 Amazon Bedrock API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ Required: No description 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 The unique identiﬁer of the guardrail. Type: String Length Constraints: Minimum length of 0. Maximum length of 64. Pattern: ^[a-z0-9]+$ version The number of the version of the guardrail. Amazon Bedrock 30 Amazon Bedrock API Reference Type: String Pattern: ^[1-9][0-9]{0,7}$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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. Amazon Bedrock 31 Amazon Bedrock API Reference HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 32 Amazon Bedrock API Reference CreateModelCopyJob Service: Amazon Bedrock Copies a model to another region so that it can be used there. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide. 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 A unique, case-sensitive identiﬁer 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ Amazon Bedrock 33 Amazon Bedrock API Reference Required: No modelKmsKeyId 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 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/[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}[.]){0,2}[a-z0-9-]{1,63}([:] [a-z0-9-]{1,63}){0,2}))$ Required: Yes targetModelName 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 Tags to associate with the target model. For more information, see Tag resources in the Amazon Bedrock User Guide. Amazon Bedrock 34 Amazon Bedrock API Reference Type: Array of Tag 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 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 Errors. AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 Amazon Bedrock 35 Amazon Bedrock API Reference InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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. 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 Amazon Bedrock 36 Amazon Bedrock API Reference AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 37 Amazon Bedrock API Reference CreateModelCustomizationJob Service: Amazon Bedrock Creates a ﬁne-tuning job to customize a base model. You specify the base foundation model and the location of the training data. After the model- customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes. For information on the format of training and validation data, see Prepare the datasets. Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status. For more information, see Custom models in the Amazon Bedrock User Guide. Request Syntax POST /model-customization-jobs HTTP/1.1 Content-type: application/json { "baseModelIdentifier": "string", "clientRequestToken": "string", "customizationType": "string", "customModelKmsKeyId": "string", "customModelName": "string", "customModelTags": [ { "key": "string", "value": "string" } ], "hyperParameters": { "string" : "string" }, "jobName": "string", "jobTags": [ { "key": "string", "value": "string" } Amazon Bedrock 38 Amazon Bedrock API Reference ], "outputDataConfig": { "s3Uri": "string" }, "roleArn": "string", "trainingDataConfig": { "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. baseModelIdentiﬁer 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][_-]?)+)$ Amazon Bedrock 39 Amazon Bedrock API Reference Required: Yes clientRequestToken A unique, case-sensitive identiﬁer 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ Required: No customizationType The customization type. Type: String Valid Values: FINE_TUNING | CONTINUED_PRE_TRAINING Required: No customModelKmsKeyId 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 A name for the resulting custom model. Type: String Amazon Bedrock 40 Amazon Bedrock API Reference Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^([0-9a-zA-Z][_-]?){1,63}$ Required: Yes customModelTags Tags to attach to the resulting custom model. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No hyperParameters Parameters related to tuning the model. For details on the format for diﬀerent models, see Custom model hyperparameters. Type: String to string map Required: Yes jobName A name for the ﬁne-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 Tags to attach to the job. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Amazon Bedrock 41 Amazon Bedrock API Reference outputDataConﬁg S3 location for the output data. Type: OutputDataConﬁg object Required: Yes roleArn 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 trainingDataConﬁg Information about the training dataset. Type: TrainingDataConﬁg object Required: Yes validationDataConﬁg Information about the validation dataset. Type: ValidationDataConﬁg object Required: No vpcConﬁg The conﬁguration 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. Type: VpcConﬁg object Amazon Bedrock 42 Amazon Bedrock API Reference 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 Amazon Resource Name (ARN) of the ﬁne 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 Errors. AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. Amazon Bedrock 43 Amazon Bedrock API Reference HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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. 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-speciﬁc AWS SDKs, see the following: Amazon Bedrock 44 Amazon Bedrock API Reference AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 45 Amazon Bedrock API Reference CreateModelImportJob Service: Amazon Bedrock 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 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. Amazon Bedrock 46 Amazon Bedrock API Reference clientRequestToken A unique, case-sensitive identiﬁer 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ Required: No importedModelKmsKeyId 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 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 Tags to attach to the imported model. Type: Array of Tag objects Amazon Bedrock 47 Amazon Bedrock API Reference Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No jobName 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 Tags to attach to this import job. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No modelDataSource The data source for the imported model. Type: ModelDataSource object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes roleArn The Amazon Resource Name (ARN) of the model import job. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$ Required: Yes Amazon Bedrock 48 Amazon Bedrock API Reference vpcConﬁg VPC conﬁguration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job. Type: VpcConﬁg 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 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 Errors. AccessDeniedException The request is denied because of missing access permissions. Amazon Bedrock 49 Amazon Bedrock API Reference HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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. HTTP Status Code: 400 ValidationException Input validation failed. Check your request parameters and retry the request. HTTP Status Code: 400 Amazon Bedrock 50 Amazon Bedrock API Reference 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 Amazon Bedrock 51 Amazon Bedrock API Reference AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 52 Amazon Bedrock API Reference CreateModelInvocationJob Service: Amazon Bedrock Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference. The response returns a jobArn that you can use to stop or get details about the job. Request Syntax POST /model-invocation-job HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "inputDataConfig": {... }, "jobName": "string", "modelId": "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. Amazon Bedrock 53 Amazon Bedrock API Reference clientRequestToken A unique, case-sensitive identiﬁer 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. 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 inputDataConﬁg Details about the location of the input to the batch inference job. Type: ModelInvocationJobInputDataConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes jobName 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 The unique identiﬁer 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- Amazon Bedrock 54 Amazon Bedrock API Reference model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}$)))|([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 outputDataConﬁg Details about the location of the output of the batch inference job. Type: ModelInvocationJobOutputDataConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes roleArn 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. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$ Required: Yes tags Any tags to associate with the batch inference job. For more information, see Tagging Amazon Bedrock resources. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No timeoutDurationInHours The number of hours after which to force the batch inference job to time out. Type: Integer Amazon Bedrock 55 Amazon Bedrock API Reference Valid Range: Minimum value of 24. Maximum value of 168. Required: No vpcConﬁg The conﬁguration 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. Type: VpcConﬁg 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 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 Errors. Amazon Bedrock 56 Amazon Bedrock API Reference AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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. Amazon Bedrock 57 Amazon Bedrock API Reference 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 58 Amazon Bedrock API Reference CreateProvisionedModelThroughput Service: Amazon Bedrock Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. 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 A unique, case-sensitive identiﬁer 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 in the Amazon S3 User Guide. Type: String Amazon Bedrock 59 Amazon Bedrock API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$ Required: No commitmentDuration 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 ﬁeld. Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide Type: String Valid Values: OneMonth | SixMonths Required: No modelId The Amazon Resource Name (ARN) or name 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 in the Amazon Bedrock User Guide. 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}){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 Amazon Bedrock 60 Amazon Bedrock API Reference modelUnits Number of model units to allocate. A model unit delivers a speciﬁc throughput level for the speciﬁed model. The throughput level of a model unit speciﬁes 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 ﬁrst visit the AWS support center to request MUs. For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide. For more information about what an MU speciﬁes, contact your AWS account manager. Type: Integer Valid Range: Minimum value of 1. Required: Yes provisionedModelName 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 Tags to associate with this Provisioned Throughput. Type: Array of Tag objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No Response Syntax HTTP/1.1 201 Amazon Bedrock 61 Amazon Bedrock API Reference 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 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 Errors. 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 speciﬁed resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again. HTTP Status Code: 404 Amazon Bedrock 62 Amazon Bedrock API Reference 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. 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 63 Amazon Bedrock API Reference Amazon Bedrock 64 Amazon Bedrock API Reference DeleteCustomModel Service: Amazon Bedrock Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide. Request Syntax DELETE /custom-models/modelIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. modelIdentiﬁer 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/[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. Amazon Bedrock 65 Amazon Bedrock API Reference Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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-speciﬁc AWS SDKs, see the following: Amazon Bedrock 66 Amazon Bedrock API Reference AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 67 Amazon Bedrock API Reference DeleteGuardrail Service: Amazon Bedrock Deletes a guardrail. To delete a guardrail, only specify the ARN of the guardrail in the guardrailIdentifier ﬁeld. 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 ﬁeld and the version in the guardrailVersion ﬁeld. Request Syntax DELETE /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1 URI Request Parameters The request uses the following URI parameters. guardrailIdentiﬁer The unique identiﬁer 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 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 Amazon Bedrock 68 Amazon Bedrock API Reference 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 Errors. AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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 Amazon Bedrock 69 Amazon Bedrock API Reference See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 70 Amazon Bedrock API Reference DeleteImportedModel Service: Amazon Bedrock Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide. Request Syntax DELETE /imported-models/modelIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. modelIdentiﬁer 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 Errors. Amazon Bedrock 71 Amazon Bedrock API Reference AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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 Amazon Bedrock 72 Amazon Bedrock API Reference 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 73 Amazon Bedrock API Reference DeleteModelInvocationLoggingConﬁguration Service: Amazon Bedrock 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 Errors. 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. Amazon Bedrock 74 Amazon Bedrock API Reference HTTP Status Code: 429 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 75 Amazon Bedrock API Reference DeleteProvisionedModelThroughput Service: Amazon Bedrock Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide. Request Syntax DELETE /provisioned-model-throughput/provisionedModelId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. provisionedModelId The Amazon Resource Name (ARN) or name 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 Errors. Amazon Bedrock 76 Amazon Bedrock API Reference AccessDeniedException The request is denied because of missing access permissions. HTTP Status Code: 403 ConﬂictException Error occurred because of a conﬂict while performing an operation. HTTP Status Code: 400 InternalServerException An internal server error occurred. Retry your request. HTTP Status Code: 500 ResourceNotFoundException The speciﬁed 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ Amazon Bedrock 77 Amazon Bedrock API Reference AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 78 Amazon Bedrock API Reference GetCustomModel Service: Amazon Bedrock Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide. Request Syntax GET /custom-models/modelIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. modelIdentiﬁer 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/[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", Amazon Bedrock 79 Amazon Bedrock API Reference "creationTime": "string", "customizationType": "string", "hyperParameters": { "string" : "string" }, "jobArn": "string", "jobName": "string", "modelArn": "string", "modelKmsKeyArn": "string", "modelName": "string", "outputDataConfig": { "s3Uri": "string" }, "trainingDataConfig": { "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 Amazon Resource Name (ARN) of the base model. Type: String Amazon Bedrock 80 Amazon Bedrock API Reference Length Constraints: Minimum length of 20. Maximum length of 1011. 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}[.]){0,2}[a-z0-9-]{1,63}([:] [a-z0-9-]{1,63}){0,2}))$ creationTime Creation time of the model. Type: Timestamp customizationType The type of model customization. Type: String Valid Values: FINE_TUNING | CONTINUED_PRE_TRAINING hyperParameters Hyperparameter values associated with this model. For details on the format for diﬀerent models, see Custom model hyperparameters. Type: String to string map jobArn Job Amazon Resource Name (ARN) associated with this 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- 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 Job name associated with this model. Type: String Amazon Bedrock 81 Amazon Bedrock API Reference Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*$ modelArn 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/[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}[.]){0,2}[a-z0-9-]{1,63}([:] [a-z0-9-]{1,63}){0,2}))$ modelKmsKeyArn 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 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}$ outputDataConﬁg Output data conﬁguration associated with this custom model. Type: OutputDataConﬁg object trainingDataConﬁg Contains information about the training dataset. Amazon Bedrock 82 Amazon Bedrock API Reference Type: TrainingDataConﬁg object trainingMetrics Contains training metrics from the job creation. Type: TrainingMetrics object validationDataConﬁg Contains information about the validation dataset. Type: ValidationDataConﬁg object validationMetrics The validation metrics from the job creation. Type: Array of ValidatorMetric objects Errors For information about the errors that are common to all actions, see Common Errors. 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 speciﬁed 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. Amazon Bedrock 83 Amazon Bedrock API Reference 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-speciﬁc AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.NET AWS SDK for C++ AWS SDK for Go v2 AWS SDK for Java V2 AWS SDK for JavaScript V3 AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V3 Amazon Bedrock 84 Amazon Bedrock API Reference GetEvaluationJob Service: Amazon Bedrock Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluation. Request Syntax GET /evaluation-jobs/jobIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. jobIdentiﬁer The Amazon Resource Name (ARN) of the model evaluation job. 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 { "creationTime": "string", "customerEncryptionKeyId": "string", "evaluationConfig": {... }, "failureMessages": [ "string" ], "inferenceConfig": {... }, "jobArn": "string", Amazon Bedrock 85 Amazon Bedrock API Reference "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. creationTime When the model evaluation job was created. Type: Timestamp customerEncryptionKeyId The Amazon Resource Name (ARN) of the customer managed key speciﬁed when the model 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- _/]+)$ evaluationConﬁg Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you deﬁned. Type: EvaluationConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Amazon Bedrock 86 Amazon Bedrock API Reference failureMessages An array of strings the specify why the model evaluation job has failed. 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. inferenceConﬁg Details about the models you speciﬁed in your model evaluation job. Type: EvaluationInferenceConﬁg object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. jobArn The Amazon Resource Name (ARN) of the model 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 The description of the model evaluation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 200. Pattern: ^.+$ jobName The name of the model evaluation job. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Amazon Bedrock 87 Amazon Bedrock API Reference Pattern: ^[a-z0-9](-*[a-z0-9]){0,62}$ jobType The type of model evaluation job. Type:

Amazon Bedrock API Reference PDF

Document Details

Tags

Related

Summary

Full Transcript

Upgrade to continue