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.

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

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

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

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

$result = $client->invokeDataAutomationAsync([
    'blueprints' => [
        [
            'blueprintArn' => '<string>', // REQUIRED
            'stage' => 'DEVELOPMENT|LIVE',
            'version' => '<string>',
        ],
        // ...
    ],
    'clientToken' => '<string>',
    'dataAutomationConfiguration' => [
        'dataAutomationArn' => '<string>', // REQUIRED
        'stage' => 'LIVE|DEVELOPMENT',
    ],
    'encryptionConfiguration' => [
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>', // REQUIRED
    ],
    'inputConfiguration' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
    'notificationConfiguration' => [
        'eventBridgeConfiguration' => [ // REQUIRED
            'eventBridgeEnabled' => true || false, // REQUIRED
        ],
    ],
    'outputConfiguration' => [ // REQUIRED
        's3Uri' => '<string>', // REQUIRED
    ],
]);

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