BatchDeleteRecipeVersion

$result = $client->batchDeleteRecipeVersion([/* ... */]);
$promise = $client->batchDeleteRecipeVersionAsync([/* ... */]);

Deletes one or more versions of a recipe at a time.

The entire request will be rejected if:

• The recipe does not exist.

• There is an invalid version identifier in the list of versions.

• The version list is empty.

• The version list size exceeds 50.

• The version list contains duplicate entries.

The request will complete successfully, but with partial failures, if:

• A version does not exist.

• A version is being used by a job.

• You specify LATEST_WORKING, but it's being used by a project.

• The version fails to be deleted.

The LATEST_WORKING version will only be deleted if the recipe has no other versions. If you try to delete LATEST_WORKING while other versions exist (or if they can't be deleted), then LATEST_WORKING will be listed as partial failure in the response.

Parameter Syntax

$result = $client->batchDeleteRecipeVersion([
    'Name' => '<string>', // REQUIRED
    'RecipeVersions' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'RecipeVersion' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

CreateDataset

$result = $client->createDataset([/* ... */]);
$promise = $client->createDatasetAsync([/* ... */]);

Creates a new DataBrew dataset.

Parameter Syntax

$result = $client->createDataset([
    'Format' => 'CSV|JSON|PARQUET|EXCEL|ORC',
    'FormatOptions' => [
        'Csv' => [
            'Delimiter' => '<string>',
            'HeaderRow' => true || false,
        ],
        'Excel' => [
            'HeaderRow' => true || false,
            'SheetIndexes' => [<integer>, ...],
            'SheetNames' => ['<string>', ...],
        ],
        'Json' => [
            'MultiLine' => true || false,
        ],
    ],
    'Input' => [ // REQUIRED
        'DataCatalogInputDefinition' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'TableName' => '<string>', // REQUIRED
            'TempDirectory' => [
                'Bucket' => '<string>', // REQUIRED
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
        ],
        'DatabaseInputDefinition' => [
            'DatabaseTableName' => '<string>',
            'GlueConnectionName' => '<string>', // REQUIRED
            'QueryString' => '<string>',
            'TempDirectory' => [
                'Bucket' => '<string>', // REQUIRED
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
        ],
        'Metadata' => [
            'SourceArn' => '<string>',
        ],
        'S3InputDefinition' => [
            'Bucket' => '<string>', // REQUIRED
            'BucketOwner' => '<string>',
            'Key' => '<string>',
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'PathOptions' => [
        'FilesLimit' => [
            'MaxFiles' => <integer>, // REQUIRED
            'Order' => 'DESCENDING|ASCENDING',
            'OrderedBy' => 'LAST_MODIFIED_DATE',
        ],
        'LastModifiedDateCondition' => [
            'Expression' => '<string>', // REQUIRED
            'ValuesMap' => ['<string>', ...], // REQUIRED
        ],
        'Parameters' => [
            '<PathParameterName>' => [
                'CreateColumn' => true || false,
                'DatetimeOptions' => [
                    'Format' => '<string>', // REQUIRED
                    'LocaleCode' => '<string>',
                    'TimezoneOffset' => '<string>',
                ],
                'Filter' => [
                    'Expression' => '<string>', // REQUIRED
                    'ValuesMap' => ['<string>', ...], // REQUIRED
                ],
                'Name' => '<string>', // REQUIRED
                'Type' => 'Datetime|Number|String', // REQUIRED
            ],
            // ...
        ],
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

Access to the specified resource was denied.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

CreateProfileJob

$result = $client->createProfileJob([/* ... */]);
$promise = $client->createProfileJobAsync([/* ... */]);

Creates a new job to analyze a dataset and create its data profile.

Parameter Syntax

$result = $client->createProfileJob([
    'Configuration' => [
        'ColumnStatisticsConfigurations' => [
            [
                'Selectors' => [
                    [
                        'Name' => '<string>',
                        'Regex' => '<string>',
                    ],
                    // ...
                ],
                'Statistics' => [ // REQUIRED
                    'IncludedStatistics' => ['<string>', ...],
                    'Overrides' => [
                        [
                            'Parameters' => ['<string>', ...], // REQUIRED
                            'Statistic' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        'DatasetStatisticsConfiguration' => [
            'IncludedStatistics' => ['<string>', ...],
            'Overrides' => [
                [
                    'Parameters' => ['<string>', ...], // REQUIRED
                    'Statistic' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'EntityDetectorConfiguration' => [
            'AllowedStatistics' => [
                [
                    'Statistics' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'EntityTypes' => ['<string>', ...], // REQUIRED
        ],
        'ProfileColumns' => [
            [
                'Name' => '<string>',
                'Regex' => '<string>',
            ],
            // ...
        ],
    ],
    'DatasetName' => '<string>', // REQUIRED
    'EncryptionKeyArn' => '<string>',
    'EncryptionMode' => 'SSE-KMS|SSE-S3',
    'JobSample' => [
        'Mode' => 'FULL_DATASET|CUSTOM_ROWS',
        'Size' => <integer>,
    ],
    'LogSubscription' => 'ENABLE|DISABLE',
    'MaxCapacity' => <integer>,
    'MaxRetries' => <integer>,
    'Name' => '<string>', // REQUIRED
    'OutputLocation' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'BucketOwner' => '<string>',
        'Key' => '<string>',
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Timeout' => <integer>,
    'ValidationConfigurations' => [
        [
            'RulesetArn' => '<string>', // REQUIRED
            'ValidationMode' => 'CHECK_ALL',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

Access to the specified resource was denied.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

CreateProject

$result = $client->createProject([/* ... */]);
$promise = $client->createProjectAsync([/* ... */]);

Creates a new DataBrew project.

Parameter Syntax

$result = $client->createProject([
    'DatasetName' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RecipeName' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Sample' => [
        'Size' => <integer>,
        'Type' => 'FIRST_N|LAST_N|RANDOM', // REQUIRED
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

InternalServerException:

An internal service failure occurred.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

CreateRecipe

$result = $client->createRecipe([/* ... */]);
$promise = $client->createRecipeAsync([/* ... */]);

Creates a new DataBrew recipe.

Parameter Syntax

$result = $client->createRecipe([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Steps' => [ // REQUIRED
        [
            'Action' => [ // REQUIRED
                'Operation' => '<string>', // REQUIRED
                'Parameters' => ['<string>', ...],
            ],
            'ConditionExpressions' => [
                [
                    'Condition' => '<string>', // REQUIRED
                    'TargetColumn' => '<string>', // REQUIRED
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

CreateRecipeJob

$result = $client->createRecipeJob([/* ... */]);
$promise = $client->createRecipeJobAsync([/* ... */]);

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

Parameter Syntax

$result = $client->createRecipeJob([
    'DataCatalogOutputs' => [
        [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'DatabaseOptions' => [
                'TableName' => '<string>', // REQUIRED
                'TempDirectory' => [
                    'Bucket' => '<string>', // REQUIRED
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'Overwrite' => true || false,
            'S3Options' => [
                'Location' => [ // REQUIRED
                    'Bucket' => '<string>', // REQUIRED
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'TableName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DatabaseOutputs' => [
        [
            'DatabaseOptions' => [ // REQUIRED
                'TableName' => '<string>', // REQUIRED
                'TempDirectory' => [
                    'Bucket' => '<string>', // REQUIRED
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'DatabaseOutputMode' => 'NEW_TABLE',
            'GlueConnectionName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DatasetName' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'EncryptionMode' => 'SSE-KMS|SSE-S3',
    'LogSubscription' => 'ENABLE|DISABLE',
    'MaxCapacity' => <integer>,
    'MaxRetries' => <integer>,
    'Name' => '<string>', // REQUIRED
    'Outputs' => [
        [
            'CompressionFormat' => 'GZIP|LZ4|SNAPPY|BZIP2|DEFLATE|LZO|BROTLI|ZSTD|ZLIB',
            'Format' => 'CSV|JSON|PARQUET|GLUEPARQUET|AVRO|ORC|XML|TABLEAUHYPER',
            'FormatOptions' => [
                'Csv' => [
                    'Delimiter' => '<string>',
                ],
            ],
            'Location' => [ // REQUIRED
                'Bucket' => '<string>', // REQUIRED
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
            'MaxOutputFiles' => <integer>,
            'Overwrite' => true || false,
            'PartitionColumns' => ['<string>', ...],
        ],
        // ...
    ],
    'ProjectName' => '<string>',
    'RecipeReference' => [
        'Name' => '<string>', // REQUIRED
        'RecipeVersion' => '<string>',
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'Timeout' => <integer>,
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

Access to the specified resource was denied.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

CreateRuleset

$result = $client->createRuleset([/* ... */]);
$promise = $client->createRulesetAsync([/* ... */]);

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

Parameter Syntax

$result = $client->createRuleset([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Rules' => [ // REQUIRED
        [
            'CheckExpression' => '<string>', // REQUIRED
            'ColumnSelectors' => [
                [
                    'Name' => '<string>',
                    'Regex' => '<string>',
                ],
                // ...
            ],
            'Disabled' => true || false,
            'Name' => '<string>', // REQUIRED
            'SubstitutionMap' => ['<string>', ...],
            'Threshold' => [
                'Type' => 'GREATER_THAN_OR_EQUAL|LESS_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN',
                'Unit' => 'COUNT|PERCENTAGE',
                'Value' => <float>, // REQUIRED
            ],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
    'TargetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

CreateSchedule

$result = $client->createSchedule([/* ... */]);
$promise = $client->createScheduleAsync([/* ... */]);

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

Parameter Syntax

$result = $client->createSchedule([
    'CronExpression' => '<string>', // REQUIRED
    'JobNames' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

DeleteDataset

$result = $client->deleteDataset([/* ... */]);
$promise = $client->deleteDatasetAsync([/* ... */]);

Deletes a dataset from DataBrew.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DeleteJob

$result = $client->deleteJob([/* ... */]);
$promise = $client->deleteJobAsync([/* ... */]);

Deletes the specified DataBrew job.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DeleteProject

$result = $client->deleteProject([/* ... */]);
$promise = $client->deleteProjectAsync([/* ... */]);

Deletes an existing DataBrew project.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DeleteRecipeVersion

$result = $client->deleteRecipeVersion([/* ... */]);
$promise = $client->deleteRecipeVersionAsync([/* ... */]);

Deletes a single version of a DataBrew recipe.

Parameter Syntax

$result = $client->deleteRecipeVersion([
    'Name' => '<string>', // REQUIRED
    'RecipeVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Name' => '<string>',
    'RecipeVersion' => '<string>',
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DeleteRuleset

$result = $client->deleteRuleset([/* ... */]);
$promise = $client->deleteRulesetAsync([/* ... */]);

Deletes a ruleset.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

DeleteSchedule

$result = $client->deleteSchedule([/* ... */]);
$promise = $client->deleteScheduleAsync([/* ... */]);

Deletes the specified DataBrew schedule.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DescribeDataset

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

Returns the definition of a specific DataBrew dataset.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreateDate' => <DateTime>,
    'CreatedBy' => '<string>',
    'Format' => 'CSV|JSON|PARQUET|EXCEL|ORC',
    'FormatOptions' => [
        'Csv' => [
            'Delimiter' => '<string>',
            'HeaderRow' => true || false,
        ],
        'Excel' => [
            'HeaderRow' => true || false,
            'SheetIndexes' => [<integer>, ...],
            'SheetNames' => ['<string>', ...],
        ],
        'Json' => [
            'MultiLine' => true || false,
        ],
    ],
    'Input' => [
        'DataCatalogInputDefinition' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>',
            'TableName' => '<string>',
            'TempDirectory' => [
                'Bucket' => '<string>',
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
        ],
        'DatabaseInputDefinition' => [
            'DatabaseTableName' => '<string>',
            'GlueConnectionName' => '<string>',
            'QueryString' => '<string>',
            'TempDirectory' => [
                'Bucket' => '<string>',
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
        ],
        'Metadata' => [
            'SourceArn' => '<string>',
        ],
        'S3InputDefinition' => [
            'Bucket' => '<string>',
            'BucketOwner' => '<string>',
            'Key' => '<string>',
        ],
    ],
    'LastModifiedBy' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'PathOptions' => [
        'FilesLimit' => [
            'MaxFiles' => <integer>,
            'Order' => 'DESCENDING|ASCENDING',
            'OrderedBy' => 'LAST_MODIFIED_DATE',
        ],
        'LastModifiedDateCondition' => [
            'Expression' => '<string>',
            'ValuesMap' => ['<string>', ...],
        ],
        'Parameters' => [
            '<PathParameterName>' => [
                'CreateColumn' => true || false,
                'DatetimeOptions' => [
                    'Format' => '<string>',
                    'LocaleCode' => '<string>',
                    'TimezoneOffset' => '<string>',
                ],
                'Filter' => [
                    'Expression' => '<string>',
                    'ValuesMap' => ['<string>', ...],
                ],
                'Name' => '<string>',
                'Type' => 'Datetime|Number|String',
            ],
            // ...
        ],
    ],
    'ResourceArn' => '<string>',
    'Source' => 'S3|DATA-CATALOG|DATABASE',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DescribeJob

$result = $client->describeJob([/* ... */]);
$promise = $client->describeJobAsync([/* ... */]);

Returns the definition of a specific DataBrew job.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreateDate' => <DateTime>,
    'CreatedBy' => '<string>',
    'DataCatalogOutputs' => [
        [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>',
            'DatabaseOptions' => [
                'TableName' => '<string>',
                'TempDirectory' => [
                    'Bucket' => '<string>',
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'Overwrite' => true || false,
            'S3Options' => [
                'Location' => [
                    'Bucket' => '<string>',
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'TableName' => '<string>',
        ],
        // ...
    ],
    'DatabaseOutputs' => [
        [
            'DatabaseOptions' => [
                'TableName' => '<string>',
                'TempDirectory' => [
                    'Bucket' => '<string>',
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'DatabaseOutputMode' => 'NEW_TABLE',
            'GlueConnectionName' => '<string>',
        ],
        // ...
    ],
    'DatasetName' => '<string>',
    'EncryptionKeyArn' => '<string>',
    'EncryptionMode' => 'SSE-KMS|SSE-S3',
    'JobSample' => [
        'Mode' => 'FULL_DATASET|CUSTOM_ROWS',
        'Size' => <integer>,
    ],
    'LastModifiedBy' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'LogSubscription' => 'ENABLE|DISABLE',
    'MaxCapacity' => <integer>,
    'MaxRetries' => <integer>,
    'Name' => '<string>',
    'Outputs' => [
        [
            'CompressionFormat' => 'GZIP|LZ4|SNAPPY|BZIP2|DEFLATE|LZO|BROTLI|ZSTD|ZLIB',
            'Format' => 'CSV|JSON|PARQUET|GLUEPARQUET|AVRO|ORC|XML|TABLEAUHYPER',
            'FormatOptions' => [
                'Csv' => [
                    'Delimiter' => '<string>',
                ],
            ],
            'Location' => [
                'Bucket' => '<string>',
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
            'MaxOutputFiles' => <integer>,
            'Overwrite' => true || false,
            'PartitionColumns' => ['<string>', ...],
        ],
        // ...
    ],
    'ProfileConfiguration' => [
        'ColumnStatisticsConfigurations' => [
            [
                'Selectors' => [
                    [
                        'Name' => '<string>',
                        'Regex' => '<string>',
                    ],
                    // ...
                ],
                'Statistics' => [
                    'IncludedStatistics' => ['<string>', ...],
                    'Overrides' => [
                        [
                            'Parameters' => ['<string>', ...],
                            'Statistic' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        'DatasetStatisticsConfiguration' => [
            'IncludedStatistics' => ['<string>', ...],
            'Overrides' => [
                [
                    'Parameters' => ['<string>', ...],
                    'Statistic' => '<string>',
                ],
                // ...
            ],
        ],
        'EntityDetectorConfiguration' => [
            'AllowedStatistics' => [
                [
                    'Statistics' => ['<string>', ...],
                ],
                // ...
            ],
            'EntityTypes' => ['<string>', ...],
        ],
        'ProfileColumns' => [
            [
                'Name' => '<string>',
                'Regex' => '<string>',
            ],
            // ...
        ],
    ],
    'ProjectName' => '<string>',
    'RecipeReference' => [
        'Name' => '<string>',
        'RecipeVersion' => '<string>',
    ],
    'ResourceArn' => '<string>',
    'RoleArn' => '<string>',
    'Tags' => ['<string>', ...],
    'Timeout' => <integer>,
    'Type' => 'PROFILE|RECIPE',
    'ValidationConfigurations' => [
        [
            'RulesetArn' => '<string>',
            'ValidationMode' => 'CHECK_ALL',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DescribeJobRun

$result = $client->describeJobRun([/* ... */]);
$promise = $client->describeJobRunAsync([/* ... */]);

Represents one run of a DataBrew job.

Parameter Syntax

$result = $client->describeJobRun([
    'Name' => '<string>', // REQUIRED
    'RunId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attempt' => <integer>,
    'CompletedOn' => <DateTime>,
    'DataCatalogOutputs' => [
        [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>',
            'DatabaseOptions' => [
                'TableName' => '<string>',
                'TempDirectory' => [
                    'Bucket' => '<string>',
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'Overwrite' => true || false,
            'S3Options' => [
                'Location' => [
                    'Bucket' => '<string>',
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'TableName' => '<string>',
        ],
        // ...
    ],
    'DatabaseOutputs' => [
        [
            'DatabaseOptions' => [
                'TableName' => '<string>',
                'TempDirectory' => [
                    'Bucket' => '<string>',
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'DatabaseOutputMode' => 'NEW_TABLE',
            'GlueConnectionName' => '<string>',
        ],
        // ...
    ],
    'DatasetName' => '<string>',
    'ErrorMessage' => '<string>',
    'ExecutionTime' => <integer>,
    'JobName' => '<string>',
    'JobSample' => [
        'Mode' => 'FULL_DATASET|CUSTOM_ROWS',
        'Size' => <integer>,
    ],
    'LogGroupName' => '<string>',
    'LogSubscription' => 'ENABLE|DISABLE',
    'Outputs' => [
        [
            'CompressionFormat' => 'GZIP|LZ4|SNAPPY|BZIP2|DEFLATE|LZO|BROTLI|ZSTD|ZLIB',
            'Format' => 'CSV|JSON|PARQUET|GLUEPARQUET|AVRO|ORC|XML|TABLEAUHYPER',
            'FormatOptions' => [
                'Csv' => [
                    'Delimiter' => '<string>',
                ],
            ],
            'Location' => [
                'Bucket' => '<string>',
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
            'MaxOutputFiles' => <integer>,
            'Overwrite' => true || false,
            'PartitionColumns' => ['<string>', ...],
        ],
        // ...
    ],
    'ProfileConfiguration' => [
        'ColumnStatisticsConfigurations' => [
            [
                'Selectors' => [
                    [
                        'Name' => '<string>',
                        'Regex' => '<string>',
                    ],
                    // ...
                ],
                'Statistics' => [
                    'IncludedStatistics' => ['<string>', ...],
                    'Overrides' => [
                        [
                            'Parameters' => ['<string>', ...],
                            'Statistic' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        'DatasetStatisticsConfiguration' => [
            'IncludedStatistics' => ['<string>', ...],
            'Overrides' => [
                [
                    'Parameters' => ['<string>', ...],
                    'Statistic' => '<string>',
                ],
                // ...
            ],
        ],
        'EntityDetectorConfiguration' => [
            'AllowedStatistics' => [
                [
                    'Statistics' => ['<string>', ...],
                ],
                // ...
            ],
            'EntityTypes' => ['<string>', ...],
        ],
        'ProfileColumns' => [
            [
                'Name' => '<string>',
                'Regex' => '<string>',
            ],
            // ...
        ],
    ],
    'RecipeReference' => [
        'Name' => '<string>',
        'RecipeVersion' => '<string>',
    ],
    'RunId' => '<string>',
    'StartedBy' => '<string>',
    'StartedOn' => <DateTime>,
    'State' => 'STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT',
    'ValidationConfigurations' => [
        [
            'RulesetArn' => '<string>',
            'ValidationMode' => 'CHECK_ALL',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DescribeProject

$result = $client->describeProject([/* ... */]);
$promise = $client->describeProjectAsync([/* ... */]);

Returns the definition of a specific DataBrew project.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreateDate' => <DateTime>,
    'CreatedBy' => '<string>',
    'DatasetName' => '<string>',
    'LastModifiedBy' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'OpenDate' => <DateTime>,
    'OpenedBy' => '<string>',
    'RecipeName' => '<string>',
    'ResourceArn' => '<string>',
    'RoleArn' => '<string>',
    'Sample' => [
        'Size' => <integer>,
        'Type' => 'FIRST_N|LAST_N|RANDOM',
    ],
    'SessionStatus' => 'ASSIGNED|FAILED|INITIALIZING|PROVISIONING|READY|RECYCLING|ROTATING|TERMINATED|TERMINATING|UPDATING',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DescribeRecipe

$result = $client->describeRecipe([/* ... */]);
$promise = $client->describeRecipeAsync([/* ... */]);

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

Parameter Syntax

$result = $client->describeRecipe([
    'Name' => '<string>', // REQUIRED
    'RecipeVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CreateDate' => <DateTime>,
    'CreatedBy' => '<string>',
    'Description' => '<string>',
    'LastModifiedBy' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'ProjectName' => '<string>',
    'PublishedBy' => '<string>',
    'PublishedDate' => <DateTime>,
    'RecipeVersion' => '<string>',
    'ResourceArn' => '<string>',
    'Steps' => [
        [
            'Action' => [
                'Operation' => '<string>',
                'Parameters' => ['<string>', ...],
            ],
            'ConditionExpressions' => [
                [
                    'Condition' => '<string>',
                    'TargetColumn' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DescribeRuleset

$result = $client->describeRuleset([/* ... */]);
$promise = $client->describeRulesetAsync([/* ... */]);

Retrieves detailed information about the ruleset.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreateDate' => <DateTime>,
    'CreatedBy' => '<string>',
    'Description' => '<string>',
    'LastModifiedBy' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'ResourceArn' => '<string>',
    'Rules' => [
        [
            'CheckExpression' => '<string>',
            'ColumnSelectors' => [
                [
                    'Name' => '<string>',
                    'Regex' => '<string>',
                ],
                // ...
            ],
            'Disabled' => true || false,
            'Name' => '<string>',
            'SubstitutionMap' => ['<string>', ...],
            'Threshold' => [
                'Type' => 'GREATER_THAN_OR_EQUAL|LESS_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN',
                'Unit' => 'COUNT|PERCENTAGE',
                'Value' => <float>,
            ],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
    'TargetArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

DescribeSchedule

$result = $client->describeSchedule([/* ... */]);
$promise = $client->describeScheduleAsync([/* ... */]);

Returns the definition of a specific DataBrew schedule.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreateDate' => <DateTime>,
    'CreatedBy' => '<string>',
    'CronExpression' => '<string>',
    'JobNames' => ['<string>', ...],
    'LastModifiedBy' => '<string>',
    'LastModifiedDate' => <DateTime>,
    'Name' => '<string>',
    'ResourceArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

ListDatasets

$result = $client->listDatasets([/* ... */]);
$promise = $client->listDatasetsAsync([/* ... */]);

Lists all of the DataBrew datasets.

Parameter Syntax

$result = $client->listDatasets([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Datasets' => [
        [
            'AccountId' => '<string>',
            'CreateDate' => <DateTime>,
            'CreatedBy' => '<string>',
            'Format' => 'CSV|JSON|PARQUET|EXCEL|ORC',
            'FormatOptions' => [
                'Csv' => [
                    'Delimiter' => '<string>',
                    'HeaderRow' => true || false,
                ],
                'Excel' => [
                    'HeaderRow' => true || false,
                    'SheetIndexes' => [<integer>, ...],
                    'SheetNames' => ['<string>', ...],
                ],
                'Json' => [
                    'MultiLine' => true || false,
                ],
            ],
            'Input' => [
                'DataCatalogInputDefinition' => [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>',
                    'TableName' => '<string>',
                    'TempDirectory' => [
                        'Bucket' => '<string>',
                        'BucketOwner' => '<string>',
                        'Key' => '<string>',
                    ],
                ],
                'DatabaseInputDefinition' => [
                    'DatabaseTableName' => '<string>',
                    'GlueConnectionName' => '<string>',
                    'QueryString' => '<string>',
                    'TempDirectory' => [
                        'Bucket' => '<string>',
                        'BucketOwner' => '<string>',
                        'Key' => '<string>',
                    ],
                ],
                'Metadata' => [
                    'SourceArn' => '<string>',
                ],
                'S3InputDefinition' => [
                    'Bucket' => '<string>',
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'PathOptions' => [
                'FilesLimit' => [
                    'MaxFiles' => <integer>,
                    'Order' => 'DESCENDING|ASCENDING',
                    'OrderedBy' => 'LAST_MODIFIED_DATE',
                ],
                'LastModifiedDateCondition' => [
                    'Expression' => '<string>',
                    'ValuesMap' => ['<string>', ...],
                ],
                'Parameters' => [
                    '<PathParameterName>' => [
                        'CreateColumn' => true || false,
                        'DatetimeOptions' => [
                            'Format' => '<string>',
                            'LocaleCode' => '<string>',
                            'TimezoneOffset' => '<string>',
                        ],
                        'Filter' => [
                            'Expression' => '<string>',
                            'ValuesMap' => ['<string>', ...],
                        ],
                        'Name' => '<string>',
                        'Type' => 'Datetime|Number|String',
                    ],
                    // ...
                ],
            ],
            'ResourceArn' => '<string>',
            'Source' => 'S3|DATA-CATALOG|DATABASE',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ListJobRuns

$result = $client->listJobRuns([/* ... */]);
$promise = $client->listJobRunsAsync([/* ... */]);

Lists all of the previous runs of a particular DataBrew job.

Parameter Syntax

$result = $client->listJobRuns([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'JobRuns' => [
        [
            'Attempt' => <integer>,
            'CompletedOn' => <DateTime>,
            'DataCatalogOutputs' => [
                [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>',
                    'DatabaseOptions' => [
                        'TableName' => '<string>',
                        'TempDirectory' => [
                            'Bucket' => '<string>',
                            'BucketOwner' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'Overwrite' => true || false,
                    'S3Options' => [
                        'Location' => [
                            'Bucket' => '<string>',
                            'BucketOwner' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'TableName' => '<string>',
                ],
                // ...
            ],
            'DatabaseOutputs' => [
                [
                    'DatabaseOptions' => [
                        'TableName' => '<string>',
                        'TempDirectory' => [
                            'Bucket' => '<string>',
                            'BucketOwner' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'DatabaseOutputMode' => 'NEW_TABLE',
                    'GlueConnectionName' => '<string>',
                ],
                // ...
            ],
            'DatasetName' => '<string>',
            'ErrorMessage' => '<string>',
            'ExecutionTime' => <integer>,
            'JobName' => '<string>',
            'JobSample' => [
                'Mode' => 'FULL_DATASET|CUSTOM_ROWS',
                'Size' => <integer>,
            ],
            'LogGroupName' => '<string>',
            'LogSubscription' => 'ENABLE|DISABLE',
            'Outputs' => [
                [
                    'CompressionFormat' => 'GZIP|LZ4|SNAPPY|BZIP2|DEFLATE|LZO|BROTLI|ZSTD|ZLIB',
                    'Format' => 'CSV|JSON|PARQUET|GLUEPARQUET|AVRO|ORC|XML|TABLEAUHYPER',
                    'FormatOptions' => [
                        'Csv' => [
                            'Delimiter' => '<string>',
                        ],
                    ],
                    'Location' => [
                        'Bucket' => '<string>',
                        'BucketOwner' => '<string>',
                        'Key' => '<string>',
                    ],
                    'MaxOutputFiles' => <integer>,
                    'Overwrite' => true || false,
                    'PartitionColumns' => ['<string>', ...],
                ],
                // ...
            ],
            'RecipeReference' => [
                'Name' => '<string>',
                'RecipeVersion' => '<string>',
            ],
            'RunId' => '<string>',
            'StartedBy' => '<string>',
            'StartedOn' => <DateTime>,
            'State' => 'STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT',
            'ValidationConfigurations' => [
                [
                    'RulesetArn' => '<string>',
                    'ValidationMode' => 'CHECK_ALL',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

Lists all of the DataBrew jobs that are defined.

Parameter Syntax

$result = $client->listJobs([
    'DatasetName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProjectName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Jobs' => [
        [
            'AccountId' => '<string>',
            'CreateDate' => <DateTime>,
            'CreatedBy' => '<string>',
            'DataCatalogOutputs' => [
                [
                    'CatalogId' => '<string>',
                    'DatabaseName' => '<string>',
                    'DatabaseOptions' => [
                        'TableName' => '<string>',
                        'TempDirectory' => [
                            'Bucket' => '<string>',
                            'BucketOwner' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'Overwrite' => true || false,
                    'S3Options' => [
                        'Location' => [
                            'Bucket' => '<string>',
                            'BucketOwner' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'TableName' => '<string>',
                ],
                // ...
            ],
            'DatabaseOutputs' => [
                [
                    'DatabaseOptions' => [
                        'TableName' => '<string>',
                        'TempDirectory' => [
                            'Bucket' => '<string>',
                            'BucketOwner' => '<string>',
                            'Key' => '<string>',
                        ],
                    ],
                    'DatabaseOutputMode' => 'NEW_TABLE',
                    'GlueConnectionName' => '<string>',
                ],
                // ...
            ],
            'DatasetName' => '<string>',
            'EncryptionKeyArn' => '<string>',
            'EncryptionMode' => 'SSE-KMS|SSE-S3',
            'JobSample' => [
                'Mode' => 'FULL_DATASET|CUSTOM_ROWS',
                'Size' => <integer>,
            ],
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'LogSubscription' => 'ENABLE|DISABLE',
            'MaxCapacity' => <integer>,
            'MaxRetries' => <integer>,
            'Name' => '<string>',
            'Outputs' => [
                [
                    'CompressionFormat' => 'GZIP|LZ4|SNAPPY|BZIP2|DEFLATE|LZO|BROTLI|ZSTD|ZLIB',
                    'Format' => 'CSV|JSON|PARQUET|GLUEPARQUET|AVRO|ORC|XML|TABLEAUHYPER',
                    'FormatOptions' => [
                        'Csv' => [
                            'Delimiter' => '<string>',
                        ],
                    ],
                    'Location' => [
                        'Bucket' => '<string>',
                        'BucketOwner' => '<string>',
                        'Key' => '<string>',
                    ],
                    'MaxOutputFiles' => <integer>,
                    'Overwrite' => true || false,
                    'PartitionColumns' => ['<string>', ...],
                ],
                // ...
            ],
            'ProjectName' => '<string>',
            'RecipeReference' => [
                'Name' => '<string>',
                'RecipeVersion' => '<string>',
            ],
            'ResourceArn' => '<string>',
            'RoleArn' => '<string>',
            'Tags' => ['<string>', ...],
            'Timeout' => <integer>,
            'Type' => 'PROFILE|RECIPE',
            'ValidationConfigurations' => [
                [
                    'RulesetArn' => '<string>',
                    'ValidationMode' => 'CHECK_ALL',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ListProjects

$result = $client->listProjects([/* ... */]);
$promise = $client->listProjectsAsync([/* ... */]);

Lists all of the DataBrew projects that are defined.

Parameter Syntax

$result = $client->listProjects([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Projects' => [
        [
            'AccountId' => '<string>',
            'CreateDate' => <DateTime>,
            'CreatedBy' => '<string>',
            'DatasetName' => '<string>',
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'OpenDate' => <DateTime>,
            'OpenedBy' => '<string>',
            'RecipeName' => '<string>',
            'ResourceArn' => '<string>',
            'RoleArn' => '<string>',
            'Sample' => [
                'Size' => <integer>,
                'Type' => 'FIRST_N|LAST_N|RANDOM',
            ],
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ListRecipeVersions

$result = $client->listRecipeVersions([/* ... */]);
$promise = $client->listRecipeVersionsAsync([/* ... */]);

Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.

Parameter Syntax

$result = $client->listRecipeVersions([
    'MaxResults' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Recipes' => [
        [
            'CreateDate' => <DateTime>,
            'CreatedBy' => '<string>',
            'Description' => '<string>',
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'ProjectName' => '<string>',
            'PublishedBy' => '<string>',
            'PublishedDate' => <DateTime>,
            'RecipeVersion' => '<string>',
            'ResourceArn' => '<string>',
            'Steps' => [
                [
                    'Action' => [
                        'Operation' => '<string>',
                        'Parameters' => ['<string>', ...],
                    ],
                    'ConditionExpressions' => [
                        [
                            'Condition' => '<string>',
                            'TargetColumn' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ListRecipes

$result = $client->listRecipes([/* ... */]);
$promise = $client->listRecipesAsync([/* ... */]);

Lists all of the DataBrew recipes that are defined.

Parameter Syntax

$result = $client->listRecipes([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RecipeVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Recipes' => [
        [
            'CreateDate' => <DateTime>,
            'CreatedBy' => '<string>',
            'Description' => '<string>',
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'ProjectName' => '<string>',
            'PublishedBy' => '<string>',
            'PublishedDate' => <DateTime>,
            'RecipeVersion' => '<string>',
            'ResourceArn' => '<string>',
            'Steps' => [
                [
                    'Action' => [
                        'Operation' => '<string>',
                        'Parameters' => ['<string>', ...],
                    ],
                    'ConditionExpressions' => [
                        [
                            'Condition' => '<string>',
                            'TargetColumn' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ListRulesets

$result = $client->listRulesets([/* ... */]);
$promise = $client->listRulesetsAsync([/* ... */]);

List all rulesets available in the current account or rulesets associated with a specific resource (dataset).

Parameter Syntax

$result = $client->listRulesets([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TargetArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Rulesets' => [
        [
            'AccountId' => '<string>',
            'CreateDate' => <DateTime>,
            'CreatedBy' => '<string>',
            'Description' => '<string>',
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'ResourceArn' => '<string>',
            'RuleCount' => <integer>,
            'Tags' => ['<string>', ...],
            'TargetArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

ListSchedules

$result = $client->listSchedules([/* ... */]);
$promise = $client->listSchedulesAsync([/* ... */]);

Lists the DataBrew schedules that are defined.

Parameter Syntax

$result = $client->listSchedules([
    'JobName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Schedules' => [
        [
            'AccountId' => '<string>',
            'CreateDate' => <DateTime>,
            'CreatedBy' => '<string>',
            'CronExpression' => '<string>',
            'JobNames' => ['<string>', ...],
            'LastModifiedBy' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'ResourceArn' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ListTagsForResource

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

Lists all the tags for a DataBrew resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An internal service failure occurred.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

PublishRecipe

$result = $client->publishRecipe([/* ... */]);
$promise = $client->publishRecipeAsync([/* ... */]);

Publishes a new version of a DataBrew recipe.

Parameter Syntax

$result = $client->publishRecipe([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ResourceNotFoundException:

One or more resources can't be found.

ServiceQuotaExceededException:

A service quota is exceeded.

SendProjectSessionAction

$result = $client->sendProjectSessionAction([/* ... */]);
$promise = $client->sendProjectSessionActionAsync([/* ... */]);

Performs a recipe step within an interactive DataBrew session that's currently open.

Parameter Syntax

$result = $client->sendProjectSessionAction([
    'ClientSessionId' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Preview' => true || false,
    'RecipeStep' => [
        'Action' => [ // REQUIRED
            'Operation' => '<string>', // REQUIRED
            'Parameters' => ['<string>', ...],
        ],
        'ConditionExpressions' => [
            [
                'Condition' => '<string>', // REQUIRED
                'TargetColumn' => '<string>', // REQUIRED
                'Value' => '<string>',
            ],
            // ...
        ],
    ],
    'StepIndex' => <integer>,
    'ViewFrame' => [
        'Analytics' => 'ENABLE|DISABLE',
        'ColumnRange' => <integer>,
        'HiddenColumns' => ['<string>', ...],
        'RowRange' => <integer>,
        'StartColumnIndex' => <integer>, // REQUIRED
        'StartRowIndex' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'ActionId' => <integer>,
    'Name' => '<string>',
    'Result' => '<string>',
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

StartJobRun

$result = $client->startJobRun([/* ... */]);
$promise = $client->startJobRunAsync([/* ... */]);

Runs a DataBrew job.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

StartProjectSession

$result = $client->startProjectSession([/* ... */]);
$promise = $client->startProjectSessionAsync([/* ... */]);

Creates an interactive session, enabling you to manipulate data in a DataBrew project.

Parameter Syntax

$result = $client->startProjectSession([
    'AssumeControl' => true || false,
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ClientSessionId' => '<string>',
    'Name' => '<string>',
]

Result Details

Errors

ConflictException:

Updating or deleting a resource can cause an inconsistent state.

ResourceNotFoundException:

One or more resources can't be found.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.

StopJobRun

$result = $client->stopJobRun([/* ... */]);
$promise = $client->stopJobRunAsync([/* ... */]);

Stops a particular run of a job.

Parameter Syntax

$result = $client->stopJobRun([
    'Name' => '<string>', // REQUIRED
    'RunId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

TagResource

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

Adds metadata tags to a DataBrew resource, such as a dataset, project, recipe, job, or schedule.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An internal service failure occurred.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

UntagResource

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

Removes metadata tags from a DataBrew resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An internal service failure occurred.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

UpdateDataset

$result = $client->updateDataset([/* ... */]);
$promise = $client->updateDatasetAsync([/* ... */]);

Modifies the definition of an existing DataBrew dataset.

Parameter Syntax

$result = $client->updateDataset([
    'Format' => 'CSV|JSON|PARQUET|EXCEL|ORC',
    'FormatOptions' => [
        'Csv' => [
            'Delimiter' => '<string>',
            'HeaderRow' => true || false,
        ],
        'Excel' => [
            'HeaderRow' => true || false,
            'SheetIndexes' => [<integer>, ...],
            'SheetNames' => ['<string>', ...],
        ],
        'Json' => [
            'MultiLine' => true || false,
        ],
    ],
    'Input' => [ // REQUIRED
        'DataCatalogInputDefinition' => [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'TableName' => '<string>', // REQUIRED
            'TempDirectory' => [
                'Bucket' => '<string>', // REQUIRED
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
        ],
        'DatabaseInputDefinition' => [
            'DatabaseTableName' => '<string>',
            'GlueConnectionName' => '<string>', // REQUIRED
            'QueryString' => '<string>',
            'TempDirectory' => [
                'Bucket' => '<string>', // REQUIRED
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
        ],
        'Metadata' => [
            'SourceArn' => '<string>',
        ],
        'S3InputDefinition' => [
            'Bucket' => '<string>', // REQUIRED
            'BucketOwner' => '<string>',
            'Key' => '<string>',
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'PathOptions' => [
        'FilesLimit' => [
            'MaxFiles' => <integer>, // REQUIRED
            'Order' => 'DESCENDING|ASCENDING',
            'OrderedBy' => 'LAST_MODIFIED_DATE',
        ],
        'LastModifiedDateCondition' => [
            'Expression' => '<string>', // REQUIRED
            'ValuesMap' => ['<string>', ...], // REQUIRED
        ],
        'Parameters' => [
            '<PathParameterName>' => [
                'CreateColumn' => true || false,
                'DatetimeOptions' => [
                    'Format' => '<string>', // REQUIRED
                    'LocaleCode' => '<string>',
                    'TimezoneOffset' => '<string>',
                ],
                'Filter' => [
                    'Expression' => '<string>', // REQUIRED
                    'ValuesMap' => ['<string>', ...], // REQUIRED
                ],
                'Name' => '<string>', // REQUIRED
                'Type' => 'Datetime|Number|String', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

Access to the specified resource was denied.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

UpdateProfileJob

$result = $client->updateProfileJob([/* ... */]);
$promise = $client->updateProfileJobAsync([/* ... */]);

Modifies the definition of an existing profile job.

Parameter Syntax

$result = $client->updateProfileJob([
    'Configuration' => [
        'ColumnStatisticsConfigurations' => [
            [
                'Selectors' => [
                    [
                        'Name' => '<string>',
                        'Regex' => '<string>',
                    ],
                    // ...
                ],
                'Statistics' => [ // REQUIRED
                    'IncludedStatistics' => ['<string>', ...],
                    'Overrides' => [
                        [
                            'Parameters' => ['<string>', ...], // REQUIRED
                            'Statistic' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        'DatasetStatisticsConfiguration' => [
            'IncludedStatistics' => ['<string>', ...],
            'Overrides' => [
                [
                    'Parameters' => ['<string>', ...], // REQUIRED
                    'Statistic' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'EntityDetectorConfiguration' => [
            'AllowedStatistics' => [
                [
                    'Statistics' => ['<string>', ...], // REQUIRED
                ],
                // ...
            ],
            'EntityTypes' => ['<string>', ...], // REQUIRED
        ],
        'ProfileColumns' => [
            [
                'Name' => '<string>',
                'Regex' => '<string>',
            ],
            // ...
        ],
    ],
    'EncryptionKeyArn' => '<string>',
    'EncryptionMode' => 'SSE-KMS|SSE-S3',
    'JobSample' => [
        'Mode' => 'FULL_DATASET|CUSTOM_ROWS',
        'Size' => <integer>,
    ],
    'LogSubscription' => 'ENABLE|DISABLE',
    'MaxCapacity' => <integer>,
    'MaxRetries' => <integer>,
    'Name' => '<string>', // REQUIRED
    'OutputLocation' => [ // REQUIRED
        'Bucket' => '<string>', // REQUIRED
        'BucketOwner' => '<string>',
        'Key' => '<string>',
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Timeout' => <integer>,
    'ValidationConfigurations' => [
        [
            'RulesetArn' => '<string>', // REQUIRED
            'ValidationMode' => 'CHECK_ALL',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

Access to the specified resource was denied.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

UpdateProject

$result = $client->updateProject([/* ... */]);
$promise = $client->updateProjectAsync([/* ... */]);

Modifies the definition of an existing DataBrew project.

Parameter Syntax

$result = $client->updateProject([
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Sample' => [
        'Size' => <integer>,
        'Type' => 'FIRST_N|LAST_N|RANDOM', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'LastModifiedDate' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

UpdateRecipe

$result = $client->updateRecipe([/* ... */]);
$promise = $client->updateRecipeAsync([/* ... */]);

Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.

Parameter Syntax

$result = $client->updateRecipe([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Steps' => [
        [
            'Action' => [ // REQUIRED
                'Operation' => '<string>', // REQUIRED
                'Parameters' => ['<string>', ...],
            ],
            'ConditionExpressions' => [
                [
                    'Condition' => '<string>', // REQUIRED
                    'TargetColumn' => '<string>', // REQUIRED
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input parameters for this request failed validation.

ResourceNotFoundException:

One or more resources can't be found.

UpdateRecipeJob

$result = $client->updateRecipeJob([/* ... */]);
$promise = $client->updateRecipeJobAsync([/* ... */]);

Modifies the definition of an existing DataBrew recipe job.

Parameter Syntax

$result = $client->updateRecipeJob([
    'DataCatalogOutputs' => [
        [
            'CatalogId' => '<string>',
            'DatabaseName' => '<string>', // REQUIRED
            'DatabaseOptions' => [
                'TableName' => '<string>', // REQUIRED
                'TempDirectory' => [
                    'Bucket' => '<string>', // REQUIRED
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'Overwrite' => true || false,
            'S3Options' => [
                'Location' => [ // REQUIRED
                    'Bucket' => '<string>', // REQUIRED
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'TableName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DatabaseOutputs' => [
        [
            'DatabaseOptions' => [ // REQUIRED
                'TableName' => '<string>', // REQUIRED
                'TempDirectory' => [
                    'Bucket' => '<string>', // REQUIRED
                    'BucketOwner' => '<string>',
                    'Key' => '<string>',
                ],
            ],
            'DatabaseOutputMode' => 'NEW_TABLE',
            'GlueConnectionName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'EncryptionKeyArn' => '<string>',
    'EncryptionMode' => 'SSE-KMS|SSE-S3',
    'LogSubscription' => 'ENABLE|DISABLE',
    'MaxCapacity' => <integer>,
    'MaxRetries' => <integer>,
    'Name' => '<string>', // REQUIRED
    'Outputs' => [
        [
            'CompressionFormat' => 'GZIP|LZ4|SNAPPY|BZIP2|DEFLATE|LZO|BROTLI|ZSTD|ZLIB',
            'Format' => 'CSV|JSON|PARQUET|GLUEPARQUET|AVRO|ORC|XML|TABLEAUHYPER',
            'FormatOptions' => [
                'Csv' => [
                    'Delimiter' => '<string>',
                ],
            ],
            'Location' => [ // REQUIRED
                'Bucket' => '<string>', // REQUIRED
                'BucketOwner' => '<string>',
                'Key' => '<string>',
            ],
            'MaxOutputFiles' => <integer>,
            'Overwrite' => true || false,
            'PartitionColumns' => ['<string>', ...],
        ],
        // ...
    ],
    'RoleArn' => '<string>', // REQUIRED
    'Timeout' => <integer>,
]);

Parameter Details

Result Syntax

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

Result Details

Errors

AccessDeniedException:

Access to the specified resource was denied.

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

UpdateRuleset

$result = $client->updateRuleset([/* ... */]);
$promise = $client->updateRulesetAsync([/* ... */]);

Updates specified ruleset.

Parameter Syntax

$result = $client->updateRuleset([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Rules' => [ // REQUIRED
        [
            'CheckExpression' => '<string>', // REQUIRED
            'ColumnSelectors' => [
                [
                    'Name' => '<string>',
                    'Regex' => '<string>',
                ],
                // ...
            ],
            'Disabled' => true || false,
            'Name' => '<string>', // REQUIRED
            'SubstitutionMap' => ['<string>', ...],
            'Threshold' => [
                'Type' => 'GREATER_THAN_OR_EQUAL|LESS_THAN_OR_EQUAL|GREATER_THAN|LESS_THAN',
                'Unit' => 'COUNT|PERCENTAGE',
                'Value' => <float>, // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ValidationException:

The input parameters for this request failed validation.

UpdateSchedule

$result = $client->updateSchedule([/* ... */]);
$promise = $client->updateScheduleAsync([/* ... */]);

Modifies the definition of an existing DataBrew schedule.

Parameter Syntax

$result = $client->updateSchedule([
    'CronExpression' => '<string>', // REQUIRED
    'JobNames' => ['<string>', ...],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

One or more resources can't be found.

ServiceQuotaExceededException:

A service quota is exceeded.

ValidationException:

The input parameters for this request failed validation.