InvokeDataAutomation
Process data with a data automation project or blueprints. The service processes data synchronously. Output can either be returned inline or store in the output in the S3 bucket that you specify.
Request Syntax
{
"blueprints": [
{
"blueprintArn": "string",
"stage": "string",
"version": "string"
}
],
"dataAutomationConfiguration": {
"dataAutomationProjectArn": "string",
"stage": "string"
},
"dataAutomationProfileArn": "string",
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"inputConfiguration": {
"bytes": blob,
"s3Uri": "string"
},
"outputConfiguration": {
"s3Uri": "string"
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- blueprints
-
A list of blueprints to apply to the data.
Type: Array of Blueprint objects
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: No
- dataAutomationConfiguration
-
The data automation project to process the data with.
Type: DataAutomationConfiguration object
Required: No
- dataAutomationProfileArn
-
The ARN of the profile calling your request.
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
-
Encryption settings for the invocation.
Type: EncryptionConfiguration object
Required: No
- inputConfiguration
-
Where to read the input data from.
Type: SyncInputConfiguration object
Required: Yes
- outputConfiguration
-
Where to store the output.
Type: OutputConfiguration object
Required: No
Response Syntax
{
"outputConfiguration": {
"s3Uri": "string"
},
"outputSegments": [
{
"customOutput": "string",
"customOutputStatus": "string",
"standardOutput": "string"
}
],
"semanticModality": "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.
- outputConfiguration
-
Where to store the output.
Type: OutputConfiguration object
- outputSegments
-
List of outputs for each logical sub-doc.
Type: Array of OutputSegment objects
- semanticModality
-
Detected semantic modality.
Type: String
Valid Values:
DOCUMENT | IMAGE | AUDIO | VIDEO
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 400
- InternalServerException
-
HTTP Status Code: 500
- ServiceUnavailableException
-
HTTP Status Code: 500
- ThrottlingException
-
HTTP Status Code: 400
- TooManyRequestsException
-
HTTP Status Code: 400
- 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:
