{ "version":"2.0", "metadata":{ "apiVersion":"2024-06-13", "auth":["aws.auth#sigv4"], "endpointPrefix":"bedrock-data-automation-runtime", "jsonVersion":"1.1", "protocol":"json", "protocols":["json"], "serviceFullName":"Runtime for Amazon Bedrock Data Automation", "serviceId":"Bedrock Data Automation Runtime", "signatureVersion":"v4", "signingName":"bedrock", "targetPrefix":"AmazonBedrockKeystoneRuntimeService", "uid":"bedrock-data-automation-runtime-2024-06-13" }, "operations":{ "GetDataAutomationStatus":{ "name":"GetDataAutomationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDataAutomationStatusRequest"}, "output":{"shape":"GetDataAutomationStatusResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

API used to get data automation status.

", "readonly":true }, "InvokeDataAutomation":{ "name":"InvokeDataAutomation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InvokeDataAutomationRequest"}, "output":{"shape":"InvokeDataAutomationResponse"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Sync API: Invoke data automation.

" }, "InvokeDataAutomationAsync":{ "name":"InvokeDataAutomationAsync", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InvokeDataAutomationAsyncRequest"}, "output":{"shape":"InvokeDataAutomationAsyncResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], "documentation":"

Async API: Invoke data automation.

", "idempotent":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

List tags for an Amazon Bedrock Data Automation resource

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

Tag an Amazon Bedrock Data Automation resource

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

Untag an Amazon Bedrock Data Automation resource

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"

This exception will be thrown when customer does not have access to API.

", "exception":true }, "AssetProcessingConfiguration":{ "type":"structure", "members":{ "video":{ "shape":"VideoAssetProcessingConfiguration", "documentation":"

Video asset processing configuration

" } }, "documentation":"

Config containing asset processing related knobs for all modalities

" }, "AutomationJobStatus":{ "type":"string", "documentation":"

List of status supported by automation jobs

", "enum":[ "Created", "InProgress", "Success", "ServiceError", "ClientError" ] }, "Blob":{"type":"blob"}, "Blueprint":{ "type":"structure", "required":["blueprintArn"], "members":{ "blueprintArn":{ "shape":"BlueprintArn", "documentation":"

Arn of blueprint.

" }, "version":{ "shape":"BlueprintVersion", "documentation":"

Version of blueprint.

" }, "stage":{ "shape":"BlueprintStage", "documentation":"

Stage of blueprint.

" } }, "documentation":"

Structure for single blueprint entity.

" }, "BlueprintArn":{ "type":"string", "documentation":"

ARN of a Blueprint

", "max":128, "min":0, "pattern":"arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-insights-public-[a-zA-Z0-9-_]{1,30}|bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})" }, "BlueprintList":{ "type":"list", "member":{ "shape":"Blueprint", "documentation":"

Blueprint.

" }, "documentation":"

Blueprint list.

", "max":40, "min":1 }, "BlueprintStage":{ "type":"string", "documentation":"

Blueprint stage enum.

", "enum":[ "DEVELOPMENT", "LIVE" ] }, "BlueprintVersion":{ "type":"string", "documentation":"

Blueprint version.

", "max":128, "min":1, "pattern":"[0-9]*" }, "Boolean":{ "type":"boolean", "box":true }, "CustomOutputStatus":{ "type":"string", "documentation":"

Custom output status enum

", "enum":[ "MATCH", "NO_MATCH" ] }, "DataAutomationArn":{ "type":"string", "documentation":"

Data automation arn.

", "max":128, "min":1, "pattern":"arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-_]+" }, "DataAutomationConfiguration":{ "type":"structure", "required":["dataAutomationProjectArn"], "members":{ "dataAutomationProjectArn":{ "shape":"DataAutomationArn", "documentation":"

Data automation project arn.

" }, "stage":{ "shape":"DataAutomationStage", "documentation":"

Data automation stage.

" } }, "documentation":"

Data automation configuration.

" }, "DataAutomationProfileArn":{ "type":"string", "documentation":"

Data automation profile arn.

", "max":128, "min":1, "pattern":"arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-profile/[a-zA-Z0-9-_.]+" }, "DataAutomationStage":{ "type":"string", "documentation":"

Data automation stage.

", "enum":[ "LIVE", "DEVELOPMENT" ] }, "EncryptionConfiguration":{ "type":"structure", "required":["kmsKeyId"], "members":{ "kmsKeyId":{ "shape":"KMSKeyId", "documentation":"

Customer KMS key used for encryption

" }, "kmsEncryptionContext":{ "shape":"EncryptionContextMap", "documentation":"

KMS encryption context.

" } }, "documentation":"

Encryption configuration.

" }, "EncryptionContextKey":{ "type":"string", "documentation":"

Excryption context key.

", "max":2000, "min":1, "pattern":".*\\S.*" }, "EncryptionContextMap":{ "type":"map", "key":{"shape":"EncryptionContextKey"}, "value":{"shape":"EncryptionContextValue"}, "max":10, "min":1 }, "EncryptionContextValue":{ "type":"string", "documentation":"

Encryption context value.

", "max":2000, "min":1, "pattern":".*\\S.*" }, "EventBridgeConfiguration":{ "type":"structure", "required":["eventBridgeEnabled"], "members":{ "eventBridgeEnabled":{ "shape":"Boolean", "documentation":"

Event bridge flag.

" } }, "documentation":"

Event bridge configuration.

" }, "GetDataAutomationStatusRequest":{ "type":"structure", "required":["invocationArn"], "members":{ "invocationArn":{ "shape":"InvocationArn", "documentation":"

Invocation arn.

" } }, "documentation":"

Structure for request of GetDataAutomationStatus API.

" }, "GetDataAutomationStatusResponse":{ "type":"structure", "members":{ "status":{ "shape":"AutomationJobStatus", "documentation":"

Job Status.

" }, "errorType":{ "shape":"String", "documentation":"

Error Type.

" }, "errorMessage":{ "shape":"String", "documentation":"

Error Message.

" }, "outputConfiguration":{ "shape":"OutputConfiguration", "documentation":"

Output configuration.

" }, "jobSubmissionTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Job Submission time.

" }, "jobCompletionTime":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Job completion time.

" }, "jobDurationInSeconds":{ "shape":"Integer", "documentation":"

Job duration in seconds.

" } }, "documentation":"

Response of GetDataAutomationStatus API.

" }, "IdempotencyToken":{ "type":"string", "documentation":"

Client specified token used for idempotency checks

", "max":256, "min":1, "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9]){1,256}" }, "InputConfiguration":{ "type":"structure", "required":["s3Uri"], "members":{ "s3Uri":{ "shape":"S3Uri", "documentation":"

S3 uri.

" }, "assetProcessingConfiguration":{ "shape":"AssetProcessingConfiguration", "documentation":"

Asset processing configuration

" } }, "documentation":"

Input configuration.

" }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"

This exception is for any internal un-expected service errors.

", "exception":true, "fault":true }, "InvocationArn":{ "type":"string", "documentation":"

Invocation arn.

", "max":128, "min":1, "pattern":"arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-invocation/[a-zA-Z0-9-_]+" }, "InvokeDataAutomationAsyncRequest":{ "type":"structure", "required":[ "inputConfiguration", "outputConfiguration", "dataAutomationProfileArn" ], "members":{ "clientToken":{ "shape":"IdempotencyToken", "documentation":"

Idempotency token.

", "idempotencyToken":true }, "inputConfiguration":{ "shape":"InputConfiguration", "documentation":"

Input configuration.

" }, "outputConfiguration":{ "shape":"OutputConfiguration", "documentation":"

Output configuration.

" }, "dataAutomationConfiguration":{ "shape":"DataAutomationConfiguration", "documentation":"

Data automation configuration.

" }, "encryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

Encryption configuration.

" }, "notificationConfiguration":{ "shape":"NotificationConfiguration", "documentation":"

Notification configuration.

" }, "blueprints":{ "shape":"BlueprintList", "documentation":"

Blueprint list.

" }, "dataAutomationProfileArn":{ "shape":"DataAutomationProfileArn", "documentation":"

Data automation profile ARN

" }, "tags":{ "shape":"TagList", "documentation":"

List of tags.

" } }, "documentation":"

Invoke Data Automation Async Request

" }, "InvokeDataAutomationAsyncResponse":{ "type":"structure", "required":["invocationArn"], "members":{ "invocationArn":{ "shape":"InvocationArn", "documentation":"

ARN of the automation job

" } }, "documentation":"

Invoke Data Automation Async Response

" }, "InvokeDataAutomationRequest":{ "type":"structure", "required":[ "inputConfiguration", "dataAutomationProfileArn" ], "members":{ "inputConfiguration":{ "shape":"SyncInputConfiguration", "documentation":"

Input configuration.

" }, "dataAutomationConfiguration":{ "shape":"DataAutomationConfiguration", "documentation":"

Data automation configuration.

" }, "blueprints":{ "shape":"BlueprintList", "documentation":"

Blueprint list.

" }, "dataAutomationProfileArn":{ "shape":"DataAutomationProfileArn", "documentation":"

Data automation profile ARN

" }, "encryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

Encryption configuration.

" }, "outputConfiguration":{ "shape":"OutputConfiguration", "documentation":"

Output configuration.

" } }, "documentation":"

Invoke Data Automation Request

" }, "InvokeDataAutomationResponse":{ "type":"structure", "required":["semanticModality"], "members":{ "outputConfiguration":{ "shape":"OutputConfiguration", "documentation":"

Output configuration

" }, "semanticModality":{ "shape":"SemanticModality", "documentation":"

Detected semantic modality

" }, "outputSegments":{ "shape":"OutputSegmentList", "documentation":"

List of outputs for each logical sub-doc

" } }, "documentation":"

Invoke Data Automation Response

" }, "KMSKeyId":{ "type":"string", "max":2048, "min":1, "pattern":"[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceARN"], "members":{ "resourceARN":{"shape":"TaggableResourceArn"} } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{"shape":"TagList"} } }, "NonBlankString":{ "type":"string", "pattern":"[\\s\\S]*" }, "NotificationConfiguration":{ "type":"structure", "required":["eventBridgeConfiguration"], "members":{ "eventBridgeConfiguration":{ "shape":"EventBridgeConfiguration", "documentation":"

Event bridge configuration.

" } }, "documentation":"

Notification configuration.

" }, "OutputConfiguration":{ "type":"structure", "required":["s3Uri"], "members":{ "s3Uri":{ "shape":"S3Uri", "documentation":"

S3 uri.

" } }, "documentation":"

Output configuration.

" }, "OutputSegment":{ "type":"structure", "members":{ "customOutputStatus":{ "shape":"CustomOutputStatus", "documentation":"

Status of blueprint match

" }, "customOutput":{ "shape":"String", "documentation":"

Custom output response

" }, "standardOutput":{ "shape":"String", "documentation":"

Standard output response

" } }, "documentation":"

Results for an output segment

" }, "OutputSegmentList":{ "type":"list", "member":{ "shape":"OutputSegment", "documentation":"

Output segment

" }, "documentation":"

Output segment list

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"

This exception will be thrown when resource provided from customer not found.

", "exception":true }, "S3Uri":{ "type":"string", "documentation":"

A path in S3

", "max":1024, "min":1, "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/[^\\x00-\\x1F\\x7F\\{^}%`\\]\">\\[~<#|]*)?" }, "SemanticModality":{ "type":"string", "documentation":"

Semantic modality enum

", "enum":[ "DOCUMENT", "IMAGE", "AUDIO", "VIDEO" ] }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"

This exception will be thrown when service quota is exceeded.

", "exception":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"

This exception will be thrown when service is temporarily unavailable.

", "exception":true, "fault":true }, "String":{"type":"string"}, "SyncInputConfiguration":{ "type":"structure", "members":{ "bytes":{ "shape":"Blob", "documentation":"

Input data as bytes

" }, "s3Uri":{ "shape":"S3Uri", "documentation":"

S3 URI of the input data

" } }, "documentation":"

Input configuration for synchronous API

" }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "Tag":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"} }, "documentation":"

Key value pair of a tag

" }, "TagKey":{ "type":"string", "documentation":"

Defines the context of the tag.

", "max":128, "min":1, "pattern":"(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "documentation":"

List of tag keys

", "max":200, "min":0 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "documentation":"

List of tags

", "max":200, "min":0 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceARN", "tags" ], "members":{ "resourceARN":{"shape":"TaggableResourceArn"}, "tags":{"shape":"TagList"} } }, "TagResourceResponse":{ "type":"structure", "members":{} }, "TagValue":{ "type":"string", "documentation":"

Defines the value within the context. e.g. <key=reason, value=training>.

", "max":256, "min":0, "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" }, "TaggableResourceArn":{ "type":"string", "documentation":"

ARN of a taggable resource

", "max":1011, "min":20, "pattern":"arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-invocation/[a-zA-Z0-9-_]+" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"

This exception will be thrown when customer reached API TPS limit.

", "exception":true }, "TimestampSegment":{ "type":"structure", "required":[ "startTimeMillis", "endTimeMillis" ], "members":{ "startTimeMillis":{ "shape":"TimestampSegmentStartTimeMillisLong", "documentation":"

Start timestamp in milliseconds

" }, "endTimeMillis":{ "shape":"TimestampSegmentEndTimeMillisLong", "documentation":"

End timestamp in milliseconds

" } }, "documentation":"

Timestamp segment

" }, "TimestampSegmentEndTimeMillisLong":{ "type":"long", "box":true, "min":300000 }, "TimestampSegmentStartTimeMillisLong":{ "type":"long", "box":true, "min":0 }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceARN", "tagKeys" ], "members":{ "resourceARN":{"shape":"TaggableResourceArn"}, "tagKeys":{"shape":"TagKeyList"} } }, "UntagResourceResponse":{ "type":"structure", "members":{} }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"NonBlankString"} }, "documentation":"

This exception will be thrown when customer provided invalid parameters.

", "exception":true }, "VideoAssetProcessingConfiguration":{ "type":"structure", "members":{ "segmentConfiguration":{ "shape":"VideoSegmentConfiguration", "documentation":"

Delimits the segment of the input that will be processed

" } }, "documentation":"

Video asset processing configuration

" }, "VideoSegmentConfiguration":{ "type":"structure", "members":{ "timestampSegment":{ "shape":"TimestampSegment", "documentation":"

Timestamp segment

" } }, "documentation":"

Delimits the segment of the input that will be processed

", "union":true } }, "documentation":"

Amazon Bedrock Data Automation Runtime

" }