Navigation

Table Of Contents

  1. Docs
  2. Available services
  3. RedshiftDataAPIService

RedshiftDataAPIService

Client

class RedshiftDataAPIService.Client

A low-level client representing Redshift Data API Service

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.

For more information about the Amazon Redshift Data API, see Using the Amazon Redshift Data API in the Amazon Redshift Cluster Management Guide .

import boto3

client = boto3.client('redshift-data')

These are the available methods:

batch_execute_statement(**kwargs)

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

See also: AWS API Documentation

Request Syntax

response = client.batch_execute_statement(
    ClusterIdentifier='string',
    Database='string',
    DbUser='string',
    SecretArn='string',
    Sqls=[
        'string',
    ],
    StatementName='string',
    WithEvent=True|False
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • Database (string) --

    [REQUIRED]

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • Sqls (list) --

    [REQUIRED]

    One or more SQL statements to run.

    • (string) --
  • StatementName (string) -- The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
  • WithEvent (boolean) -- A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
Return type

dict

Returns

Response Syntax

{
    'ClusterIdentifier': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Database': 'string',
    'DbUser': 'string',
    'Id': 'string',
    'SecretArn': 'string'
}

Response Structure

  • (dict) --

    • ClusterIdentifier (string) --

      The cluster identifier.

    • CreatedAt (datetime) --

      The date and time (UTC) the statement was created.

    • Database (string) --

      The name of the database.

    • DbUser (string) --

      The database user name.

    • Id (string) --

      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment .

    • SecretArn (string) --

      The name or ARN of the secret that enables access to the database.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.ActiveStatementsExceededException
  • RedshiftDataAPIService.Client.exceptions.BatchExecuteStatementException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
cancel_statement(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.cancel_statement(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment , ExecuteStatment , and ListStatements .

Return type
dict
Returns
Response Syntax
{
    'Status': True|False
}

Response Structure

  • (dict) --
    • Status (boolean) --

      A value that indicates whether the cancel statement succeeded (true).

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.ResourceNotFoundException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException
describe_statement(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_statement(
    Id='string'
)
Parameters
Id (string) --

[REQUIRED]

The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment , ExecuteStatement , and ListStatements .

Return type
dict
Returns
Response Syntax
{
    'ClusterIdentifier': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Database': 'string',
    'DbUser': 'string',
    'Duration': 123,
    'Error': 'string',
    'HasResultSet': True|False,
    'Id': 'string',
    'QueryParameters': [
        {
            'name': 'string',
            'value': 'string'
        },
    ],
    'QueryString': 'string',
    'RedshiftPid': 123,
    'RedshiftQueryId': 123,
    'ResultRows': 123,
    'ResultSize': 123,
    'SecretArn': 'string',
    'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL',
    'SubStatements': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'Duration': 123,
            'Error': 'string',
            'HasResultSet': True|False,
            'Id': 'string',
            'QueryString': 'string',
            'RedshiftQueryId': 123,
            'ResultRows': 123,
            'ResultSize': 123,
            'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • ClusterIdentifier (string) --

      The cluster identifier.

    • CreatedAt (datetime) --

      The date and time (UTC) when the SQL statement was submitted to run.

    • Database (string) --

      The name of the database.

    • DbUser (string) --

      The database user name.

    • Duration (integer) --

      The amount of time in nanoseconds that the statement ran.

    • Error (string) --

      The error message from the cluster if the SQL statement encountered an error while running.

    • HasResultSet (boolean) --

      A value that indicates whether the statement has a result set. The result set can be empty.

    • Id (string) --

      The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    • QueryParameters (list) --

      The parameters for the SQL statement.

      • (dict) --

        A parameter used in a SQL statement.

        • name (string) --

          The name of the parameter.

        • value (string) --

          The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more inforation, see Data types in the Amazon Redshift Database Developer Guide .

    • QueryString (string) --

      The SQL statement text.

    • RedshiftPid (integer) --

      The process identifier from Amazon Redshift.

    • RedshiftQueryId (integer) --

      The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

    • ResultRows (integer) --

      Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

    • ResultSize (integer) --

      The size in bytes of the returned results. A -1 indicates the value is null.

    • SecretArn (string) --

      The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

    • Status (string) --

      The status of the SQL statement being described. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.
      • ALL - A status value that includes all query statuses. This value can be used to filter results.
      • FAILED - The query run failed.
      • FINISHED - The query has finished running.
      • PICKED - The query has been chosen to be run.
      • STARTED - The query run has started.
      • SUBMITTED - The query was submitted, but not yet processed.
    • SubStatements (list) --

      The SQL statements from a multiple statement run.

      • (dict) --

        Information about an SQL statement.

        • CreatedAt (datetime) --

          The date and time (UTC) the statement was created.

        • Duration (integer) --

          The amount of time in nanoseconds that the statement ran.

        • Error (string) --

          The error message from the cluster if the SQL statement encountered an error while running.

        • HasResultSet (boolean) --

          A value that indicates whether the statement has a result set. The result set can be empty.

        • Id (string) --

          The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.

        • QueryString (string) --

          The SQL statement text.

        • RedshiftQueryId (integer) --

          The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

        • ResultRows (integer) --

          Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

        • ResultSize (integer) --

          The size in bytes of the returned results. A -1 indicates the value is null.

        • Status (string) --

          The status of the SQL statement. An example is the that the SQL statement finished.

        • UpdatedAt (datetime) --

          The date and time (UTC) that the statement metadata was last updated.

    • UpdatedAt (datetime) --

      The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.ResourceNotFoundException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException
describe_table(**kwargs)

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

See also: AWS API Documentation

Request Syntax

response = client.describe_table(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    MaxResults=123,
    NextToken='string',
    Schema='string',
    SecretArn='string',
    Table='string'
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • ConnectedDatabase (string) -- A database name. The connected database is specified when you connect with your authentication credentials.
  • Database (string) --

    [REQUIRED]

    The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • MaxResults (integer) -- The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
  • NextToken (string) -- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
  • Schema (string) -- The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • Table (string) -- The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned
Return type

dict

Returns

Response Syntax

{
    'ColumnList': [
        {
            'columnDefault': 'string',
            'isCaseSensitive': True|False,
            'isCurrency': True|False,
            'isSigned': True|False,
            'label': 'string',
            'length': 123,
            'name': 'string',
            'nullable': 123,
            'precision': 123,
            'scale': 123,
            'schemaName': 'string',
            'tableName': 'string',
            'typeName': 'string'
        },
    ],
    'NextToken': 'string',
    'TableName': 'string'
}

Response Structure

  • (dict) --

    • ColumnList (list) --

      A list of columns in the table.

      • (dict) --

        The properties (metadata) of a column.

        • columnDefault (string) --

          The default value of the column.

        • isCaseSensitive (boolean) --

          A value that indicates whether the column is case-sensitive.

        • isCurrency (boolean) --

          A value that indicates whether the column contains currency values.

        • isSigned (boolean) --

          A value that indicates whether an integer column is signed.

        • label (string) --

          The label for the column.

        • length (integer) --

          The length of the column.

        • name (string) --

          The name of the column.

        • nullable (integer) --

          A value that indicates whether the column is nullable.

        • precision (integer) --

          The precision value of a decimal number column.

        • scale (integer) --

          The scale value of a decimal number column.

        • schemaName (string) --

          The name of the schema that contains the table that includes the column.

        • tableName (string) --

          The name of the table that includes the column.

        • typeName (string) --

          The database-specific data type of the column.

    • NextToken (string) --

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    • TableName (string) --

      The table name.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException
execute_statement(**kwargs)

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

See also: AWS API Documentation

Request Syntax

response = client.execute_statement(
    ClusterIdentifier='string',
    Database='string',
    DbUser='string',
    Parameters=[
        {
            'name': 'string',
            'value': 'string'
        },
    ],
    SecretArn='string',
    Sql='string',
    StatementName='string',
    WithEvent=True|False
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • Database (string) --

    [REQUIRED]

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • Parameters (list) --

    The parameters for the SQL statement.

    • (dict) --

      A parameter used in a SQL statement.

      • name (string) -- [REQUIRED]

        The name of the parameter.

      • value (string) -- [REQUIRED]

        The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more inforation, see Data types in the Amazon Redshift Database Developer Guide .

  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • Sql (string) --

    [REQUIRED]

    The SQL statement text to run.

  • StatementName (string) -- The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
  • WithEvent (boolean) -- A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
Return type

dict

Returns

Response Syntax

{
    'ClusterIdentifier': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Database': 'string',
    'DbUser': 'string',
    'Id': 'string',
    'SecretArn': 'string'
}

Response Structure

  • (dict) --

    • ClusterIdentifier (string) --

      The cluster identifier.

    • CreatedAt (datetime) --

      The date and time (UTC) the statement was created.

    • Database (string) --

      The name of the database.

    • DbUser (string) --

      The database user name.

    • Id (string) --

      The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

    • SecretArn (string) --

      The name or ARN of the secret that enables access to the database.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.ExecuteStatementException
  • RedshiftDataAPIService.Client.exceptions.ActiveStatementsExceededException
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_statement_result(**kwargs)

Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

See also: AWS API Documentation

Request Syntax

response = client.get_statement_result(
    Id='string',
    NextToken='string'
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment , ExecuteStatment , and ListStatements .

  • NextToken (string) -- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
Return type

dict

Returns

Response Syntax

{
    'ColumnMetadata': [
        {
            'columnDefault': 'string',
            'isCaseSensitive': True|False,
            'isCurrency': True|False,
            'isSigned': True|False,
            'label': 'string',
            'length': 123,
            'name': 'string',
            'nullable': 123,
            'precision': 123,
            'scale': 123,
            'schemaName': 'string',
            'tableName': 'string',
            'typeName': 'string'
        },
    ],
    'NextToken': 'string',
    'Records': [
        [
            {
                'blobValue': b'bytes',
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'isNull': True|False,
                'longValue': 123,
                'stringValue': 'string'
            },
        ],
    ],
    'TotalNumRows': 123
}

Response Structure

  • (dict) --

    • ColumnMetadata (list) --

      The properties (metadata) of a column.

      • (dict) --

        The properties (metadata) of a column.

        • columnDefault (string) --

          The default value of the column.

        • isCaseSensitive (boolean) --

          A value that indicates whether the column is case-sensitive.

        • isCurrency (boolean) --

          A value that indicates whether the column contains currency values.

        • isSigned (boolean) --

          A value that indicates whether an integer column is signed.

        • label (string) --

          The label for the column.

        • length (integer) --

          The length of the column.

        • name (string) --

          The name of the column.

        • nullable (integer) --

          A value that indicates whether the column is nullable.

        • precision (integer) --

          The precision value of a decimal number column.

        • scale (integer) --

          The scale value of a decimal number column.

        • schemaName (string) --

          The name of the schema that contains the table that includes the column.

        • tableName (string) --

          The name of the table that includes the column.

        • typeName (string) --

          The database-specific data type of the column.

    • NextToken (string) --

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    • Records (list) --

      The results of the SQL statement.

      • (list) --

        • (dict) --

          A data value in a column.

          • blobValue (bytes) --

            A value of the BLOB data type.

          • booleanValue (boolean) --

            A value of the Boolean data type.

          • doubleValue (float) --

            A value of the double data type.

          • isNull (boolean) --

            A value that indicates whether the data is NULL.

          • longValue (integer) --

            A value of the long data type.

          • stringValue (string) --

            A value of the string data type.

    • TotalNumRows (integer) --

      The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.ResourceNotFoundException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_databases(**kwargs)

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

See also: AWS API Documentation

Request Syntax

response = client.list_databases(
    ClusterIdentifier='string',
    Database='string',
    DbUser='string',
    MaxResults=123,
    NextToken='string',
    SecretArn='string'
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • Database (string) --

    [REQUIRED]

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • MaxResults (integer) -- The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
  • NextToken (string) -- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
Return type

dict

Returns

Response Syntax

{
    'Databases': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Databases (list) --

      The names of databases.

      • (string) --

    • NextToken (string) --

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException
list_schemas(**kwargs)

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

See also: AWS API Documentation

Request Syntax

response = client.list_schemas(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    MaxResults=123,
    NextToken='string',
    SchemaPattern='string',
    SecretArn='string'
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • ConnectedDatabase (string) -- A database name. The connected database is specified when you connect with your authentication credentials.
  • Database (string) --

    [REQUIRED]

    The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • MaxResults (integer) -- The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.
  • NextToken (string) -- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
  • SchemaPattern (string) -- A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Schemas': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    • Schemas (list) --

      The schemas that match the request pattern.

      • (string) --

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException
list_statements(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_statements(
    MaxResults=123,
    NextToken='string',
    RoleLevel=True|False,
    StatementName='string',
    Status='SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL'
)
Parameters
  • MaxResults (integer) -- The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.
  • NextToken (string) -- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
  • RoleLevel (boolean) -- A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
  • StatementName (string) -- The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement . Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
  • Status (string) --

    The status of the SQL statement to list. Status values are defined as follows:

    • ABORTED - The query run was stopped by the user.
    • ALL - A status value that includes all query statuses. This value can be used to filter results.
    • FAILED - The query run failed.
    • FINISHED - The query has finished running.
    • PICKED - The query has been chosen to be run.
    • STARTED - The query run has started.
    • SUBMITTED - The query was submitted, but not yet processed.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Statements': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'Id': 'string',
            'IsBatchStatement': True|False,
            'QueryParameters': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'QueryString': 'string',
            'QueryStrings': [
                'string',
            ],
            'SecretArn': 'string',
            'StatementName': 'string',
            'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    • Statements (list) --

      The SQL statements.

      • (dict) --

        The SQL statement to run.

        • CreatedAt (datetime) --

          The date and time (UTC) the statement was created.

        • Id (string) --

          The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

        • IsBatchStatement (boolean) --

          A value that indicates whether the statement is a batch query request.

        • QueryParameters (list) --

          The parameters used in a SQL statement.

          • (dict) --

            A parameter used in a SQL statement.

            • name (string) --

              The name of the parameter.

            • value (string) --

              The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more inforation, see Data types in the Amazon Redshift Database Developer Guide .

        • QueryString (string) --

          The SQL statement.

        • QueryStrings (list) --

          One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

          • (string) --

        • SecretArn (string) --

          The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

        • StatementName (string) --

          The name of the SQL statement.

        • Status (string) --

          The status of the SQL statement. An example is the that the SQL statement finished.

        • UpdatedAt (datetime) --

          The date and time (UTC) that the statement metadata was last updated.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException
list_tables(**kwargs)

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 - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.
  • Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

See also: AWS API Documentation

Request Syntax

response = client.list_tables(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    MaxResults=123,
    NextToken='string',
    SchemaPattern='string',
    SecretArn='string',
    TablePattern='string'
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • ConnectedDatabase (string) -- A database name. The connected database is specified when you connect with your authentication credentials.
  • Database (string) --

    [REQUIRED]

    The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • MaxResults (integer) -- The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
  • NextToken (string) -- A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
  • SchemaPattern (string) -- A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • TablePattern (string) -- A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Tables': [
        {
            'name': 'string',
            'schema': 'string',
            'type': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

    • Tables (list) --

      The tables that match the request pattern.

      • (dict) --

        The properties of a table.

        • name (string) --

          The name of the table.

        • schema (string) --

          The schema containing the table.

        • type (string) --

          The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.

Exceptions

  • RedshiftDataAPIService.Client.exceptions.ValidationException
  • RedshiftDataAPIService.Client.exceptions.InternalServerException

Paginators

The available paginators are:

class RedshiftDataAPIService.Paginator.DescribeTable
paginator = client.get_paginator('describe_table')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.describe_table().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    Schema='string',
    SecretArn='string',
    Table='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • ConnectedDatabase (string) -- A database name. The connected database is specified when you connect with your authentication credentials.
  • Database (string) --

    [REQUIRED]

    The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • Schema (string) -- The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • Table (string) -- The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ColumnList': [
        {
            'columnDefault': 'string',
            'isCaseSensitive': True|False,
            'isCurrency': True|False,
            'isSigned': True|False,
            'label': 'string',
            'length': 123,
            'name': 'string',
            'nullable': 123,
            'precision': 123,
            'scale': 123,
            'schemaName': 'string',
            'tableName': 'string',
            'typeName': 'string'
        },
    ],
    'TableName': 'string'
}

Response Structure

  • (dict) --

    • ColumnList (list) --

      A list of columns in the table.

      • (dict) --

        The properties (metadata) of a column.

        • columnDefault (string) --

          The default value of the column.

        • isCaseSensitive (boolean) --

          A value that indicates whether the column is case-sensitive.

        • isCurrency (boolean) --

          A value that indicates whether the column contains currency values.

        • isSigned (boolean) --

          A value that indicates whether an integer column is signed.

        • label (string) --

          The label for the column.

        • length (integer) --

          The length of the column.

        • name (string) --

          The name of the column.

        • nullable (integer) --

          A value that indicates whether the column is nullable.

        • precision (integer) --

          The precision value of a decimal number column.

        • scale (integer) --

          The scale value of a decimal number column.

        • schemaName (string) --

          The name of the schema that contains the table that includes the column.

        • tableName (string) --

          The name of the table that includes the column.

        • typeName (string) --

          The database-specific data type of the column.

    • TableName (string) --

      The table name.

class RedshiftDataAPIService.Paginator.GetStatementResult
paginator = client.get_paginator('get_statement_result')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.get_statement_result().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Id='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • Id (string) --

    [REQUIRED]

    The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates then number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment , ExecuteStatment , and ListStatements .

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ColumnMetadata': [
        {
            'columnDefault': 'string',
            'isCaseSensitive': True|False,
            'isCurrency': True|False,
            'isSigned': True|False,
            'label': 'string',
            'length': 123,
            'name': 'string',
            'nullable': 123,
            'precision': 123,
            'scale': 123,
            'schemaName': 'string',
            'tableName': 'string',
            'typeName': 'string'
        },
    ],
    'Records': [
        [
            {
                'blobValue': b'bytes',
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'isNull': True|False,
                'longValue': 123,
                'stringValue': 'string'
            },
        ],
    ],
    'TotalNumRows': 123
}

Response Structure

  • (dict) --

    • ColumnMetadata (list) --

      The properties (metadata) of a column.

      • (dict) --

        The properties (metadata) of a column.

        • columnDefault (string) --

          The default value of the column.

        • isCaseSensitive (boolean) --

          A value that indicates whether the column is case-sensitive.

        • isCurrency (boolean) --

          A value that indicates whether the column contains currency values.

        • isSigned (boolean) --

          A value that indicates whether an integer column is signed.

        • label (string) --

          The label for the column.

        • length (integer) --

          The length of the column.

        • name (string) --

          The name of the column.

        • nullable (integer) --

          A value that indicates whether the column is nullable.

        • precision (integer) --

          The precision value of a decimal number column.

        • scale (integer) --

          The scale value of a decimal number column.

        • schemaName (string) --

          The name of the schema that contains the table that includes the column.

        • tableName (string) --

          The name of the table that includes the column.

        • typeName (string) --

          The database-specific data type of the column.

    • Records (list) --

      The results of the SQL statement.

      • (list) --

        • (dict) --

          A data value in a column.

          • blobValue (bytes) --

            A value of the BLOB data type.

          • booleanValue (boolean) --

            A value of the Boolean data type.

          • doubleValue (float) --

            A value of the double data type.

          • isNull (boolean) --

            A value that indicates whether the data is NULL.

          • longValue (integer) --

            A value of the long data type.

          • stringValue (string) --

            A value of the string data type.

    • TotalNumRows (integer) --

      The total number of rows in the result set returned from a query. You can use this number to estimate the number of calls to the GetStatementResult operation needed to page through the results.

class RedshiftDataAPIService.Paginator.ListDatabases
paginator = client.get_paginator('list_databases')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.list_databases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    Database='string',
    DbUser='string',
    SecretArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • Database (string) --

    [REQUIRED]

    The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Databases': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • Databases (list) --

      The names of databases.

      • (string) --

class RedshiftDataAPIService.Paginator.ListSchemas
paginator = client.get_paginator('list_schemas')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.list_schemas().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    SchemaPattern='string',
    SecretArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • ConnectedDatabase (string) -- A database name. The connected database is specified when you connect with your authentication credentials.
  • Database (string) --

    [REQUIRED]

    The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • SchemaPattern (string) -- A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Schemas': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • Schemas (list) --

      The schemas that match the request pattern.

      • (string) --

class RedshiftDataAPIService.Paginator.ListStatements
paginator = client.get_paginator('list_statements')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.list_statements().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RoleLevel=True|False,
    StatementName='string',
    Status='SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • RoleLevel (boolean) -- A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
  • StatementName (string) -- The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement . Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
  • Status (string) --

    The status of the SQL statement to list. Status values are defined as follows:

    • ABORTED - The query run was stopped by the user.
    • ALL - A status value that includes all query statuses. This value can be used to filter results.
    • FAILED - The query run failed.
    • FINISHED - The query has finished running.
    • PICKED - The query has been chosen to be run.
    • STARTED - The query run has started.
    • SUBMITTED - The query was submitted, but not yet processed.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Statements': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'Id': 'string',
            'IsBatchStatement': True|False,
            'QueryParameters': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'QueryString': 'string',
            'QueryStrings': [
                'string',
            ],
            'SecretArn': 'string',
            'StatementName': 'string',
            'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) --

    • Statements (list) --

      The SQL statements.

      • (dict) --

        The SQL statement to run.

        • CreatedAt (datetime) --

          The date and time (UTC) the statement was created.

        • Id (string) --

          The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

        • IsBatchStatement (boolean) --

          A value that indicates whether the statement is a batch query request.

        • QueryParameters (list) --

          The parameters used in a SQL statement.

          • (dict) --

            A parameter used in a SQL statement.

            • name (string) --

              The name of the parameter.

            • value (string) --

              The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more inforation, see Data types in the Amazon Redshift Database Developer Guide .

        • QueryString (string) --

          The SQL statement.

        • QueryStrings (list) --

          One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

          • (string) --

        • SecretArn (string) --

          The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

        • StatementName (string) --

          The name of the SQL statement.

        • Status (string) --

          The status of the SQL statement. An example is the that the SQL statement finished.

        • UpdatedAt (datetime) --

          The date and time (UTC) that the statement metadata was last updated.

class RedshiftDataAPIService.Paginator.ListTables
paginator = client.get_paginator('list_tables')
paginate(**kwargs)

Creates an iterator that will paginate through responses from RedshiftDataAPIService.Client.list_tables().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterIdentifier='string',
    ConnectedDatabase='string',
    Database='string',
    DbUser='string',
    SchemaPattern='string',
    SecretArn='string',
    TablePattern='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ClusterIdentifier (string) --

    [REQUIRED]

    The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

  • ConnectedDatabase (string) -- A database name. The connected database is specified when you connect with your authentication credentials.
  • Database (string) --

    [REQUIRED]

    The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

  • DbUser (string) -- The database user name. This parameter is required when authenticating using temporary credentials.
  • SchemaPattern (string) -- A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
  • SecretArn (string) -- The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
  • TablePattern (string) -- A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Tables': [
        {
            'name': 'string',
            'schema': 'string',
            'type': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Tables (list) --

      The tables that match the request pattern.

      • (dict) --

        The properties of a table.

        • name (string) --

          The name of the table.

        • schema (string) --

          The schema containing the table.

        • type (string) --

          The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.

Redshift
Rekognition

Navigation

Privacy | Site Terms | Cookie preferences | © Copyright 2021, Amazon Web Services, Inc. Created using Sphinx.