CreateExport

$result = $client->createExport([/* ... */]);
$promise = $client->createExportAsync([/* ... */]);

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

A DataQuery consists of both a QueryStatement and TableConfigurations.

The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary.

The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

Parameter Syntax

$result = $client->createExport([
    'Export' => [ // REQUIRED
        'DataQuery' => [ // REQUIRED
            'QueryStatement' => '<string>', // REQUIRED
            'TableConfigurations' => [
                '<TableName>' => ['<string>', ...],
                // ...
            ],
        ],
        'Description' => '<string>',
        'DestinationConfigurations' => [ // REQUIRED
            'S3Destination' => [ // REQUIRED
                'S3Bucket' => '<string>', // REQUIRED
                'S3OutputConfigurations' => [ // REQUIRED
                    'Compression' => 'GZIP|PARQUET', // REQUIRED
                    'Format' => 'TEXT_OR_CSV|PARQUET', // REQUIRED
                    'OutputType' => 'CUSTOM', // REQUIRED
                    'Overwrite' => 'CREATE_NEW_REPORT|OVERWRITE_REPORT', // REQUIRED
                ],
                'S3Prefix' => '<string>', // REQUIRED
                'S3Region' => '<string>', // REQUIRED
            ],
        ],
        'ExportArn' => '<string>',
        'Name' => '<string>', // REQUIRED
        'RefreshCadence' => [ // REQUIRED
            'Frequency' => 'SYNCHRONOUS', // REQUIRED
        ],
    ],
    'ResourceTags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ServiceQuotaExceededException:

You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

DeleteExport

$result = $client->deleteExport([/* ... */]);
$promise = $client->deleteExportAsync([/* ... */]);

Deletes an existing data export.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

GetExecution

$result = $client->getExecution([/* ... */]);
$promise = $client->getExecutionAsync([/* ... */]);

Exports data based on the source data update.

Parameter Syntax

$result = $client->getExecution([
    'ExecutionId' => '<string>', // REQUIRED
    'ExportArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExecutionId' => '<string>',
    'ExecutionStatus' => [
        'CompletedAt' => <DateTime>,
        'CreatedAt' => <DateTime>,
        'LastUpdatedAt' => <DateTime>,
        'StatusCode' => 'INITIATION_IN_PROCESS|QUERY_QUEUED|QUERY_IN_PROCESS|QUERY_FAILURE|DELIVERY_IN_PROCESS|DELIVERY_SUCCESS|DELIVERY_FAILURE',
        'StatusReason' => 'INSUFFICIENT_PERMISSION|BILL_OWNER_CHANGED|INTERNAL_FAILURE',
    ],
    'Export' => [
        'DataQuery' => [
            'QueryStatement' => '<string>',
            'TableConfigurations' => [
                '<TableName>' => ['<string>', ...],
                // ...
            ],
        ],
        'Description' => '<string>',
        'DestinationConfigurations' => [
            'S3Destination' => [
                'S3Bucket' => '<string>',
                'S3OutputConfigurations' => [
                    'Compression' => 'GZIP|PARQUET',
                    'Format' => 'TEXT_OR_CSV|PARQUET',
                    'OutputType' => 'CUSTOM',
                    'Overwrite' => 'CREATE_NEW_REPORT|OVERWRITE_REPORT',
                ],
                'S3Prefix' => '<string>',
                'S3Region' => '<string>',
            ],
        ],
        'ExportArn' => '<string>',
        'Name' => '<string>',
        'RefreshCadence' => [
            'Frequency' => 'SYNCHRONOUS',
        ],
    ],
]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

GetExport

$result = $client->getExport([/* ... */]);
$promise = $client->getExportAsync([/* ... */]);

Views the definition of an existing data export.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Export' => [
        'DataQuery' => [
            'QueryStatement' => '<string>',
            'TableConfigurations' => [
                '<TableName>' => ['<string>', ...],
                // ...
            ],
        ],
        'Description' => '<string>',
        'DestinationConfigurations' => [
            'S3Destination' => [
                'S3Bucket' => '<string>',
                'S3OutputConfigurations' => [
                    'Compression' => 'GZIP|PARQUET',
                    'Format' => 'TEXT_OR_CSV|PARQUET',
                    'OutputType' => 'CUSTOM',
                    'Overwrite' => 'CREATE_NEW_REPORT|OVERWRITE_REPORT',
                ],
                'S3Prefix' => '<string>',
                'S3Region' => '<string>',
            ],
        ],
        'ExportArn' => '<string>',
        'Name' => '<string>',
        'RefreshCadence' => [
            'Frequency' => 'SYNCHRONOUS',
        ],
    ],
    'ExportStatus' => [
        'CreatedAt' => <DateTime>,
        'LastRefreshedAt' => <DateTime>,
        'LastUpdatedAt' => <DateTime>,
        'StatusCode' => 'HEALTHY|UNHEALTHY',
        'StatusReason' => 'INSUFFICIENT_PERMISSION|BILL_OWNER_CHANGED|INTERNAL_FAILURE',
    ],
]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

GetTable

$result = $client->getTable([/* ... */]);
$promise = $client->getTableAsync([/* ... */]);

Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.

Parameter Syntax

$result = $client->getTable([
    'TableName' => '<string>', // REQUIRED
    'TableProperties' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Description' => '<string>',
    'Schema' => [
        [
            'Description' => '<string>',
            'Name' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
    'TableName' => '<string>',
    'TableProperties' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListExecutions

$result = $client->listExecutions([/* ... */]);
$promise = $client->listExecutionsAsync([/* ... */]);

Lists the historical executions for the export.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Executions' => [
        [
            'ExecutionId' => '<string>',
            'ExecutionStatus' => [
                'CompletedAt' => <DateTime>,
                'CreatedAt' => <DateTime>,
                'LastUpdatedAt' => <DateTime>,
                'StatusCode' => 'INITIATION_IN_PROCESS|QUERY_QUEUED|QUERY_IN_PROCESS|QUERY_FAILURE|DELIVERY_IN_PROCESS|DELIVERY_SUCCESS|DELIVERY_FAILURE',
                'StatusReason' => 'INSUFFICIENT_PERMISSION|BILL_OWNER_CHANGED|INTERNAL_FAILURE',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListExports

$result = $client->listExports([/* ... */]);
$promise = $client->listExportsAsync([/* ... */]);

Lists all data export definitions.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Exports' => [
        [
            'ExportArn' => '<string>',
            'ExportName' => '<string>',
            'ExportStatus' => [
                'CreatedAt' => <DateTime>,
                'LastRefreshedAt' => <DateTime>,
                'LastUpdatedAt' => <DateTime>,
                'StatusCode' => 'HEALTHY|UNHEALTHY',
                'StatusReason' => 'INSUFFICIENT_PERMISSION|BILL_OWNER_CHANGED|INTERNAL_FAILURE',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListTables

$result = $client->listTables([/* ... */]);
$promise = $client->listTablesAsync([/* ... */]);

Lists all available tables in data exports.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tables' => [
        [
            'Description' => '<string>',
            'TableName' => '<string>',
            'TableProperties' => [
                [
                    'DefaultValue' => '<string>',
                    'Description' => '<string>',
                    'Name' => '<string>',
                    'ValidValues' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ListTagsForResource

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

List tags associated with an existing data export.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ResourceTags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

TagResource

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

Adds tags for an existing data export definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

UntagResource

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

Deletes tags associated with an existing data export definition.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

UpdateExport

$result = $client->updateExport([/* ... */]);
$promise = $client->updateExportAsync([/* ... */]);

Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.

Parameter Syntax

$result = $client->updateExport([
    'Export' => [ // REQUIRED
        'DataQuery' => [ // REQUIRED
            'QueryStatement' => '<string>', // REQUIRED
            'TableConfigurations' => [
                '<TableName>' => ['<string>', ...],
                // ...
            ],
        ],
        'Description' => '<string>',
        'DestinationConfigurations' => [ // REQUIRED
            'S3Destination' => [ // REQUIRED
                'S3Bucket' => '<string>', // REQUIRED
                'S3OutputConfigurations' => [ // REQUIRED
                    'Compression' => 'GZIP|PARQUET', // REQUIRED
                    'Format' => 'TEXT_OR_CSV|PARQUET', // REQUIRED
                    'OutputType' => 'CUSTOM', // REQUIRED
                    'Overwrite' => 'CREATE_NEW_REPORT|OVERWRITE_REPORT', // REQUIRED
                ],
                'S3Prefix' => '<string>', // REQUIRED
                'S3Region' => '<string>', // REQUIRED
            ],
        ],
        'ExportArn' => '<string>',
        'Name' => '<string>', // REQUIRED
        'RefreshCadence' => [ // REQUIRED
            'Frequency' => 'SYNCHRONOUS', // REQUIRED
        ],
    ],
    'ExportArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InternalServerException:

An error on the server occurred during the processing of your request. Try again later.

ResourceNotFoundException:

The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.