SDK for PHP 3.x

Runtime for Amazon Bedrock Data Automation 2024-06-13

Client: Aws\BedrockDataAutomationRuntime\BedrockDataAutomationRuntimeClient
Service ID: bedrock-data-automation-runtime
Version: 2024-06-13

This page describes the parameters and results for the operations of the Runtime for Amazon Bedrock Data Automation (2024-06-13), and shows how to use the Aws\BedrockDataAutomationRuntime\BedrockDataAutomationRuntimeClient object to call the described operations. This documentation is specific to the 2024-06-13 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetDataAutomationStatus ( array $params = [] )
API used to get data automation status.
InvokeDataAutomationAsync ( array $params = [] )
Async API: Invoke data automation.
ListTagsForResource ( array $params = [] )
List tags for an Amazon Bedrock Data Automation resource
TagResource ( array $params = [] )
Tag an Amazon Bedrock Data Automation resource
UntagResource ( array $params = [] )
Untag an Amazon Bedrock Data Automation resource

Operations

GetDataAutomationStatus 

$result = $client->getDataAutomationStatus([/* ... */]);
$promise = $client->getDataAutomationStatusAsync([/* ... */]);

API used to get data automation status.

Parameter Syntax

$result = $client->getDataAutomationStatus([
    'invocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
invocationArn
Required: Yes
Type: string

Invocation arn.

Result Syntax

[
    'errorMessage' => '<string>',
    'errorType' => '<string>',
    'outputConfiguration' => [
        's3Uri' => '<string>',
    ],
    'status' => 'Created|InProgress|Success|ServiceError|ClientError',
]

Result Details

Members
errorMessage
Type: string

Error Message.

errorType
Type: string

Error Type.

outputConfiguration
Type: OutputConfiguration structure

Output configuration.

status
Type: string

Job Status.

Errors

ValidationException:

This exception will be thrown when customer provided invalid parameters.

AccessDeniedException:

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

InternalServerException:

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

ThrottlingException:

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

ResourceNotFoundException:

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

InvokeDataAutomationAsync 

$result = $client->invokeDataAutomationAsync([/* ... */]);
$promise = $client->invokeDataAutomationAsyncAsync([/* ... */]);

Async API: Invoke data automation.

Parameter Syntax

$result = $client->invokeDataAutomationAsync([
    'blueprints' => [
        [
            'blueprintArn' => '<string>', // REQUIRED
            'stage' => 'DEVELOPMENT|LIVE',
            'version' => '<string>',
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'dataAutomationConfiguration' => [
        'dataAutomationProjectArn' => '<string>', // REQUIRED
        'stage' => 'LIVE|DEVELOPMENT',
    ],
    'dataAutomationProfileArn' => '<string>', // REQUIRED
    'encryptionConfiguration' => [
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>', // REQUIRED
    ],
    'inputConfiguration' => [ // REQUIRED
        'assetProcessingConfiguration' => [
            'video' => [
                'segmentConfiguration' => [
                    'timestampSegment' => [
                        'endTimeMillis' => <integer>, // REQUIRED
                        'startTimeMillis' => <integer>, // REQUIRED
                    ],
                ],
            ],
        ],
        's3Uri' => '<string>', // REQUIRED
    ],
    'notificationConfiguration' => [
        'eventBridgeConfiguration' => [ // REQUIRED
            'eventBridgeEnabled' => true || false, // REQUIRED
        ],
    ],
    'outputConfiguration' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
blueprints
Type: Array of Blueprint structures

Blueprint list.

clientToken
Type: string

Idempotency token.

dataAutomationConfiguration
Type: DataAutomationConfiguration structure

Data automation configuration.

dataAutomationProfileArn
Required: Yes
Type: string

Data automation profile ARN

encryptionConfiguration
Type: EncryptionConfiguration structure

Encryption configuration.

inputConfiguration
Required: Yes
Type: InputConfiguration structure

Input configuration.

notificationConfiguration
Type: NotificationConfiguration structure

Notification configuration.

outputConfiguration
Required: Yes
Type: OutputConfiguration structure

Output configuration.

tags
Type: Array of Tag structures

List of tags.

Result Syntax

[
    'invocationArn' => '<string>',
]

Result Details

Members
invocationArn
Required: Yes
Type: string

ARN of the automation job

Errors

ServiceQuotaExceededException:

This exception will be thrown when service quota is exceeded.

ValidationException:

This exception will be thrown when customer provided invalid parameters.

AccessDeniedException:

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

InternalServerException:

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

ThrottlingException:

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

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List tags for an Amazon Bedrock Data Automation resource

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceARN
Required: Yes
Type: string

ARN of a taggable resource

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
tags
Type: Array of Tag structures

List of tags

Errors

ValidationException:

This exception will be thrown when customer provided invalid parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

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

ThrottlingException:

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

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tag an Amazon Bedrock Data Automation resource

Parameter Syntax

$result = $client->tagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
resourceARN
Required: Yes
Type: string

ARN of a taggable resource

tags
Required: Yes
Type: Array of Tag structures

List of tags

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:

This exception will be thrown when service quota is exceeded.

ValidationException:

This exception will be thrown when customer provided invalid parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

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

ThrottlingException:

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

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Untag an Amazon Bedrock Data Automation resource

Parameter Syntax

$result = $client->untagResource([
    'resourceARN' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceARN
Required: Yes
Type: string

ARN of a taggable resource

tagKeys
Required: Yes
Type: Array of strings

List of tag keys

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

This exception will be thrown when customer provided invalid parameters.

AccessDeniedException:

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

InternalServerException:

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

ResourceNotFoundException:

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

ThrottlingException:

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

Shapes

AccessDeniedException

Description

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

Members
message
Type: string

AssetProcessingConfiguration

Description

Config containing asset processing related knobs for all modalities

Members
video
Type: VideoAssetProcessingConfiguration structure

Video asset processing configuration

Blueprint

Description

Structure for single blueprint entity.

Members
blueprintArn
Required: Yes
Type: string

Arn of blueprint.

stage
Type: string

Stage of blueprint.

version
Type: string

Version of blueprint.

DataAutomationConfiguration

Description

Data automation configuration.

Members
dataAutomationProjectArn
Required: Yes
Type: string

Data automation project arn.

stage
Type: string

Data automation stage.

EncryptionConfiguration

Description

Encryption configuration.

Members
kmsEncryptionContext
Type: Associative array of custom strings keys (EncryptionContextKey) to strings

KMS encryption context.

kmsKeyId
Required: Yes
Type: string

Customer KMS key used for encryption

EventBridgeConfiguration

Description

Event bridge configuration.

Members
eventBridgeEnabled
Required: Yes
Type: boolean

Event bridge flag.

InputConfiguration

Description

Input configuration.

Members
assetProcessingConfiguration
Type: AssetProcessingConfiguration structure

Asset processing configuration

s3Uri
Required: Yes
Type: string

S3 uri.

InternalServerException

Description

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

Members
message
Type: string

NotificationConfiguration

Description

Notification configuration.

Members
eventBridgeConfiguration
Required: Yes
Type: EventBridgeConfiguration structure

Event bridge configuration.

OutputConfiguration

Description

Output configuration.

Members
s3Uri
Required: Yes
Type: string

S3 uri.

ResourceNotFoundException

Description

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

Members
message
Type: string

ServiceQuotaExceededException

Description

This exception will be thrown when service quota is exceeded.

Members
message
Type: string

Tag

Description

Key value pair of a tag

Members
key
Required: Yes
Type: string

Defines the context of the tag.

value
Required: Yes
Type: string

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

ThrottlingException

Description

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

Members
message
Type: string

TimestampSegment

Description

Timestamp segment

Members
endTimeMillis
Required: Yes
Type: long (int|float)

End timestamp in milliseconds

startTimeMillis
Required: Yes
Type: long (int|float)

Start timestamp in milliseconds

ValidationException

Description

This exception will be thrown when customer provided invalid parameters.

Members
message
Type: string

VideoAssetProcessingConfiguration

Description

Video asset processing configuration

Members
segmentConfiguration
Type: VideoSegmentConfiguration structure

Delimits the segment of the input that will be processed

VideoSegmentConfiguration

Description

Delimits the segment of the input that will be processed

Members
timestampSegment
Type: TimestampSegment structure

Timestamp segment