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"
}
]
},
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"overrideConfiguration": {
"document": {
"splitter": {
"state": "string"
}
}
},
"projectDescription": "string",
"projectName": "string",
"projectStage": "string",
"standardOutputConfiguration": {
"audio": {
"extraction": {
"category": {
"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
-
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
-
Blueprints to enabled for the project.
Type: CustomOutputConfiguration object
Required: No
- encryptionConfiguration
-
Encryption settings for the project.
Type: EncryptionConfiguration object
Required: No
- overrideConfiguration
-
Additional settings to apply to the project.
Type: OverrideConfiguration object
Required: No
- projectDescription
-
A description for the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Required: No
- projectName
-
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
-
To indicate that the project is not final, set to
DEVELOPMENT. Otherwise, the project is created in theLIVEstage.Type: String
Valid Values:
DEVELOPMENT | LIVERequired: No
- standardOutputConfiguration
-
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.
Type: StandardOutputConfiguration object
Required: Yes
-
Tags assigned to the project at time of creation.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"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
-
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
-
The project's stage.
Type: String
Valid Values:
DEVELOPMENT | LIVE - status
-
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 Errors.
- 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:
