# Data Automation for Amazon Bedrock The following actions are supported by Data Automation for Amazon Bedrock: + [CopyBlueprintStage](API_data-automation_CopyBlueprintStage.md) + [CreateBlueprint](API_data-automation_CreateBlueprint.md) + [CreateBlueprintVersion](API_data-automation_CreateBlueprintVersion.md) + [CreateDataAutomationLibrary](API_data-automation_CreateDataAutomationLibrary.md) + [CreateDataAutomationProject](API_data-automation_CreateDataAutomationProject.md) + [DeleteBlueprint](API_data-automation_DeleteBlueprint.md) + [DeleteDataAutomationLibrary](API_data-automation_DeleteDataAutomationLibrary.md) + [DeleteDataAutomationProject](API_data-automation_DeleteDataAutomationProject.md) + [GetBlueprint](API_data-automation_GetBlueprint.md) + [GetBlueprintOptimizationStatus](API_data-automation_GetBlueprintOptimizationStatus.md) + [GetDataAutomationLibrary](API_data-automation_GetDataAutomationLibrary.md) + [GetDataAutomationLibraryEntity](API_data-automation_GetDataAutomationLibraryEntity.md) + [GetDataAutomationLibraryIngestionJob](API_data-automation_GetDataAutomationLibraryIngestionJob.md) + [GetDataAutomationProject](API_data-automation_GetDataAutomationProject.md) + [InvokeBlueprintOptimizationAsync](API_data-automation_InvokeBlueprintOptimizationAsync.md) + [InvokeDataAutomationLibraryIngestionJob](API_data-automation_InvokeDataAutomationLibraryIngestionJob.md) + [ListBlueprints](API_data-automation_ListBlueprints.md) + [ListDataAutomationLibraries](API_data-automation_ListDataAutomationLibraries.md) + [ListDataAutomationLibraryEntities](API_data-automation_ListDataAutomationLibraryEntities.md) + [ListDataAutomationLibraryIngestionJobs](API_data-automation_ListDataAutomationLibraryIngestionJobs.md) + [ListDataAutomationProjects](API_data-automation_ListDataAutomationProjects.md) + [ListTagsForResource](API_data-automation_ListTagsForResource.md) + [TagResource](API_data-automation_TagResource.md) + [UntagResource](API_data-automation_UntagResource.md) + [UpdateBlueprint](API_data-automation_UpdateBlueprint.md) + [UpdateDataAutomationLibrary](API_data-automation_UpdateDataAutomationLibrary.md) + [UpdateDataAutomationProject](API_data-automation_UpdateDataAutomationProject.md) # CopyBlueprintStage Copies a blueprint from one stage to another. ## Request Syntax ``` PUT /blueprints/blueprintArn/copy-stage HTTP/1.1 Content-type: application/json { "clientToken": "string", "sourceStage": "string", "targetStage": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [blueprintArn](#API_data-automation_CopyBlueprintStage_RequestSyntax) ** The blueprint's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_data-automation_CopyBlueprintStage_RequestSyntax) ** To avoid creating duplicate resources, specify a unique token for this operation. Type: String Length Constraints: Minimum length of 33. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` Required: No ** [sourceStage](#API_data-automation_CopyBlueprintStage_RequestSyntax) ** The stage to copy from. Type: String Valid Values: `DEVELOPMENT | LIVE` Required: Yes ** [targetStage](#API_data-automation_CopyBlueprintStage_RequestSyntax) ** The stage to copy to. Type: String Valid Values: `DEVELOPMENT | LIVE` 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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CopyBlueprintStage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CopyBlueprintStage) # CreateBlueprint Creates a blueprint. A blueprint has a schema that maps data fields to prompts that tell a model how to get the data out of an image or document. For schema examples, use [ListBlueprints](API_data-automation_ListBlueprints.md) to get a list of public blueprints and [GetBlueprint](API_data-automation_GetBlueprint.md) to view a blueprint. ## Request Syntax ``` PUT /blueprints/ HTTP/1.1 Content-type: application/json { "blueprintName": "string", "blueprintStage": "string", "clientToken": "string", "encryptionConfiguration": { "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string" }, "schema": "string", "tags": [ { "key": "string", "value": "string" } ], "type": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [blueprintName](#API_data-automation_CreateBlueprint_RequestSyntax) ** A name for the blueprint. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` Required: Yes ** [blueprintStage](#API_data-automation_CreateBlueprint_RequestSyntax) ** To indicate that the blueprint is not final, set to `DEVELOPMENT`. Otherwise, the blueprint is created in the `LIVE` stage. Type: String Valid Values: `DEVELOPMENT | LIVE` Required: No ** [clientToken](#API_data-automation_CreateBlueprint_RequestSyntax) ** To avoid creating duplicate resources, specify a unique token for this blueprint. Type: String Length Constraints: Minimum length of 33. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` Required: No ** [encryptionConfiguration](#API_data-automation_CreateBlueprint_RequestSyntax) ** Encryption settings for the blueprint. Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object Required: No ** [schema](#API_data-automation_CreateBlueprint_RequestSyntax) ** The blueprint's schema. Type: String Length Constraints: Minimum length of 1. Maximum length of 100000. Required: Yes ** [tags](#API_data-automation_CreateBlueprint_RequestSyntax) ** Tags assigned to a blueprint at time of creation. Type: Array of [Tag](API_data-automation_Tag.md) objects Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ** [type](#API_data-automation_CreateBlueprint_RequestSyntax) ** The type of blueprint to create. Type: String Valid Values: `DOCUMENT | IMAGE | AUDIO` Required: Yes ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "blueprint": { "blueprintArn": "string", "blueprintName": "string", "blueprintStage": "string", "blueprintVersion": "string", "creationTime": "string", "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string", "lastModifiedTime": "string", "optimizationSamples": [ { "assetS3Object": { "s3Uri": "string", "version": "string" }, "groundTruthS3Object": { "s3Uri": "string", "version": "string" } } ], "optimizationTime": "string", "schema": "string", "type": "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. ** [blueprint](#API_data-automation_CreateBlueprint_ResponseSyntax) ** Details about the blueprint. Type: [Blueprint](API_data-automation_Blueprint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateBlueprint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateBlueprint) # CreateBlueprintVersion Creates an immutable snapshot of a blueprint. ## Request Syntax ``` POST /blueprints/blueprintArn/versions/ HTTP/1.1 Content-type: application/json { "clientToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [blueprintArn](#API_data-automation_CreateBlueprintVersion_RequestSyntax) ** The blueprint's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_data-automation_CreateBlueprintVersion_RequestSyntax) ** To avoid creating duplicate resources, specify a unique token for this blueprint version. Type: String Length Constraints: Minimum length of 33. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` Required: No ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "blueprint": { "blueprintArn": "string", "blueprintName": "string", "blueprintStage": "string", "blueprintVersion": "string", "creationTime": "string", "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string", "lastModifiedTime": "string", "optimizationSamples": [ { "assetS3Object": { "s3Uri": "string", "version": "string" }, "groundTruthS3Object": { "s3Uri": "string", "version": "string" } } ], "optimizationTime": "string", "schema": "string", "type": "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. ** [blueprint](#API_data-automation_CreateBlueprintVersion_ResponseSyntax) ** Details about the blueprint. Type: [Blueprint](API_data-automation_Blueprint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion) # CreateDataAutomationLibrary Creates a data automation library. ## Request Syntax ``` PUT /data-automation-libraries/ HTTP/1.1 Content-type: application/json { "clientToken": "string", "encryptionConfiguration": { "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string" }, "libraryDescription": "string", "libraryName": "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. ** [clientToken](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) ** To avoid creating duplicate resources, specify a unique token for this library. Type: String Length Constraints: Minimum length of 33. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` Required: No ** [encryptionConfiguration](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) ** Encryption settings for the library. Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object Required: No ** [libraryDescription](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) ** A description for the library. Type: String Length Constraints: Minimum length of 0. Maximum length of 300. Pattern: `[a-zA-Z0-9\s!"\#\$%'&\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*` Required: No ** [libraryName](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) ** A name for the library. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` Required: Yes ** [tags](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) ** Tags assigned to the library at time of creation. Type: Array of [Tag](API_data-automation_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 { "libraryArn": "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. ** [libraryArn](#API_data-automation_CreateDataAutomationLibrary_ResponseSyntax) ** The library's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` ** [status](#API_data-automation_CreateDataAutomationLibrary_ResponseSyntax) ** The library's status. Type: String Valid Values: `ACTIVE | DELETING` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary) # CreateDataAutomationProject Creates a data automation project. ## Request Syntax ``` PUT /data-automation-projects/ HTTP/1.1 Content-type: application/json { "clientToken": "string", "customOutputConfiguration": { "blueprints": [ { "blueprintArn": "string", "blueprintStage": "string", "blueprintVersion": "string" } ] }, "dataAutomationLibraryConfiguration": { "libraries": [ { "libraryArn": "string" } ] }, "encryptionConfiguration": { "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string" }, "overrideConfiguration": { "audio": { "languageConfiguration": { "generativeOutputLanguage": "string", "identifyMultipleLanguages": boolean, "inputLanguages": [ "string" ] }, "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } }, "document": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } }, "splitter": { "state": "string" } }, "image": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } }, "modalityRouting": { "jpeg": "string", "mov": "string", "mp4": "string", "png": "string" }, "video": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } } }, "projectDescription": "string", "projectName": "string", "projectStage": "string", "projectType": "string", "standardOutputConfiguration": { "audio": { "extraction": { "category": { "state": "string", "typeConfiguration": { "transcript": { "channelLabeling": { "state": "string" }, "speakerLabeling": { "state": "string" } } }, "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "string" ] } }, "document": { "extraction": { "boundingBox": { "state": "string" }, "granularity": { "types": [ "string" ] } }, "generativeField": { "state": "string" }, "outputFormat": { "additionalFileFormat": { "state": "string" }, "textFormat": { "types": [ "string" ] } } }, "image": { "extraction": { "boundingBox": { "state": "string" }, "category": { "state": "string", "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "string" ] } }, "video": { "extraction": { "boundingBox": { "state": "string" }, "category": { "state": "string", "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "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. ** [clientToken](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** To avoid creating duplicate resources, specify a unique token for this project. Type: String Length Constraints: Minimum length of 33. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` Required: No ** [customOutputConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** Blueprints to enabled for the project. Type: [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md) object Required: No ** [dataAutomationLibraryConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** Library configuration for the project. Type: [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md) object Required: No ** [encryptionConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** Encryption settings for the project. Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object Required: No ** [overrideConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** Additional settings to apply to the project. Type: [OverrideConfiguration](API_data-automation_OverrideConfiguration.md) object Required: No ** [projectDescription](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** A description for the project. Type: String Length Constraints: Minimum length of 0. Maximum length of 300. Required: No ** [projectName](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** A name for the project. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` Required: Yes ** [projectStage](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** To indicate that the project is not final, set to `DEVELOPMENT`. Otherwise, the project is created in the `LIVE` stage. Type: String Valid Values: `DEVELOPMENT | LIVE` Required: No ** [projectType](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** The type of bedrock data automation API that is compatible with this project. Type: String Valid Values: `ASYNC | SYNC` Required: No ** [standardOutputConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** The standard output configuration for the project. If you omit settings for any types, default settings are applied. You can specify an empty configuration to create a project with default settings and view the settings with [GetDataAutomationProject](API_data-automation_GetDataAutomationProject.md). Type: [StandardOutputConfiguration](API_data-automation_StandardOutputConfiguration.md) object Required: Yes ** [tags](#API_data-automation_CreateDataAutomationProject_RequestSyntax) ** Tags assigned to the project at time of creation. Type: Array of [Tag](API_data-automation_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 { "projectArn": "string", "projectStage": "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. ** [projectArn](#API_data-automation_CreateDataAutomationProject_ResponseSyntax) ** The project's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}` ** [projectStage](#API_data-automation_CreateDataAutomationProject_ResponseSyntax) ** The project's stage. Type: String Valid Values: `DEVELOPMENT | LIVE` ** [status](#API_data-automation_CreateDataAutomationProject_ResponseSyntax) ** The project's status. Type: String Valid Values: `COMPLETED | IN_PROGRESS | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject) # DeleteBlueprint Deletes a blueprint or blueprint version. ## Request Syntax ``` DELETE /blueprints/blueprintArn/?blueprintVersion=blueprintVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [blueprintArn](#API_data-automation_DeleteBlueprint_RequestSyntax) ** The blueprint's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})` Required: Yes ** [blueprintVersion](#API_data-automation_DeleteBlueprint_RequestSyntax) ** To delete a blueprint version, specify the version. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[0-9]*` ## 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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/DeleteBlueprint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DeleteBlueprint) # DeleteDataAutomationLibrary Deletes a data automation library. ## Request Syntax ``` DELETE /data-automation-libraries/libraryArn/ HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [libraryArn](#API_data-automation_DeleteDataAutomationLibrary_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "libraryArn": "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. ** [libraryArn](#API_data-automation_DeleteDataAutomationLibrary_ResponseSyntax) ** The library's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` ** [status](#API_data-automation_DeleteDataAutomationLibrary_ResponseSyntax) ** The library's status. Type: String Valid Values: `ACTIVE | DELETING` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary) # DeleteDataAutomationProject Deletes a data automation project. ## Request Syntax ``` DELETE /data-automation-projects/projectArn/ HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [projectArn](#API_data-automation_DeleteDataAutomationProject_RequestSyntax) ** The project's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "projectArn": "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. ** [projectArn](#API_data-automation_DeleteDataAutomationProject_ResponseSyntax) ** The project's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}` ** [status](#API_data-automation_DeleteDataAutomationProject_ResponseSyntax) ** The project's status. Type: String Valid Values: `COMPLETED | IN_PROGRESS | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject) # GetBlueprint Gets details about a blueprint or blueprint version. ## Request Syntax ``` POST /blueprints/blueprintArn/ HTTP/1.1 Content-type: application/json { "blueprintStage": "string", "blueprintVersion": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [blueprintArn](#API_data-automation_GetBlueprint_RequestSyntax) ** The blueprint's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [blueprintStage](#API_data-automation_GetBlueprint_RequestSyntax) ** To view the development stage, set to `DEVELOPMENT`. Type: String Valid Values: `DEVELOPMENT | LIVE` Required: No ** [blueprintVersion](#API_data-automation_GetBlueprint_RequestSyntax) ** To view a blueprint version, specify the version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[0-9]*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "blueprint": { "blueprintArn": "string", "blueprintName": "string", "blueprintStage": "string", "blueprintVersion": "string", "creationTime": "string", "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string", "lastModifiedTime": "string", "optimizationSamples": [ { "assetS3Object": { "s3Uri": "string", "version": "string" }, "groundTruthS3Object": { "s3Uri": "string", "version": "string" } } ], "optimizationTime": "string", "schema": "string", "type": "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. ** [blueprint](#API_data-automation_GetBlueprint_ResponseSyntax) ** Details about the blueprint. Type: [Blueprint](API_data-automation_Blueprint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetBlueprint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetBlueprint) # GetBlueprintOptimizationStatus Gets the status of a blueprint optimization job. ## Request Syntax ``` POST /getBlueprintOptimizationStatus/invocationArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [invocationArn](#API_data-automation_GetBlueprintOptimizationStatus_RequestSyntax) ** The ARN of the optimization job invocation. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:blueprint-optimization-invocation/[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 { "errorMessage": "string", "errorType": "string", "outputConfiguration": { "s3Object": { "s3Uri": "string", "version": "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. ** [errorMessage](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) ** The error message if the job failed. Type: String ** [errorType](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) ** The type of error if the job failed. Type: String ** [outputConfiguration](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) ** The location of the optimization results. Type: [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md) object ** [status](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) ** The job's status. Type: String Valid Values: `Created | InProgress | Success | ServiceError | ClientError` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus) # GetDataAutomationLibrary Gets details about a data automation library. ## Request Syntax ``` POST /data-automation-libraries/libraryArn/ HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [libraryArn](#API_data-automation_GetDataAutomationLibrary_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "library": { "creationTime": "string", "entityTypes": [ { "entityMetadata": "string", "entityType": "string" } ], "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string", "libraryArn": "string", "libraryDescription": "string", "libraryName": "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. ** [library](#API_data-automation_GetDataAutomationLibrary_ResponseSyntax) ** Details about the library. Type: [DataAutomationLibrary](API_data-automation_DataAutomationLibrary.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary) # GetDataAutomationLibraryEntity Gets details about a data automation library entity. ## Request Syntax ``` POST /data-automation-libraries/libraryArn/entityType/entityType/entities/entityId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [entityId](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) ** The entity ID. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9-_]+` Required: Yes ** [entityType](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) ** The entity type. Valid Values: `VOCABULARY` Required: Yes ** [libraryArn](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "entity": { ... } } ``` ## 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. ** [entity](#API_data-automation_GetDataAutomationLibraryEntity_ResponseSyntax) ** Details about the entity. Type: [EntityDetails](API_data-automation_EntityDetails.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity) # GetDataAutomationLibraryIngestionJob Gets details about a data automation library ingestion job. ## Request Syntax ``` POST /data-automation-libraries/libraryArn/library-ingestion-jobs/jobArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [jobArn](#API_data-automation_GetDataAutomationLibraryIngestionJob_RequestSyntax) ** The job's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library-ingestion-job/[a-zA-Z0-9-]{12,36}` Required: Yes ** [libraryArn](#API_data-automation_GetDataAutomationLibraryIngestionJob_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "job": { "completionTime": "string", "creationTime": "string", "entityType": "string", "errorMessage": "string", "errorType": "string", "jobArn": "string", "jobStatus": "string", "operationType": "string", "outputConfiguration": { "s3Uri": "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. ** [job](#API_data-automation_GetDataAutomationLibraryIngestionJob_ResponseSyntax) ** Details about the job. Type: [DataAutomationLibraryIngestionJob](API_data-automation_DataAutomationLibraryIngestionJob.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob) # GetDataAutomationProject Gets details about a data automation project. ## Request Syntax ``` POST /data-automation-projects/projectArn/ HTTP/1.1 Content-type: application/json { "projectStage": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [projectArn](#API_data-automation_GetDataAutomationProject_RequestSyntax) ** The project's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [projectStage](#API_data-automation_GetDataAutomationProject_RequestSyntax) ** To view the development stage, set to `DEVELOPMENT`. Type: String Valid Values: `DEVELOPMENT | LIVE` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "project": { "creationTime": "string", "customOutputConfiguration": { "blueprints": [ { "blueprintArn": "string", "blueprintStage": "string", "blueprintVersion": "string" } ] }, "dataAutomationLibraryConfiguration": { "libraries": [ { "libraryArn": "string" } ] }, "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string", "lastModifiedTime": "string", "overrideConfiguration": { "audio": { "languageConfiguration": { "generativeOutputLanguage": "string", "identifyMultipleLanguages": boolean, "inputLanguages": [ "string" ] }, "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } }, "document": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } }, "splitter": { "state": "string" } }, "image": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } }, "modalityRouting": { "jpeg": "string", "mov": "string", "mp4": "string", "png": "string" }, "video": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } } }, "projectArn": "string", "projectDescription": "string", "projectName": "string", "projectStage": "string", "projectType": "string", "standardOutputConfiguration": { "audio": { "extraction": { "category": { "state": "string", "typeConfiguration": { "transcript": { "channelLabeling": { "state": "string" }, "speakerLabeling": { "state": "string" } } }, "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "string" ] } }, "document": { "extraction": { "boundingBox": { "state": "string" }, "granularity": { "types": [ "string" ] } }, "generativeField": { "state": "string" }, "outputFormat": { "additionalFileFormat": { "state": "string" }, "textFormat": { "types": [ "string" ] } } }, "image": { "extraction": { "boundingBox": { "state": "string" }, "category": { "state": "string", "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "string" ] } }, "video": { "extraction": { "boundingBox": { "state": "string" }, "category": { "state": "string", "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "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. ** [project](#API_data-automation_GetDataAutomationProject_ResponseSyntax) ** Details about the project. Type: [DataAutomationProject](API_data-automation_DataAutomationProject.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationProject) # InvokeBlueprintOptimizationAsync Starts an asynchronous job to optimize a blueprint using sample data. ## Request Syntax ``` POST /invokeBlueprintOptimizationAsync HTTP/1.1 Content-type: application/json { "blueprint": { "blueprintArn": "string", "stage": "string" }, "dataAutomationProfileArn": "string", "encryptionConfiguration": { "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string" }, "outputConfiguration": { "s3Object": { "s3Uri": "string", "version": "string" } }, "samples": [ { "assetS3Object": { "s3Uri": "string", "version": "string" }, "groundTruthS3Object": { "s3Uri": "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. ** [blueprint](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) ** The blueprint to optimize. Type: [BlueprintOptimizationObject](API_data-automation_BlueprintOptimizationObject.md) object Required: Yes ** [dataAutomationProfileArn](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) ** The ARN of the data automation profile to use. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-profile/[a-zA-Z0-9-_.]+` Required: Yes ** [encryptionConfiguration](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) ** Encryption settings for the optimization job. Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object Required: No ** [outputConfiguration](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) ** Where to store the optimization results. Type: [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md) object Required: Yes ** [samples](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) ** Sample assets and ground truth data to use for optimization. Type: Array of [BlueprintOptimizationSample](API_data-automation_BlueprintOptimizationSample.md) objects Required: Yes ** [tags](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) ** Tags to assign to the optimization job. Type: Array of [Tag](API_data-automation_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 { "invocationArn": "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. ** [invocationArn](#API_data-automation_InvokeBlueprintOptimizationAsync_ResponseSyntax) ** The ARN of the optimization job invocation. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:blueprint-optimization-invocation/[a-zA-Z0-9-_]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync) # InvokeDataAutomationLibraryIngestionJob Invokes a data automation library ingestion job. ## Request Syntax ``` PUT /data-automation-libraries/libraryArn/library-ingestion-jobs/ HTTP/1.1 Content-type: application/json { "clientToken": "string", "entityType": "string", "inputConfiguration": { "inlinePayload": { ... }, "s3Object": { "s3Uri": "string", "version": "string" } }, "notificationConfiguration": { "eventBridgeConfiguration": { "eventBridgeEnabled": boolean } }, "operationType": "string", "outputConfiguration": { "s3Uri": "string" }, "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [libraryArn](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** To avoid creating duplicate resources, specify a unique token for this job. Type: String Length Constraints: Minimum length of 33. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` Required: No ** [entityType](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** The entity type. Type: String Valid Values: `VOCABULARY` Required: Yes ** [inputConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** Input configuration for the job. Type: [InputConfiguration](API_data-automation_InputConfiguration.md) object Required: Yes ** [notificationConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** Notification configuration for the job. Type: [NotificationConfiguration](API_data-automation_NotificationConfiguration.md) object Required: No ** [operationType](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** The operation type. Type: String Valid Values: `UPSERT | DELETE` Required: Yes ** [outputConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** Output configuration for the job. Type: [OutputConfiguration](API_data-automation_OutputConfiguration.md) object Required: Yes ** [tags](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) ** Tags assigned to the job at time of creation. Type: Array of [Tag](API_data-automation_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_data-automation_InvokeDataAutomationLibraryIngestionJob_ResponseSyntax) ** The job's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library-ingestion-job/[a-zA-Z0-9-]{12,36}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob) # ListBlueprints Gets a list a blueprints in your account, or public blueprints provided by the service, or versions of a blueprint. By default, the service returns a list of blueprints without blueprint versions that are in your account and in the `LIVE` stage. ## Request Syntax ``` POST /blueprints/ HTTP/1.1 Content-type: application/json { "blueprintArn": "string", "blueprintStageFilter": "string", "maxResults": number, "nextToken": "string", "projectFilter": { "projectArn": "string", "projectStage": "string" }, "resourceOwner": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [blueprintArn](#API_data-automation_ListBlueprints_RequestSyntax) ** The blueprint's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})` Required: No ** [blueprintStageFilter](#API_data-automation_ListBlueprints_RequestSyntax) ** The blueprints' stage. To view blueprints in development, specify `DEVELOPMENT`. Type: String Valid Values: `DEVELOPMENT | LIVE | ALL` Required: No ** [maxResults](#API_data-automation_ListBlueprints_RequestSyntax) ** The maximum number of blueprints to return in one page of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_data-automation_ListBlueprints_RequestSyntax) ** 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*` Required: No ** [projectFilter](#API_data-automation_ListBlueprints_RequestSyntax) ** To view blueprints associated with a project, specify the project. Type: [DataAutomationProjectFilter](API_data-automation_DataAutomationProjectFilter.md) object Required: No ** [resourceOwner](#API_data-automation_ListBlueprints_RequestSyntax) ** The blueprints' owner. To view public blueprints, specify `SERVICE`. Type: String Valid Values: `SERVICE | ACCOUNT` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "blueprints": [ { "blueprintArn": "string", "blueprintName": "string", "blueprintStage": "string", "blueprintVersion": "string", "creationTime": "string", "lastModifiedTime": "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. ** [blueprints](#API_data-automation_ListBlueprints_ResponseSyntax) ** A list of blueprint summaries. Type: Array of [BlueprintSummary](API_data-automation_BlueprintSummary.md) objects ** [nextToken](#API_data-automation_ListBlueprints_ResponseSyntax) ** A pagination token returned if more results are available. 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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListBlueprints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListBlueprints) # ListDataAutomationLibraries Gets a list of data automation libraries in your account. ## Request Syntax ``` POST /data-automation-libraries/ HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string", "projectFilter": { "projectArn": "string", "projectStage": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [maxResults](#API_data-automation_ListDataAutomationLibraries_RequestSyntax) ** The maximum number of libraries to return in one page of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_data-automation_ListDataAutomationLibraries_RequestSyntax) ** 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*` Required: No ** [projectFilter](#API_data-automation_ListDataAutomationLibraries_RequestSyntax) ** To view libraries associated with a project, specify the project. Type: [DataAutomationProjectFilter](API_data-automation_DataAutomationProjectFilter.md) object Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "libraries": [ { "creationTime": "string", "libraryArn": "string", "libraryName": "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. ** [libraries](#API_data-automation_ListDataAutomationLibraries_ResponseSyntax) ** A list of library summaries. Type: Array of [DataAutomationLibrarySummary](API_data-automation_DataAutomationLibrarySummary.md) objects ** [nextToken](#API_data-automation_ListDataAutomationLibraries_ResponseSyntax) ** A pagination token returned if more results are available. 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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries) # ListDataAutomationLibraryEntities Gets a list of data automation library entities. ## Request Syntax ``` POST /data-automation-libraries/libraryArn/entityType/entityType/entities/ HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [entityType](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) ** The entity type. Valid Values: `VOCABULARY` Required: Yes ** [libraryArn](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [maxResults](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) ** The maximum number of entities to return in one page of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) ** 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*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "entities": [ { ... } ], "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. ** [entities](#API_data-automation_ListDataAutomationLibraryEntities_ResponseSyntax) ** A list of entity summaries. Type: Array of [DataAutomationLibraryEntitySummary](API_data-automation_DataAutomationLibraryEntitySummary.md) objects ** [nextToken](#API_data-automation_ListDataAutomationLibraryEntities_ResponseSyntax) ** A pagination token returned if more results are available. 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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities) # ListDataAutomationLibraryIngestionJobs Gets a list of data automation library ingestion jobs. ## Request Syntax ``` POST /data-automation-libraries/libraryArn/library-ingestion-jobs/ HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [libraryArn](#API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [maxResults](#API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax) ** The maximum number of jobs to return in one page of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax) ** 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*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "jobs": [ { "completionTime": "string", "creationTime": "string", "entityType": "string", "jobArn": "string", "jobStatus": "string", "operationType": "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. ** [jobs](#API_data-automation_ListDataAutomationLibraryIngestionJobs_ResponseSyntax) ** A list of job summaries. Type: Array of [DataAutomationLibraryIngestionJobSummary](API_data-automation_DataAutomationLibraryIngestionJobSummary.md) objects ** [nextToken](#API_data-automation_ListDataAutomationLibraryIngestionJobs_ResponseSyntax) ** A pagination token returned if more results are available. 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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs) # ListDataAutomationProjects Gets a list of data automation projects in your account, or public projects provided by the service. ## Request Syntax ``` POST /data-automation-projects/ HTTP/1.1 Content-type: application/json { "blueprintFilter": { "blueprintArn": "string", "blueprintStage": "string", "blueprintVersion": "string" }, "libraryFilter": { "libraryArn": "string" }, "maxResults": number, "nextToken": "string", "projectStageFilter": "string", "projectTypeFilter": "string", "resourceOwner": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [blueprintFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) ** To view projects associated with a blueprint, specify the blueprint. Type: [BlueprintFilter](API_data-automation_BlueprintFilter.md) object Required: No ** [libraryFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) ** To view projects associated with a library, specify the library. Type: [DataAutomationLibraryFilter](API_data-automation_DataAutomationLibraryFilter.md) object Required: No ** [maxResults](#API_data-automation_ListDataAutomationProjects_RequestSyntax) ** The maximum number of projects to return in one page of results. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No ** [nextToken](#API_data-automation_ListDataAutomationProjects_RequestSyntax) ** 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*` Required: No ** [projectStageFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) ** The projects' stage. To view projects in development, specify `DEVELOPMENT`. Type: String Valid Values: `DEVELOPMENT | LIVE | ALL` Required: No ** [projectTypeFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) ** The type of projects to return. Specify `ASYNC` for asynchronous projects, `SYNC` for synchronous projects, or `ALL` to return both types. Type: String Valid Values: `ASYNC | SYNC | ALL` Required: No ** [resourceOwner](#API_data-automation_ListDataAutomationProjects_RequestSyntax) ** The projects' owner. To view public projects, specify `SERVICE`. Type: String Valid Values: `SERVICE | ACCOUNT` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "projects": [ { "creationTime": "string", "projectArn": "string", "projectName": "string", "projectStage": "string", "projectType": "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_data-automation_ListDataAutomationProjects_ResponseSyntax) ** A pagination token returned if more results are available. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `\S*` ** [projects](#API_data-automation_ListDataAutomationProjects_ResponseSyntax) ** A list of project summaries. Type: Array of [DataAutomationProjectSummary](API_data-automation_DataAutomationProjectSummary.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects) # ListTagsForResource Lists a resources tags. ## 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_data-automation_ListTagsForResource_RequestSyntax) ** The ARN of the resource you want to check the tags of Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]*:[0-9]{12}:(blueprint|data-automation-project|blueprint-optimization-invocation|data-automation-library|data-automation-library-ingestion-job)/[a-zA-Z0-9-]{12,36}` 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_data-automation_ListTagsForResource_ResponseSyntax) ** The requested resource's tags. Type: Array of [Tag](API_data-automation_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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListTagsForResource) # TagResource Lets you add a tag to an already created resource. ## 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_data-automation_TagResource_RequestSyntax) ** The ARN of the resource you want to tag Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]*:[0-9]{12}:(blueprint|data-automation-project|blueprint-optimization-invocation|data-automation-library|data-automation-library-ingestion-job)/[a-zA-Z0-9-]{12,36}` Required: Yes ** [tags](#API_data-automation_TagResource_RequestSyntax) ** The tags you want to add to a resource. Type: Array of [Tag](API_data-automation_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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/TagResource) # UntagResource Remove the tags from a resource. ## 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_data-automation_UntagResource_RequestSyntax) ** The ARN of the resource you want to untag. Type: String Length Constraints: Minimum length of 20. Maximum length of 1011. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]*:[0-9]{12}:(blueprint|data-automation-project|blueprint-optimization-invocation|data-automation-library|data-automation-library-ingestion-job)/[a-zA-Z0-9-]{12,36}` Required: Yes ** [tagKeys](#API_data-automation_UntagResource_RequestSyntax) ** The keys of the tag you want to untag. 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. 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 ** HTTP Status Code: 403 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UntagResource) # UpdateBlueprint Updates a blueprint. ## Request Syntax ``` PUT /blueprints/blueprintArn/ HTTP/1.1 Content-type: application/json { "blueprintStage": "string", "encryptionConfiguration": { "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string" }, "schema": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [blueprintArn](#API_data-automation_UpdateBlueprint_RequestSyntax) ** The blueprint's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [blueprintStage](#API_data-automation_UpdateBlueprint_RequestSyntax) ** To update the development stage, set to `DEVELOPMENT`. Type: String Valid Values: `DEVELOPMENT | LIVE` Required: No ** [encryptionConfiguration](#API_data-automation_UpdateBlueprint_RequestSyntax) ** Encryption for the updated blueprint. Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object Required: No ** [schema](#API_data-automation_UpdateBlueprint_RequestSyntax) ** The blueprint's schema. Type: String Length Constraints: Minimum length of 1. Maximum length of 100000. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "blueprint": { "blueprintArn": "string", "blueprintName": "string", "blueprintStage": "string", "blueprintVersion": "string", "creationTime": "string", "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string", "lastModifiedTime": "string", "optimizationSamples": [ { "assetS3Object": { "s3Uri": "string", "version": "string" }, "groundTruthS3Object": { "s3Uri": "string", "version": "string" } } ], "optimizationTime": "string", "schema": "string", "type": "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. ** [blueprint](#API_data-automation_UpdateBlueprint_ResponseSyntax) ** Details about the blueprint. Type: [Blueprint](API_data-automation_Blueprint.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UpdateBlueprint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UpdateBlueprint) # UpdateDataAutomationLibrary Updates a data automation library. ## Request Syntax ``` PUT /data-automation-libraries/libraryArn/ HTTP/1.1 Content-type: application/json { "clientToken": "string", "libraryDescription": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [libraryArn](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) ** The library's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [clientToken](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) ** To avoid creating duplicate resources, specify a unique token for this operation. Type: String Length Constraints: Minimum length of 33. Maximum length of 256. Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}` Required: No ** [libraryDescription](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) ** A description for the library. Type: String Length Constraints: Minimum length of 0. Maximum length of 300. Pattern: `[a-zA-Z0-9\s!"\#\$%'&\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "libraryArn": "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. ** [libraryArn](#API_data-automation_UpdateDataAutomationLibrary_ResponseSyntax) ** The library's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}` ** [status](#API_data-automation_UpdateDataAutomationLibrary_ResponseSyntax) ** The library's status. Type: String Valid Values: `ACTIVE | DELETING` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary) # UpdateDataAutomationProject Updates a data automation project. ## Request Syntax ``` PUT /data-automation-projects/projectArn/ HTTP/1.1 Content-type: application/json { "customOutputConfiguration": { "blueprints": [ { "blueprintArn": "string", "blueprintStage": "string", "blueprintVersion": "string" } ] }, "dataAutomationLibraryConfiguration": { "libraries": [ { "libraryArn": "string" } ] }, "encryptionConfiguration": { "kmsEncryptionContext": { "string" : "string" }, "kmsKeyId": "string" }, "overrideConfiguration": { "audio": { "languageConfiguration": { "generativeOutputLanguage": "string", "identifyMultipleLanguages": boolean, "inputLanguages": [ "string" ] }, "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } }, "document": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } }, "splitter": { "state": "string" } }, "image": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } }, "modalityRouting": { "jpeg": "string", "mov": "string", "mp4": "string", "png": "string" }, "video": { "modalityProcessing": { "state": "string" }, "sensitiveDataConfiguration": { "detectionMode": "string", "detectionScope": [ "string" ], "piiEntitiesConfiguration": { "piiEntityTypes": [ "string" ], "redactionMaskMode": "string" } } } }, "projectDescription": "string", "projectStage": "string", "standardOutputConfiguration": { "audio": { "extraction": { "category": { "state": "string", "typeConfiguration": { "transcript": { "channelLabeling": { "state": "string" }, "speakerLabeling": { "state": "string" } } }, "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "string" ] } }, "document": { "extraction": { "boundingBox": { "state": "string" }, "granularity": { "types": [ "string" ] } }, "generativeField": { "state": "string" }, "outputFormat": { "additionalFileFormat": { "state": "string" }, "textFormat": { "types": [ "string" ] } } }, "image": { "extraction": { "boundingBox": { "state": "string" }, "category": { "state": "string", "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "string" ] } }, "video": { "extraction": { "boundingBox": { "state": "string" }, "category": { "state": "string", "types": [ "string" ] } }, "generativeField": { "state": "string", "types": [ "string" ] } } } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [projectArn](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** The project's ARN. Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [customOutputConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** Blueprints to enable for the project. Type: [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md) object Required: No ** [dataAutomationLibraryConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** Library configuration for the project. Type: [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md) object Required: No ** [encryptionConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** Encryption for the created project. Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object Required: No ** [overrideConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** Additional settings to apply to the project. Type: [OverrideConfiguration](API_data-automation_OverrideConfiguration.md) object Required: No ** [projectDescription](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** A description for the project. Type: String Length Constraints: Minimum length of 0. Maximum length of 300. Required: No ** [projectStage](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** To update the development stage, set to `DEVELOPMENT`. Type: String Valid Values: `DEVELOPMENT | LIVE` Required: No ** [standardOutputConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) ** The standard output configuration for the project. If you omit settings for any types, default settings are applied. Type: [StandardOutputConfiguration](API_data-automation_StandardOutputConfiguration.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "projectArn": "string", "projectStage": "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. ** [projectArn](#API_data-automation_UpdateDataAutomationProject_ResponseSyntax) ** The project's ARN. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}` ** [projectStage](#API_data-automation_UpdateDataAutomationProject_ResponseSyntax) ** The project's stage. Type: String Valid Values: `DEVELOPMENT | LIVE` ** [status](#API_data-automation_UpdateDataAutomationProject_ResponseSyntax) ** The project's status. Type: String Valid Values: `COMPLETED | IN_PROGRESS | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** HTTP Status Code: 403 ** ConflictException ** HTTP Status Code: 409 ** InternalServerException ** HTTP Status Code: 500 ** ResourceNotFoundException ** HTTP Status Code: 404 ** ServiceQuotaExceededException ** HTTP Status Code: 402 ** ThrottlingException ** HTTP Status Code: 429 ** ValidationException ** 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-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)