AWS SDK for PHP 3.x

Client: Aws\BedrockDataAutomation\BedrockDataAutomationClient

Service ID: bedrock-data-automation

Version: 2023-07-26

This page describes the parameters and results for the operations of the Data Automation for Amazon Bedrock (2023-07-26), and shows how to use the Aws\BedrockDataAutomation\BedrockDataAutomationClient object to call the described operations. This documentation is specific to the 2023-07-26 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 */).

CreateBlueprint ( array $params = [] ): Creates an Amazon Bedrock Keystone Blueprint
CreateBlueprintVersion ( array $params = [] ): Creates a new version of an existing Amazon Bedrock Keystone Blueprint
CreateDataAutomationProject ( array $params = [] ): Creates an Amazon Bedrock Keystone DataAutomationProject
DeleteBlueprint ( array $params = [] ): Deletes an existing Amazon Bedrock Keystone Blueprint
DeleteDataAutomationProject ( array $params = [] ): Deletes an existing Amazon Bedrock Keystone DataAutomationProject
GetBlueprint ( array $params = [] ): Gets an existing Amazon Bedrock Keystone Blueprint
GetDataAutomationProject ( array $params = [] ): Gets an existing Amazon Bedrock Keystone DataAutomationProject
ListBlueprints ( array $params = [] ): Lists all existing Amazon Bedrock Keystone Blueprints
ListDataAutomationProjects ( array $params = [] ): Lists all existing Amazon Bedrock Keystone DataAutomationProjects
UpdateBlueprint ( array $params = [] ): Updates an existing Amazon Bedrock Blueprint
UpdateDataAutomationProject ( array $params = [] ): Updates an existing Amazon Bedrock DataAutomationProject

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListBlueprints
ListDataAutomationProjects

Operations

CreateBlueprint

$result = $client->createBlueprint([/* ... */]);
$promise = $client->createBlueprintAsync([/* ... */]);

Creates an Amazon Bedrock Keystone Blueprint

Parameter Syntax

$result = $client->createBlueprint([
    'blueprintName' => '<string>', // REQUIRED
    'blueprintStage' => 'DEVELOPMENT|LIVE',
    'clientToken' => '<string>',
    'encryptionConfiguration' => [
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>', // REQUIRED
    ],
    'schema' => '<string>', // REQUIRED
    'type' => 'DOCUMENT|IMAGE', // REQUIRED
]);

Parameter Details

Members

blueprintName

: Required: Yes
: Type: string

Name of the Blueprint

blueprintStage

: Type: string

Stage of the Blueprint

clientToken

: Type: string

Client specified token used for idempotency checks

encryptionConfiguration

: Type: EncryptionConfiguration structure

KMS Encryption Configuration

schema

: Required: Yes
: Type: string

Schema of the blueprint

type

: Required: Yes
: Type: string

Type

Result Syntax

[
    'blueprint' => [
        'blueprintArn' => '<string>',
        'blueprintName' => '<string>',
        'blueprintStage' => 'DEVELOPMENT|LIVE',
        'blueprintVersion' => '<string>',
        'creationTime' => <DateTime>,
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'schema' => '<string>',
        'type' => 'DOCUMENT|IMAGE',
    ],
]

Result Details

Members

blueprint

: Required: Yes
: Type: Blueprint structure

Contains the information of a Blueprint.

Errors

ServiceQuotaExceededException:: This exception is thrown when a request is made beyond the service quota
ValidationException:: This exception is thrown when the request's input validation fails
ConflictException:: This exception is thrown when there is a conflict performing an operation
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions

CreateBlueprintVersion

$result = $client->createBlueprintVersion([/* ... */]);
$promise = $client->createBlueprintVersionAsync([/* ... */]);

Creates a new version of an existing Amazon Bedrock Keystone Blueprint

Parameter Syntax

$result = $client->createBlueprintVersion([
    'blueprintArn' => '<string>', // REQUIRED
    'clientToken' => '<string>',
]);

Parameter Details

Members

blueprintArn

: Required: Yes
: Type: string

ARN generated at the server side when a Blueprint is created

clientToken

: Type: string

Client specified token used for idempotency checks

Result Syntax

[
    'blueprint' => [
        'blueprintArn' => '<string>',
        'blueprintName' => '<string>',
        'blueprintStage' => 'DEVELOPMENT|LIVE',
        'blueprintVersion' => '<string>',
        'creationTime' => <DateTime>,
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'schema' => '<string>',
        'type' => 'DOCUMENT|IMAGE',
    ],
]

Result Details

Members

blueprint

: Required: Yes
: Type: Blueprint structure

Contains the information of a Blueprint.

Errors

ServiceQuotaExceededException:: This exception is thrown when a request is made beyond the service quota
ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

CreateDataAutomationProject

$result = $client->createDataAutomationProject([/* ... */]);
$promise = $client->createDataAutomationProjectAsync([/* ... */]);

Creates an Amazon Bedrock Keystone DataAutomationProject

Parameter Syntax

$result = $client->createDataAutomationProject([
    'clientToken' => '<string>',
    'customOutputConfiguration' => [
        'blueprints' => [
            [
                'blueprintArn' => '<string>', // REQUIRED
                'blueprintStage' => 'DEVELOPMENT|LIVE',
                'blueprintVersion' => '<string>',
            ],
            // ...
        ],
    ],
    'encryptionConfiguration' => [
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>', // REQUIRED
    ],
    'overrideConfiguration' => [
        'document' => [
            'splitter' => [
                'state' => 'ENABLED|DISABLED',
            ],
        ],
    ],
    'projectDescription' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'projectStage' => 'DEVELOPMENT|LIVE',
    'standardOutputConfiguration' => [ // REQUIRED
        'audio' => [
            'extraction' => [
                'category' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
                'types' => ['<string>', ...],
            ],
        ],
        'document' => [
            'extraction' => [
                'boundingBox' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'granularity' => [ // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
            ],
            'outputFormat' => [
                'additionalFileFormat' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'textFormat' => [ // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
        ],
        'image' => [
            'extraction' => [
                'boundingBox' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'category' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
                'types' => ['<string>', ...],
            ],
        ],
        'video' => [
            'extraction' => [
                'boundingBox' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'category' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
                'types' => ['<string>', ...],
            ],
        ],
    ],
]);

Parameter Details

Members

clientToken

: Type: string

Client specified token used for idempotency checks

customOutputConfiguration

: Type: CustomOutputConfiguration structure

Custom output configuration

encryptionConfiguration

: Type: EncryptionConfiguration structure

KMS Encryption Configuration

overrideConfiguration

: Type: OverrideConfiguration structure

Override configuration

projectDescription

: Type: string

Description of the DataAutomationProject

projectName

: Required: Yes
: Type: string

Name of the DataAutomationProject

projectStage

: Type: string

Stage of the Project

standardOutputConfiguration

: Required: Yes
: Type: StandardOutputConfiguration structure

Standard output configuration

Result Syntax

[
    'projectArn' => '<string>',
    'projectStage' => 'DEVELOPMENT|LIVE',
    'status' => 'COMPLETED|IN_PROGRESS|FAILED',
]

Result Details

Members

projectArn

: Required: Yes
: Type: string

ARN of a DataAutomationProject

projectStage

: Type: string

Stage of the Project

status

: Type: string

Status of Data Automation Project

Errors

ServiceQuotaExceededException:: This exception is thrown when a request is made beyond the service quota
ValidationException:: This exception is thrown when the request's input validation fails
ConflictException:: This exception is thrown when there is a conflict performing an operation
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions

DeleteBlueprint

$result = $client->deleteBlueprint([/* ... */]);
$promise = $client->deleteBlueprintAsync([/* ... */]);

Deletes an existing Amazon Bedrock Keystone Blueprint

Parameter Syntax

$result = $client->deleteBlueprint([
    'blueprintArn' => '<string>', // REQUIRED
    'blueprintVersion' => '<string>',
]);

Parameter Details

Members

blueprintArn

: Required: Yes
: Type: string

ARN generated at the server side when a Blueprint is created

blueprintVersion

: Type: string

Optional field to delete a specific Blueprint version

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

DeleteDataAutomationProject

$result = $client->deleteDataAutomationProject([/* ... */]);
$promise = $client->deleteDataAutomationProjectAsync([/* ... */]);

Deletes an existing Amazon Bedrock Keystone DataAutomationProject

Parameter Syntax

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

Parameter Details

Members

projectArn

: Required: Yes
: Type: string

ARN generated at the server side when a DataAutomationProject is created

Result Syntax

[
    'projectArn' => '<string>',
    'status' => 'COMPLETED|IN_PROGRESS|FAILED',
]

Result Details

Members

projectArn

: Required: Yes
: Type: string

ARN of a DataAutomationProject

status

: Type: string

Status of Data Automation Project

Errors

ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

GetBlueprint

$result = $client->getBlueprint([/* ... */]);
$promise = $client->getBlueprintAsync([/* ... */]);

Gets an existing Amazon Bedrock Keystone Blueprint

Parameter Syntax

$result = $client->getBlueprint([
    'blueprintArn' => '<string>', // REQUIRED
    'blueprintStage' => 'DEVELOPMENT|LIVE',
    'blueprintVersion' => '<string>',
]);

Parameter Details

Members

blueprintArn

: Required: Yes
: Type: string

ARN generated at the server side when a Blueprint is created

blueprintStage

: Type: string

Optional field to get a specific Blueprint stage

blueprintVersion

: Type: string

Optional field to get a specific Blueprint version

Result Syntax

[
    'blueprint' => [
        'blueprintArn' => '<string>',
        'blueprintName' => '<string>',
        'blueprintStage' => 'DEVELOPMENT|LIVE',
        'blueprintVersion' => '<string>',
        'creationTime' => <DateTime>,
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'schema' => '<string>',
        'type' => 'DOCUMENT|IMAGE',
    ],
]

Result Details

Members

blueprint

: Required: Yes
: Type: Blueprint structure

Contains the information of a Blueprint.

Errors

ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

GetDataAutomationProject

$result = $client->getDataAutomationProject([/* ... */]);
$promise = $client->getDataAutomationProjectAsync([/* ... */]);

Gets an existing Amazon Bedrock Keystone DataAutomationProject

Parameter Syntax

$result = $client->getDataAutomationProject([
    'projectArn' => '<string>', // REQUIRED
    'projectStage' => 'DEVELOPMENT|LIVE',
]);

Parameter Details

Members

projectArn

: Required: Yes
: Type: string

ARN generated at the server side when a DataAutomationProject is created

projectStage

: Type: string

Optional field to delete a specific DataAutomationProject stage

Result Syntax

[
    'project' => [
        'creationTime' => <DateTime>,
        'customOutputConfiguration' => [
            'blueprints' => [
                [
                    'blueprintArn' => '<string>',
                    'blueprintStage' => 'DEVELOPMENT|LIVE',
                    'blueprintVersion' => '<string>',
                ],
                // ...
            ],
        ],
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'overrideConfiguration' => [
            'document' => [
                'splitter' => [
                    'state' => 'ENABLED|DISABLED',
                ],
            ],
        ],
        'projectArn' => '<string>',
        'projectDescription' => '<string>',
        'projectName' => '<string>',
        'projectStage' => 'DEVELOPMENT|LIVE',
        'standardOutputConfiguration' => [
            'audio' => [
                'extraction' => [
                    'category' => [
                        'state' => 'ENABLED|DISABLED',
                        'types' => ['<string>', ...],
                    ],
                ],
                'generativeField' => [
                    'state' => 'ENABLED|DISABLED',
                    'types' => ['<string>', ...],
                ],
            ],
            'document' => [
                'extraction' => [
                    'boundingBox' => [
                        'state' => 'ENABLED|DISABLED',
                    ],
                    'granularity' => [
                        'types' => ['<string>', ...],
                    ],
                ],
                'generativeField' => [
                    'state' => 'ENABLED|DISABLED',
                ],
                'outputFormat' => [
                    'additionalFileFormat' => [
                        'state' => 'ENABLED|DISABLED',
                    ],
                    'textFormat' => [
                        'types' => ['<string>', ...],
                    ],
                ],
            ],
            'image' => [
                'extraction' => [
                    'boundingBox' => [
                        'state' => 'ENABLED|DISABLED',
                    ],
                    'category' => [
                        'state' => 'ENABLED|DISABLED',
                        'types' => ['<string>', ...],
                    ],
                ],
                'generativeField' => [
                    'state' => 'ENABLED|DISABLED',
                    'types' => ['<string>', ...],
                ],
            ],
            'video' => [
                'extraction' => [
                    'boundingBox' => [
                        'state' => 'ENABLED|DISABLED',
                    ],
                    'category' => [
                        'state' => 'ENABLED|DISABLED',
                        'types' => ['<string>', ...],
                    ],
                ],
                'generativeField' => [
                    'state' => 'ENABLED|DISABLED',
                    'types' => ['<string>', ...],
                ],
            ],
        ],
        'status' => 'COMPLETED|IN_PROGRESS|FAILED',
    ],
]

Result Details

Members

project

: Required: Yes
: Type: DataAutomationProject structure

Contains the information of a DataAutomationProject.

Errors

ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

ListBlueprints

$result = $client->listBlueprints([/* ... */]);
$promise = $client->listBlueprintsAsync([/* ... */]);

Lists all existing Amazon Bedrock Keystone Blueprints

Parameter Syntax

$result = $client->listBlueprints([
    'blueprintArn' => '<string>',
    'blueprintStageFilter' => 'DEVELOPMENT|LIVE|ALL',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectFilter' => [
        'projectArn' => '<string>', // REQUIRED
        'projectStage' => 'DEVELOPMENT|LIVE',
    ],
    'resourceOwner' => 'SERVICE|ACCOUNT',
]);

Parameter Details

Members

blueprintArn

: Type: string

ARN of a Blueprint

blueprintStageFilter

: Type: string

Blueprint Stage filter

maxResults

: Type: int

Max Results

nextToken

: Type: string

Pagination token

projectFilter

: Type: DataAutomationProjectFilter structure

Data Automation Project Filter

resourceOwner

: Type: string

Resource Owner

Result Syntax

[
    'blueprints' => [
        [
            'blueprintArn' => '<string>',
            'blueprintName' => '<string>',
            'blueprintStage' => 'DEVELOPMENT|LIVE',
            'blueprintVersion' => '<string>',
            'creationTime' => <DateTime>,
            'lastModifiedTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members

blueprints

: Required: Yes
: Type: Array of BlueprintSummary structures

List of Blueprints

nextToken

: Type: string

Pagination token

Errors

ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

ListDataAutomationProjects

$result = $client->listDataAutomationProjects([/* ... */]);
$promise = $client->listDataAutomationProjectsAsync([/* ... */]);

Lists all existing Amazon Bedrock Keystone DataAutomationProjects

Parameter Syntax

$result = $client->listDataAutomationProjects([
    'blueprintFilter' => [
        'blueprintArn' => '<string>', // REQUIRED
        'blueprintStage' => 'DEVELOPMENT|LIVE',
        'blueprintVersion' => '<string>',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectStageFilter' => 'DEVELOPMENT|LIVE|ALL',
    'resourceOwner' => 'SERVICE|ACCOUNT',
]);

Parameter Details

Members

blueprintFilter

: Type: BlueprintFilter structure

Blueprint Filter

maxResults

: Type: int

Max Results

nextToken

: Type: string

Pagination token

projectStageFilter

: Type: string

Project Stage filter

resourceOwner

: Type: string

Resource Owner

Result Syntax

[
    'nextToken' => '<string>',
    'projects' => [
        [
            'creationTime' => <DateTime>,
            'projectArn' => '<string>',
            'projectName' => '<string>',
            'projectStage' => 'DEVELOPMENT|LIVE',
        ],
        // ...
    ],
]

Result Details

Members

nextToken

: Type: string

Pagination token

projects

: Required: Yes
: Type: Array of DataAutomationProjectSummary structures

List of DataAutomationProjectSummary

Errors

ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

UpdateBlueprint

$result = $client->updateBlueprint([/* ... */]);
$promise = $client->updateBlueprintAsync([/* ... */]);

Updates an existing Amazon Bedrock Blueprint

Parameter Syntax

$result = $client->updateBlueprint([
    'blueprintArn' => '<string>', // REQUIRED
    'blueprintStage' => 'DEVELOPMENT|LIVE',
    'schema' => '<string>', // REQUIRED
]);

Parameter Details

Members

blueprintArn

: Required: Yes
: Type: string

ARN generated at the server side when a Blueprint is created

blueprintStage

: Type: string

Stage of the Blueprint

schema

: Required: Yes
: Type: string

Schema of the blueprint

Result Syntax

[
    'blueprint' => [
        'blueprintArn' => '<string>',
        'blueprintName' => '<string>',
        'blueprintStage' => 'DEVELOPMENT|LIVE',
        'blueprintVersion' => '<string>',
        'creationTime' => <DateTime>,
        'kmsEncryptionContext' => ['<string>', ...],
        'kmsKeyId' => '<string>',
        'lastModifiedTime' => <DateTime>,
        'schema' => '<string>',
        'type' => 'DOCUMENT|IMAGE',
    ],
]

Result Details

Members

blueprint

: Required: Yes
: Type: Blueprint structure

Contains the information of a Blueprint.

Errors

ConflictException:: This exception is thrown when there is a conflict performing an operation
ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

UpdateDataAutomationProject

$result = $client->updateDataAutomationProject([/* ... */]);
$promise = $client->updateDataAutomationProjectAsync([/* ... */]);

Updates an existing Amazon Bedrock DataAutomationProject

Parameter Syntax

$result = $client->updateDataAutomationProject([
    'customOutputConfiguration' => [
        'blueprints' => [
            [
                'blueprintArn' => '<string>', // REQUIRED
                'blueprintStage' => 'DEVELOPMENT|LIVE',
                'blueprintVersion' => '<string>',
            ],
            // ...
        ],
    ],
    'overrideConfiguration' => [
        'document' => [
            'splitter' => [
                'state' => 'ENABLED|DISABLED',
            ],
        ],
    ],
    'projectArn' => '<string>', // REQUIRED
    'projectDescription' => '<string>',
    'projectStage' => 'DEVELOPMENT|LIVE',
    'standardOutputConfiguration' => [ // REQUIRED
        'audio' => [
            'extraction' => [
                'category' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
                'types' => ['<string>', ...],
            ],
        ],
        'document' => [
            'extraction' => [
                'boundingBox' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'granularity' => [ // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
            ],
            'outputFormat' => [
                'additionalFileFormat' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'textFormat' => [ // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
        ],
        'image' => [
            'extraction' => [
                'boundingBox' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'category' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
                'types' => ['<string>', ...],
            ],
        ],
        'video' => [
            'extraction' => [
                'boundingBox' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                ],
                'category' => [ // REQUIRED
                    'state' => 'ENABLED|DISABLED', // REQUIRED
                    'types' => ['<string>', ...],
                ],
            ],
            'generativeField' => [
                'state' => 'ENABLED|DISABLED', // REQUIRED
                'types' => ['<string>', ...],
            ],
        ],
    ],
]);

Parameter Details

Members

customOutputConfiguration

: Type: CustomOutputConfiguration structure

Custom output configuration

overrideConfiguration

: Type: OverrideConfiguration structure

Override configuration

projectArn

: Required: Yes
: Type: string

ARN generated at the server side when a DataAutomationProject is created

projectDescription

: Type: string

Description of the DataAutomationProject

projectStage

: Type: string

Stage of the Project

standardOutputConfiguration

: Required: Yes
: Type: StandardOutputConfiguration structure

Standard output configuration

Result Syntax

[
    'projectArn' => '<string>',
    'projectStage' => 'DEVELOPMENT|LIVE',
    'status' => 'COMPLETED|IN_PROGRESS|FAILED',
]

Result Details

Members

projectArn

: Required: Yes
: Type: string

ARN of a DataAutomationProject

projectStage

: Type: string

Stage of the Project

status

: Type: string

Status of Data Automation Project

Errors

ConflictException:: This exception is thrown when there is a conflict performing an operation
ValidationException:: This exception is thrown when the request's input validation fails
InternalServerException:: This exception is thrown if there was an unexpected error during processing of request
ThrottlingException:: This exception is thrown when the number of requests exceeds the limit
AccessDeniedException:: This exception is thrown when a request is denied per access permissions
ResourceNotFoundException:: This exception is thrown when a resource referenced by the operation does not exist

Shapes

AccessDeniedException

Description

This exception is thrown when a request is denied per access permissions

Members

message

: Type: string

Non Blank String

AudioExtractionCategory

Description

Category of Audio Extraction

Members

state

: Required: Yes
: Type: string

State

types

: Type: Array of strings

List of Audio Extraction Category Type

AudioStandardExtraction

Description

Standard Extraction Configuration of Audio

Members

category

: Required: Yes
: Type: AudioExtractionCategory structure

Category of Audio Extraction

AudioStandardGenerativeField

Description

Standard Generative Field Configuration of Audio

Members

state

: Required: Yes
: Type: string

State

types

: Type: Array of strings

List of Audio Standard Generative Field Type

AudioStandardOutputConfiguration

Description

Standard Output Configuration of Audio

Members

extraction

: Type: AudioStandardExtraction structure

Standard Extraction Configuration of Audio

generativeField

: Type: AudioStandardGenerativeField structure

Standard Generative Field Configuration of Audio

Blueprint

Description

Contains the information of a Blueprint.

Members

blueprintArn

: Required: Yes
: Type: string

ARN of a Blueprint

blueprintName

: Required: Yes
: Type: string

Name of the Blueprint

blueprintStage

: Type: string

Stage of the Blueprint

blueprintVersion

: Type: string

Blueprint Version

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time Stamp

kmsEncryptionContext

: Type: Associative array of custom strings keys (String) to strings

KMS Encryption Context

kmsKeyId

: Type: string

KMS Key Identifier

lastModifiedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time Stamp

schema

: Required: Yes
: Type: string

Schema of the blueprint

type

: Required: Yes
: Type: string

Type

BlueprintFilter

Description

Blueprint Filter

Members

blueprintArn

: Required: Yes
: Type: string

ARN of a Blueprint

blueprintStage

: Type: string

Stage of the Blueprint

blueprintVersion

: Type: string

Blueprint Version

BlueprintItem

Description

Blueprint Item

Members

blueprintArn

: Required: Yes
: Type: string

ARN of a Blueprint

blueprintStage

: Type: string

Stage of the Blueprint

blueprintVersion

: Type: string

Blueprint Version

BlueprintSummary

Description

Summary of a Blueprint

Members

blueprintArn

: Required: Yes
: Type: string

ARN of a Blueprint

blueprintName

: Type: string

Name of the Blueprint

blueprintStage

: Type: string

Stage of the Blueprint

blueprintVersion

: Type: string

Blueprint Version

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time Stamp

lastModifiedTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time Stamp

ConflictException

Description

This exception is thrown when there is a conflict performing an operation

Members

message

: Type: string

Non Blank String

CustomOutputConfiguration

Description

Custom output configuration

Members

blueprints

: Type: Array of BlueprintItem structures

List of Blueprint Item

DataAutomationProject

Description

Contains the information of a DataAutomationProject.

Members

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time Stamp

customOutputConfiguration

: Type: CustomOutputConfiguration structure

Custom output configuration

kmsEncryptionContext

: Type: Associative array of custom strings keys (String) to strings

KMS Encryption Context

kmsKeyId

: Type: string

KMS Key Identifier

lastModifiedTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time Stamp

overrideConfiguration

: Type: OverrideConfiguration structure

Override configuration

projectArn

: Required: Yes
: Type: string

ARN of a DataAutomationProject

projectDescription

: Type: string

Description of the DataAutomationProject

projectName

: Required: Yes
: Type: string

Name of the DataAutomationProject

projectStage

: Type: string

Stage of the Project

standardOutputConfiguration

: Type: StandardOutputConfiguration structure

Standard output configuration

status

: Required: Yes
: Type: string

Status of Data Automation Project

DataAutomationProjectFilter

Description

Data Automation Project Filter

Members

projectArn

: Required: Yes
: Type: string

ARN of a DataAutomationProject

projectStage

: Type: string

Stage of the Project

DataAutomationProjectSummary

Description

Summary of a DataAutomationProject

Members

creationTime

: Required: Yes
: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time Stamp

projectArn

: Required: Yes
: Type: string

ARN of a DataAutomationProject

projectName

: Type: string

Name of the DataAutomationProject

projectStage

: Type: string

Stage of the Project

DocumentBoundingBox

Description

Bounding Box Configuration of Document Extraction

Members

state

: Required: Yes
: Type: string

State

DocumentExtractionGranularity

Description

Granularity of Document Extraction

Members

types

: Type: Array of strings

List of Document Extraction Granularity Type

DocumentOutputAdditionalFileFormat

Description

Additional File Format of Document Output

Members

state

: Required: Yes
: Type: string

State

DocumentOutputFormat

Description

Output Format of Document

Members

additionalFileFormat

: Required: Yes
: Type: DocumentOutputAdditionalFileFormat structure

Additional File Format of Document Output

textFormat

: Required: Yes
: Type: DocumentOutputTextFormat structure

Text Format of Document Output

DocumentOutputTextFormat

Description

Text Format of Document Output

Members

types

: Type: Array of strings

List of Document Output Text Format Type

DocumentOverrideConfiguration

Description

Override Configuration of Document

Members

splitter

: Type: SplitterConfiguration structure

Configuration of Splitter

DocumentStandardExtraction

Description

Standard Extraction Configuration of Document

Members

boundingBox

: Required: Yes
: Type: DocumentBoundingBox structure

Bounding Box Configuration of Document Extraction

granularity

: Required: Yes
: Type: DocumentExtractionGranularity structure

Granularity of Document Extraction

DocumentStandardGenerativeField

Description

Standard Generative Field Configuration of Document

Members

state

: Required: Yes
: Type: string

State

DocumentStandardOutputConfiguration

Description

Standard Output Configuration of Document

Members

extraction

: Type: DocumentStandardExtraction structure

Standard Extraction Configuration of Document

generativeField

: Type: DocumentStandardGenerativeField structure

Standard Generative Field Configuration of Document

outputFormat

: Type: DocumentOutputFormat structure

Output Format of Document

EncryptionConfiguration

Description

KMS Encryption Configuration

Members

kmsEncryptionContext

: Type: Associative array of custom strings keys (String) to strings

KMS Encryption Context

kmsKeyId

: Required: Yes
: Type: string

KMS Key Identifier

ImageBoundingBox

Description

Bounding Box Configuration of Image Extraction

Members

state

: Required: Yes
: Type: string

State

ImageExtractionCategory

Description

Category of Image Extraction

Members

state

: Required: Yes
: Type: string

State

types

: Type: Array of strings

List of Image Extraction Category

ImageStandardExtraction

Description

Standard Extraction Configuration of Image

Members

boundingBox

: Required: Yes
: Type: ImageBoundingBox structure

Bounding Box Configuration of Image Extraction

category

: Required: Yes
: Type: ImageExtractionCategory structure

Category of Image Extraction

ImageStandardGenerativeField

Description

Standard Generative Field Configuration of Image

Members

state

: Required: Yes
: Type: string

State

types

: Type: Array of strings

List of Image Standard Generative Field Type

ImageStandardOutputConfiguration

Description

Standard Output Configuration of Image

Members

extraction

: Type: ImageStandardExtraction structure

Standard Extraction Configuration of Image

generativeField

: Type: ImageStandardGenerativeField structure

Standard Generative Field Configuration of Image

InternalServerException

Description

This exception is thrown if there was an unexpected error during processing of request

Members

message

: Type: string

Non Blank String

OverrideConfiguration

Description

Override configuration

Members

document

: Type: DocumentOverrideConfiguration structure

Override Configuration of Document

ResourceNotFoundException

Description

This exception is thrown when a resource referenced by the operation does not exist

Members

message

: Type: string

Non Blank String

ServiceQuotaExceededException

Description

This exception is thrown when a request is made beyond the service quota

Members

message

: Type: string

Non Blank String

SplitterConfiguration

Description

Configuration of Splitter

Members

state

: Type: string

State

StandardOutputConfiguration

Description

Standard output configuration

Members

audio

: Type: AudioStandardOutputConfiguration structure

Standard Output Configuration of Audio

document

: Type: DocumentStandardOutputConfiguration structure

Standard Output Configuration of Document

image

: Type: ImageStandardOutputConfiguration structure

Standard Output Configuration of Image

video

: Type: VideoStandardOutputConfiguration structure

Standard Output Configuration of Video

ThrottlingException

Description

This exception is thrown when the number of requests exceeds the limit

Members

message

: Type: string

Non Blank String

ValidationException

Description

This exception is thrown when the request's input validation fails

Members

fieldList

: Type: Array of ValidationExceptionField structures

list of ValidationExceptionField

message

: Type: string

Non Blank String

ValidationExceptionField

Description

Stores information about a field passed inside a request that resulted in an exception

Members

message

: Required: Yes
: Type: string

Non Blank String

name

: Required: Yes
: Type: string

Non Blank String

VideoBoundingBox

Description

Bounding Box Configuration of Video Extraction

Members

state

: Required: Yes
: Type: string

State

VideoExtractionCategory

Description

Category of Video Extraction

Members

state

: Required: Yes
: Type: string

State

types

: Type: Array of strings

List of Video Extraction Category Type

VideoStandardExtraction

Description

Standard Extraction Configuration of Video

Members

boundingBox

: Required: Yes
: Type: VideoBoundingBox structure

Bounding Box Configuration of Video Extraction

category

: Required: Yes
: Type: VideoExtractionCategory structure

Category of Video Extraction

VideoStandardGenerativeField

Description

Standard Generative Field Configuration of Video

Members

state

: Required: Yes
: Type: string

State

types

: Type: Array of strings

List of Video Standard Generative Field Type

VideoStandardOutputConfiguration

Description

Standard Output Configuration of Video

Members

extraction

: Type: VideoStandardExtraction structure

Standard Extraction Configuration of Video

generativeField

: Type: VideoStandardGenerativeField structure

Standard Generative Field Configuration of Video

Data Automation for Amazon Bedrock 2023-07-26

Operation Summary

Paginators

Operations

CreateBlueprint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateBlueprintVersion

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDataAutomationProject

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteBlueprint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteDataAutomationProject

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetBlueprint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetDataAutomationProject

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListBlueprints

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListDataAutomationProjects

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

UpdateBlueprint

Parameter Syntax

Parameter Details

Members

Result Syntax