BatchExecuteStatement

$result = $client->batchExecuteStatement([/* ... */]);
$promise = $client->batchExecuteStatementAsync([/* ... */]);

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->batchExecuteStatement([
    'ClientToken' => '<string>',
    'ClusterIdentifier' => '<string>',
    'Database' => '<string>',
    'DbUser' => '<string>',
    'ResultFormat' => 'JSON|CSV',
    'SecretArn' => '<string>',
    'SessionId' => '<string>',
    'SessionKeepAliveSeconds' => <integer>,
    'Sqls' => ['<string>', ...], // REQUIRED
    'StatementName' => '<string>',
    'WithEvent' => true || false,
    'WorkgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ClusterIdentifier' => '<string>',
    'CreatedAt' => <DateTime>,
    'Database' => '<string>',
    'DbGroups' => ['<string>', ...],
    'DbUser' => '<string>',
    'Id' => '<string>',
    'SecretArn' => '<string>',
    'SessionId' => '<string>',
    'WorkgroupName' => '<string>',
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

ActiveSessionsExceededException:

The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.

ActiveStatementsExceededException:

The number of active statements exceeds the limit.

BatchExecuteStatementException:

An SQL statement encountered an environmental error while running.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

CancelStatement

$result = $client->cancelStatement([/* ... */]);
$promise = $client->cancelStatementAsync([/* ... */]);

Cancels a running query. To be canceled, a query must be running.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Status' => true || false,
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

ResourceNotFoundException:

The Amazon Redshift Data API operation failed due to a missing resource.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

DatabaseConnectionException:

Connection to a database failed.

DescribeStatement

$result = $client->describeStatement([/* ... */]);
$promise = $client->describeStatementAsync([/* ... */]);

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ClusterIdentifier' => '<string>',
    'CreatedAt' => <DateTime>,
    'Database' => '<string>',
    'DbUser' => '<string>',
    'Duration' => <integer>,
    'Error' => '<string>',
    'HasResultSet' => true || false,
    'Id' => '<string>',
    'QueryParameters' => [
        [
            'name' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'QueryString' => '<string>',
    'RedshiftPid' => <integer>,
    'RedshiftQueryId' => <integer>,
    'ResultFormat' => 'JSON|CSV',
    'ResultRows' => <integer>,
    'ResultSize' => <integer>,
    'SecretArn' => '<string>',
    'SessionId' => '<string>',
    'Status' => 'SUBMITTED|PICKED|STARTED|FINISHED|ABORTED|FAILED|ALL',
    'SubStatements' => [
        [
            'CreatedAt' => <DateTime>,
            'Duration' => <integer>,
            'Error' => '<string>',
            'HasResultSet' => true || false,
            'Id' => '<string>',
            'QueryString' => '<string>',
            'RedshiftQueryId' => <integer>,
            'ResultRows' => <integer>,
            'ResultSize' => <integer>,
            'Status' => 'SUBMITTED|PICKED|STARTED|FINISHED|ABORTED|FAILED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'UpdatedAt' => <DateTime>,
    'WorkgroupName' => '<string>',
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

ResourceNotFoundException:

The Amazon Redshift Data API operation failed due to a missing resource.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

DescribeTable

$result = $client->describeTable([/* ... */]);
$promise = $client->describeTableAsync([/* ... */]);

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->describeTable([
    'ClusterIdentifier' => '<string>',
    'ConnectedDatabase' => '<string>',
    'Database' => '<string>', // REQUIRED
    'DbUser' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Schema' => '<string>',
    'SecretArn' => '<string>',
    'Table' => '<string>',
    'WorkgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ColumnList' => [
        [
            'columnDefault' => '<string>',
            'isCaseSensitive' => true || false,
            'isCurrency' => true || false,
            'isSigned' => true || false,
            'label' => '<string>',
            'length' => <integer>,
            'name' => '<string>',
            'nullable' => <integer>,
            'precision' => <integer>,
            'scale' => <integer>,
            'schemaName' => '<string>',
            'tableName' => '<string>',
            'typeName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'TableName' => '<string>',
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

QueryTimeoutException:

The Amazon Redshift Data API operation failed due to timeout.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

DatabaseConnectionException:

Connection to a database failed.

ExecuteStatement

$result = $client->executeStatement([/* ... */]);
$promise = $client->executeStatementAsync([/* ... */]);

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->executeStatement([
    'ClientToken' => '<string>',
    'ClusterIdentifier' => '<string>',
    'Database' => '<string>',
    'DbUser' => '<string>',
    'Parameters' => [
        [
            'name' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ResultFormat' => 'JSON|CSV',
    'SecretArn' => '<string>',
    'SessionId' => '<string>',
    'SessionKeepAliveSeconds' => <integer>,
    'Sql' => '<string>', // REQUIRED
    'StatementName' => '<string>',
    'WithEvent' => true || false,
    'WorkgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ClusterIdentifier' => '<string>',
    'CreatedAt' => <DateTime>,
    'Database' => '<string>',
    'DbGroups' => ['<string>', ...],
    'DbUser' => '<string>',
    'Id' => '<string>',
    'SecretArn' => '<string>',
    'SessionId' => '<string>',
    'WorkgroupName' => '<string>',
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

ActiveSessionsExceededException:

The Amazon Redshift Data API operation failed because the maximum number of active sessions exceeded.

ExecuteStatementException:

The SQL statement encountered an environmental error while running.

ActiveStatementsExceededException:

The number of active statements exceeds the limit.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

GetStatementResult

$result = $client->getStatementResult([/* ... */]);
$promise = $client->getStatementResultAsync([/* ... */]);

Fetches the temporarily cached result of an SQL statement in JSON format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as JSON , or let the format default to JSON. A token is returned to page through the statement results.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->getStatementResult([
    'Id' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ColumnMetadata' => [
        [
            'columnDefault' => '<string>',
            'isCaseSensitive' => true || false,
            'isCurrency' => true || false,
            'isSigned' => true || false,
            'label' => '<string>',
            'length' => <integer>,
            'name' => '<string>',
            'nullable' => <integer>,
            'precision' => <integer>,
            'scale' => <integer>,
            'schemaName' => '<string>',
            'tableName' => '<string>',
            'typeName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Records' => [
        [
            [
                'blobValue' => <string || resource || Psr\Http\Message\StreamInterface>,
                'booleanValue' => true || false,
                'doubleValue' => <float>,
                'isNull' => true || false,
                'longValue' => <integer>,
                'stringValue' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'TotalNumRows' => <integer>,
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

ResourceNotFoundException:

The Amazon Redshift Data API operation failed due to a missing resource.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

GetStatementResultV2

$result = $client->getStatementResultV2([/* ... */]);
$promise = $client->getStatementResultV2Async([/* ... */]);

Fetches the temporarily cached result of an SQL statement in CSV format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as CSV. A token is returned to page through the statement results.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->getStatementResultV2([
    'Id' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ColumnMetadata' => [
        [
            'columnDefault' => '<string>',
            'isCaseSensitive' => true || false,
            'isCurrency' => true || false,
            'isSigned' => true || false,
            'label' => '<string>',
            'length' => <integer>,
            'name' => '<string>',
            'nullable' => <integer>,
            'precision' => <integer>,
            'scale' => <integer>,
            'schemaName' => '<string>',
            'tableName' => '<string>',
            'typeName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'Records' => [
        [
            'CSVRecords' => '<string>',
        ],
        // ...
    ],
    'ResultFormat' => 'JSON|CSV',
    'TotalNumRows' => <integer>,
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

ResourceNotFoundException:

The Amazon Redshift Data API operation failed due to a missing resource.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

ListDatabases

$result = $client->listDatabases([/* ... */]);
$promise = $client->listDatabasesAsync([/* ... */]);

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->listDatabases([
    'ClusterIdentifier' => '<string>',
    'Database' => '<string>', // REQUIRED
    'DbUser' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SecretArn' => '<string>',
    'WorkgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Databases' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

QueryTimeoutException:

The Amazon Redshift Data API operation failed due to timeout.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

DatabaseConnectionException:

Connection to a database failed.

ListSchemas

$result = $client->listSchemas([/* ... */]);
$promise = $client->listSchemasAsync([/* ... */]);

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->listSchemas([
    'ClusterIdentifier' => '<string>',
    'ConnectedDatabase' => '<string>',
    'Database' => '<string>', // REQUIRED
    'DbUser' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SchemaPattern' => '<string>',
    'SecretArn' => '<string>',
    'WorkgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Schemas' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

QueryTimeoutException:

The Amazon Redshift Data API operation failed due to timeout.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

DatabaseConnectionException:

Connection to a database failed.

ListStatements

$result = $client->listStatements([/* ... */]);
$promise = $client->listStatementsAsync([/* ... */]);

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->listStatements([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RoleLevel' => true || false,
    'StatementName' => '<string>',
    'Status' => 'SUBMITTED|PICKED|STARTED|FINISHED|ABORTED|FAILED|ALL',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Statements' => [
        [
            'CreatedAt' => <DateTime>,
            'Id' => '<string>',
            'IsBatchStatement' => true || false,
            'QueryParameters' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'QueryString' => '<string>',
            'QueryStrings' => ['<string>', ...],
            'ResultFormat' => 'JSON|CSV',
            'SecretArn' => '<string>',
            'SessionId' => '<string>',
            'StatementName' => '<string>',
            'Status' => 'SUBMITTED|PICKED|STARTED|FINISHED|ABORTED|FAILED|ALL',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

ListTables

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

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Parameter Syntax

$result = $client->listTables([
    'ClusterIdentifier' => '<string>',
    'ConnectedDatabase' => '<string>',
    'Database' => '<string>', // REQUIRED
    'DbUser' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SchemaPattern' => '<string>',
    'SecretArn' => '<string>',
    'TablePattern' => '<string>',
    'WorkgroupName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tables' => [
        [
            'name' => '<string>',
            'schema' => '<string>',
            'type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The Amazon Redshift Data API operation failed due to invalid input.

QueryTimeoutException:

The Amazon Redshift Data API operation failed due to timeout.

InternalServerException:

The Amazon Redshift Data API operation failed due to invalid input.

DatabaseConnectionException:

Connection to a database failed.