| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.RedshiftData
Description
Derived from API version 2019-12-20 of the AWS service descriptions, licensed under Apache 2.0.
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 and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.
Synopsis
- defaultService :: Service
- _ActiveStatementsExceededException :: AsError a => Fold a ServiceError
- _BatchExecuteStatementException :: AsError a => Fold a ServiceError
- _DatabaseConnectionException :: AsError a => Fold a ServiceError
- _ExecuteStatementException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data BatchExecuteStatement = BatchExecuteStatement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) Text (NonEmpty Text)
- newBatchExecuteStatement :: Text -> NonEmpty Text -> BatchExecuteStatement
- data BatchExecuteStatementResponse = BatchExecuteStatementResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newBatchExecuteStatementResponse :: Int -> BatchExecuteStatementResponse
- data CancelStatement = CancelStatement' Text
- newCancelStatement :: Text -> CancelStatement
- data CancelStatementResponse = CancelStatementResponse' (Maybe Bool) Int
- newCancelStatementResponse :: Int -> CancelStatementResponse
- data DescribeStatement = DescribeStatement' Text
- newDescribeStatement :: Text -> DescribeStatement
- data DescribeStatementResponse = DescribeStatementResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe (NonEmpty SqlParameter)) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe StatusString) (Maybe [SubStatementData]) (Maybe POSIX) (Maybe Text) Int Text
- newDescribeStatementResponse :: Int -> Text -> DescribeStatementResponse
- data DescribeTable = DescribeTable' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newDescribeTable :: Text -> DescribeTable
- data DescribeTableResponse = DescribeTableResponse' (Maybe [ColumnMetadata]) (Maybe Text) (Maybe Text) Int
- newDescribeTableResponse :: Int -> DescribeTableResponse
- data ExecuteStatement = ExecuteStatement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty SqlParameter)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) Text Text
- newExecuteStatement :: Text -> Text -> ExecuteStatement
- data ExecuteStatementResponse = ExecuteStatementResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newExecuteStatementResponse :: Int -> ExecuteStatementResponse
- data GetStatementResult = GetStatementResult' (Maybe Text) Text
- newGetStatementResult :: Text -> GetStatementResult
- data GetStatementResultResponse = GetStatementResultResponse' (Maybe [ColumnMetadata]) (Maybe Text) (Maybe Integer) Int [[Field]]
- newGetStatementResultResponse :: Int -> GetStatementResultResponse
- data ListDatabases = ListDatabases' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newListDatabases :: Text -> ListDatabases
- data ListDatabasesResponse = ListDatabasesResponse' (Maybe [Text]) (Maybe Text) Int
- newListDatabasesResponse :: Int -> ListDatabasesResponse
- data ListSchemas = ListSchemas' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newListSchemas :: Text -> ListSchemas
- data ListSchemasResponse = ListSchemasResponse' (Maybe Text) (Maybe [Text]) Int
- newListSchemasResponse :: Int -> ListSchemasResponse
- data ListStatements = ListStatements' (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe StatusString)
- newListStatements :: ListStatements
- data ListStatementsResponse = ListStatementsResponse' (Maybe Text) Int [StatementData]
- newListStatementsResponse :: Int -> ListStatementsResponse
- data ListTables = ListTables' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newListTables :: Text -> ListTables
- data ListTablesResponse = ListTablesResponse' (Maybe Text) (Maybe [TableMember]) Int
- newListTablesResponse :: Int -> ListTablesResponse
- newtype StatementStatusString where
- StatementStatusString' { }
- pattern StatementStatusString_ABORTED :: StatementStatusString
- pattern StatementStatusString_FAILED :: StatementStatusString
- pattern StatementStatusString_FINISHED :: StatementStatusString
- pattern StatementStatusString_PICKED :: StatementStatusString
- pattern StatementStatusString_STARTED :: StatementStatusString
- pattern StatementStatusString_SUBMITTED :: StatementStatusString
- newtype StatusString where
- StatusString' { }
- pattern StatusString_ABORTED :: StatusString
- pattern StatusString_ALL :: StatusString
- pattern StatusString_FAILED :: StatusString
- pattern StatusString_FINISHED :: StatusString
- pattern StatusString_PICKED :: StatusString
- pattern StatusString_STARTED :: StatusString
- pattern StatusString_SUBMITTED :: StatusString
- data ColumnMetadata = ColumnMetadata' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text)
- newColumnMetadata :: ColumnMetadata
- data Field = Field' (Maybe Base64) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Integer) (Maybe Text)
- newField :: Field
- data SqlParameter = SqlParameter' Text Text
- newSqlParameter :: Text -> Text -> SqlParameter
- data StatementData = StatementData' (Maybe POSIX) (Maybe Bool) (Maybe (NonEmpty SqlParameter)) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe StatusString) (Maybe POSIX) Text
- newStatementData :: Text -> StatementData
- data SubStatementData = SubStatementData' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe StatementStatusString) (Maybe POSIX) Text
- newSubStatementData :: Text -> SubStatementData
- data TableMember = TableMember' (Maybe Text) (Maybe Text) (Maybe Text)
- newTableMember :: TableMember
Service Configuration
defaultService :: Service Source #
API version 2019-12-20 of the Amazon Redshift Data API Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by RedshiftData.
ActiveStatementsExceededException
_ActiveStatementsExceededException :: AsError a => Fold a ServiceError Source #
The number of active statements exceeds the limit.
BatchExecuteStatementException
_BatchExecuteStatementException :: AsError a => Fold a ServiceError Source #
An SQL statement encountered an environmental error while running.
DatabaseConnectionException
_DatabaseConnectionException :: AsError a => Fold a ServiceError Source #
Connection to a database failed.
ExecuteStatementException
_ExecuteStatementException :: AsError a => Fold a ServiceError Source #
The SQL statement encountered an environmental error while running.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The Amazon Redshift Data API operation failed due to invalid input.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The Amazon Redshift Data API operation failed due to a missing resource.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The Amazon Redshift Data API operation failed due to invalid input.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchExecuteStatement
data BatchExecuteStatement Source #
See: newBatchExecuteStatement smart constructor.
Constructors
| BatchExecuteStatement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) Text (NonEmpty Text) |
Instances
newBatchExecuteStatement Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> BatchExecuteStatement |
Create a value of BatchExecuteStatement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:BatchExecuteStatement', batchExecuteStatement_clientToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
BatchExecuteStatement, batchExecuteStatement_clusterIdentifier - The cluster identifier. This parameter is required when connecting to a
cluster and authenticating using either Secrets Manager or temporary
credentials.
BatchExecuteStatement, batchExecuteStatement_dbUser - The database user name. This parameter is required when connecting to a
cluster and authenticating using temporary credentials.
BatchExecuteStatement, batchExecuteStatement_secretArn - The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
BatchExecuteStatement, batchExecuteStatement_statementName - The name of the SQL statements. You can name the SQL statements when you
create them to identify the query.
$sel:withEvent:BatchExecuteStatement', batchExecuteStatement_withEvent - A value that indicates whether to send an event to the Amazon
EventBridge event bus after the SQL statements run.
BatchExecuteStatement, batchExecuteStatement_workgroupName - The serverless workgroup name. This parameter is required when
connecting to a serverless workgroup and authenticating using either
Secrets Manager or temporary credentials.
BatchExecuteStatement, batchExecuteStatement_database - The name of the database. This parameter is required when authenticating
using either Secrets Manager or temporary credentials.
$sel:sqls:BatchExecuteStatement', batchExecuteStatement_sqls - One or more SQL statements to run.
The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
data BatchExecuteStatementResponse Source #
See: newBatchExecuteStatementResponse smart constructor.
Constructors
| BatchExecuteStatementResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newBatchExecuteStatementResponse Source #
Create a value of BatchExecuteStatementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
BatchExecuteStatement, batchExecuteStatementResponse_clusterIdentifier - The cluster identifier. This element is not returned when connecting to
a serverless workgroup.
BatchExecuteStatementResponse, batchExecuteStatementResponse_createdAt - The date and time (UTC) the statement was created.
BatchExecuteStatement, batchExecuteStatementResponse_database - The name of the database.
BatchExecuteStatement, batchExecuteStatementResponse_dbUser - The database user name.
BatchExecuteStatementResponse, batchExecuteStatementResponse_id - 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.
BatchExecuteStatement, batchExecuteStatementResponse_secretArn - The name or ARN of the secret that enables access to the database.
BatchExecuteStatement, batchExecuteStatementResponse_workgroupName - The serverless workgroup name. This element is not returned when
connecting to a provisioned cluster.
$sel:httpStatus:BatchExecuteStatementResponse', batchExecuteStatementResponse_httpStatus - The response's http status code.
CancelStatement
data CancelStatement Source #
See: newCancelStatement smart constructor.
Constructors
| CancelStatement' Text |
Instances
Arguments
| :: Text | |
| -> CancelStatement |
Create a value of CancelStatement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelStatement, cancelStatement_id - 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.
data CancelStatementResponse Source #
See: newCancelStatementResponse smart constructor.
Constructors
| CancelStatementResponse' (Maybe Bool) Int |
Instances
newCancelStatementResponse Source #
Create a value of CancelStatementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CancelStatementResponse, cancelStatementResponse_status - A value that indicates whether the cancel statement succeeded (true).
$sel:httpStatus:CancelStatementResponse', cancelStatementResponse_httpStatus - The response's http status code.
DescribeStatement
data DescribeStatement Source #
See: newDescribeStatement smart constructor.
Constructors
| DescribeStatement' Text |
Instances
Arguments
| :: Text | |
| -> DescribeStatement |
Create a value of DescribeStatement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStatement, describeStatement_id - 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.
data DescribeStatementResponse Source #
See: newDescribeStatementResponse smart constructor.
Constructors
| DescribeStatementResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe (NonEmpty SqlParameter)) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Text) (Maybe StatusString) (Maybe [SubStatementData]) (Maybe POSIX) (Maybe Text) Int Text |
Instances
newDescribeStatementResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribeStatementResponse |
Create a value of DescribeStatementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterIdentifier:DescribeStatementResponse', describeStatementResponse_clusterIdentifier - The cluster identifier.
DescribeStatementResponse, describeStatementResponse_createdAt - The date and time (UTC) when the SQL statement was submitted to run.
$sel:database:DescribeStatementResponse', describeStatementResponse_database - The name of the database.
$sel:dbUser:DescribeStatementResponse', describeStatementResponse_dbUser - The database user name.
DescribeStatementResponse, describeStatementResponse_duration - The amount of time in nanoseconds that the statement ran.
DescribeStatementResponse, describeStatementResponse_error - The error message from the cluster if the SQL statement encountered an
error while running.
DescribeStatementResponse, describeStatementResponse_hasResultSet - A value that indicates whether the statement has a result set. The
result set can be empty. The value is true for an empty result set. The
value is true if any substatement returns a result set.
DescribeStatementResponse, describeStatementResponse_queryParameters - The parameters for the SQL statement.
DescribeStatementResponse, describeStatementResponse_queryString - The SQL statement text.
$sel:redshiftPid:DescribeStatementResponse', describeStatementResponse_redshiftPid - The process identifier from Amazon Redshift.
DescribeStatementResponse, describeStatementResponse_redshiftQueryId - The identifier of the query generated by Amazon Redshift. These
identifiers are also available in the query column of the STL_QUERY
system view.
DescribeStatementResponse, describeStatementResponse_resultRows - 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.
DescribeStatementResponse, describeStatementResponse_resultSize - The size in bytes of the returned results. A -1 indicates the value is
null.
DescribeStatementResponse, describeStatementResponse_secretArn - The name or Amazon Resource Name (ARN) of the secret that enables access
to the database.
DescribeStatementResponse, describeStatementResponse_status - 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.
$sel:subStatements:DescribeStatementResponse', describeStatementResponse_subStatements - The SQL statements from a multiple statement run.
DescribeStatementResponse, describeStatementResponse_updatedAt - The date and time (UTC) that the metadata for the SQL statement was last
updated. An example is the time the status last changed.
$sel:workgroupName:DescribeStatementResponse', describeStatementResponse_workgroupName - The serverless workgroup name.
$sel:httpStatus:DescribeStatementResponse', describeStatementResponse_httpStatus - The response's http status code.
DescribeStatement, describeStatementResponse_id - The identifier of the SQL statement described. This value is a
universally unique identifier (UUID) generated by Amazon Redshift Data
API.
DescribeTable (Paginated)
data DescribeTable Source #
See: newDescribeTable smart constructor.
Constructors
| DescribeTable' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DescribeTable |
Create a value of DescribeTable with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterIdentifier:DescribeTable', describeTable_clusterIdentifier - The cluster identifier. This parameter is required when connecting to a
cluster and authenticating using either Secrets Manager or temporary
credentials.
$sel:connectedDatabase:DescribeTable', describeTable_connectedDatabase - A database name. The connected database is specified when you connect
with your authentication credentials.
$sel:dbUser:DescribeTable', describeTable_dbUser - The database user name. This parameter is required when connecting to a
cluster and authenticating using temporary credentials.
$sel:maxResults:DescribeTable', describeTable_maxResults - 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.
DescribeTable, describeTable_nextToken - 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.
DescribeTable, describeTable_schema - The schema that contains the table. If no schema is specified, then
matching tables for all schemas are returned.
DescribeTable, describeTable_secretArn - The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
$sel:table:DescribeTable', describeTable_table - 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
$sel:workgroupName:DescribeTable', describeTable_workgroupName - The serverless workgroup name. This parameter is required when
connecting to a serverless workgroup and authenticating using either
Secrets Manager or temporary credentials.
$sel:database:DescribeTable', describeTable_database - 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.
data DescribeTableResponse Source #
See: newDescribeTableResponse smart constructor.
Constructors
| DescribeTableResponse' (Maybe [ColumnMetadata]) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeTableResponse Source #
Create a value of DescribeTableResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnList:DescribeTableResponse', describeTableResponse_columnList - A list of columns in the table.
DescribeTable, describeTableResponse_nextToken - 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.
DescribeTableResponse, describeTableResponse_tableName - The table name.
$sel:httpStatus:DescribeTableResponse', describeTableResponse_httpStatus - The response's http status code.
ExecuteStatement
data ExecuteStatement Source #
See: newExecuteStatement smart constructor.
Constructors
| ExecuteStatement' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (NonEmpty SqlParameter)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ExecuteStatement |
Create a value of ExecuteStatement with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:ExecuteStatement', executeStatement_clientToken - A unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
ExecuteStatement, executeStatement_clusterIdentifier - The cluster identifier. This parameter is required when connecting to a
cluster and authenticating using either Secrets Manager or temporary
credentials.
ExecuteStatement, executeStatement_dbUser - The database user name. This parameter is required when connecting to a
cluster and authenticating using temporary credentials.
$sel:parameters:ExecuteStatement', executeStatement_parameters - The parameters for the SQL statement.
ExecuteStatement, executeStatement_secretArn - The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
ExecuteStatement, executeStatement_statementName - The name of the SQL statement. You can name the SQL statement when you
create it to identify the query.
$sel:withEvent:ExecuteStatement', executeStatement_withEvent - A value that indicates whether to send an event to the Amazon
EventBridge event bus after the SQL statement runs.
ExecuteStatement, executeStatement_workgroupName - The serverless workgroup name. This parameter is required when
connecting to a serverless workgroup and authenticating using either
Secrets Manager or temporary credentials.
ExecuteStatement, executeStatement_database - The name of the database. This parameter is required when authenticating
using either Secrets Manager or temporary credentials.
$sel:sql:ExecuteStatement', executeStatement_sql - The SQL statement text to run.
data ExecuteStatementResponse Source #
See: newExecuteStatementResponse smart constructor.
Constructors
| ExecuteStatementResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newExecuteStatementResponse Source #
Create a value of ExecuteStatementResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExecuteStatement, executeStatementResponse_clusterIdentifier - The cluster identifier. This element is not returned when connecting to
a serverless workgroup.
ExecuteStatementResponse, executeStatementResponse_createdAt - The date and time (UTC) the statement was created.
ExecuteStatement, executeStatementResponse_database - The name of the database.
ExecuteStatement, executeStatementResponse_dbUser - The database user name.
ExecuteStatementResponse, executeStatementResponse_id - 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.
ExecuteStatement, executeStatementResponse_secretArn - The name or ARN of the secret that enables access to the database.
ExecuteStatement, executeStatementResponse_workgroupName - The serverless workgroup name. This element is not returned when
connecting to a provisioned cluster.
$sel:httpStatus:ExecuteStatementResponse', executeStatementResponse_httpStatus - The response's http status code.
GetStatementResult (Paginated)
data GetStatementResult Source #
See: newGetStatementResult smart constructor.
Constructors
| GetStatementResult' (Maybe Text) Text |
Instances
newGetStatementResult Source #
Arguments
| :: Text | |
| -> GetStatementResult |
Create a value of GetStatementResult with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetStatementResult, getStatementResult_nextToken - 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.
GetStatementResult, getStatementResult_id - 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.
data GetStatementResultResponse Source #
See: newGetStatementResultResponse smart constructor.
Constructors
| GetStatementResultResponse' (Maybe [ColumnMetadata]) (Maybe Text) (Maybe Integer) Int [[Field]] |
Instances
newGetStatementResultResponse Source #
Create a value of GetStatementResultResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnMetadata:GetStatementResultResponse', getStatementResultResponse_columnMetadata - The properties (metadata) of a column.
GetStatementResult, getStatementResultResponse_nextToken - 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.
$sel:totalNumRows:GetStatementResultResponse', getStatementResultResponse_totalNumRows - 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.
$sel:httpStatus:GetStatementResultResponse', getStatementResultResponse_httpStatus - The response's http status code.
$sel:records:GetStatementResultResponse', getStatementResultResponse_records - The results of the SQL statement.
ListDatabases (Paginated)
data ListDatabases Source #
See: newListDatabases smart constructor.
Constructors
| ListDatabases' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ListDatabases |
Create a value of ListDatabases with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterIdentifier:ListDatabases', listDatabases_clusterIdentifier - The cluster identifier. This parameter is required when connecting to a
cluster and authenticating using either Secrets Manager or temporary
credentials.
$sel:dbUser:ListDatabases', listDatabases_dbUser - The database user name. This parameter is required when connecting to a
cluster and authenticating using temporary credentials.
$sel:maxResults:ListDatabases', listDatabases_maxResults - 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.
ListDatabases, listDatabases_nextToken - 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.
ListDatabases, listDatabases_secretArn - The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
$sel:workgroupName:ListDatabases', listDatabases_workgroupName - The serverless workgroup name. This parameter is required when
connecting to a serverless workgroup and authenticating using either
Secrets Manager or temporary credentials.
$sel:database:ListDatabases', listDatabases_database - The name of the database. This parameter is required when authenticating
using either Secrets Manager or temporary credentials.
data ListDatabasesResponse Source #
See: newListDatabasesResponse smart constructor.
Instances
newListDatabasesResponse Source #
Create a value of ListDatabasesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:databases:ListDatabasesResponse', listDatabasesResponse_databases - The names of databases.
ListDatabases, listDatabasesResponse_nextToken - 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.
$sel:httpStatus:ListDatabasesResponse', listDatabasesResponse_httpStatus - The response's http status code.
ListSchemas (Paginated)
data ListSchemas Source #
See: newListSchemas smart constructor.
Constructors
| ListSchemas' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ListSchemas |
Create a value of ListSchemas with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterIdentifier:ListSchemas', listSchemas_clusterIdentifier - The cluster identifier. This parameter is required when connecting to a
cluster and authenticating using either Secrets Manager or temporary
credentials.
$sel:connectedDatabase:ListSchemas', listSchemas_connectedDatabase - A database name. The connected database is specified when you connect
with your authentication credentials.
$sel:dbUser:ListSchemas', listSchemas_dbUser - The database user name. This parameter is required when connecting to a
cluster and authenticating using temporary credentials.
$sel:maxResults:ListSchemas', listSchemas_maxResults - 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.
ListSchemas, listSchemas_nextToken - 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.
$sel:schemaPattern:ListSchemas', listSchemas_schemaPattern - 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.
ListSchemas, listSchemas_secretArn - The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
$sel:workgroupName:ListSchemas', listSchemas_workgroupName - The serverless workgroup name. This parameter is required when
connecting to a serverless workgroup and authenticating using either
Secrets Manager or temporary credentials.
$sel:database:ListSchemas', listSchemas_database - 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.
data ListSchemasResponse Source #
See: newListSchemasResponse smart constructor.
Instances
newListSchemasResponse Source #
Arguments
| :: Int | |
| -> ListSchemasResponse |
Create a value of ListSchemasResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListSchemas, listSchemasResponse_nextToken - 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.
$sel:schemas:ListSchemasResponse', listSchemasResponse_schemas - The schemas that match the request pattern.
$sel:httpStatus:ListSchemasResponse', listSchemasResponse_httpStatus - The response's http status code.
ListStatements (Paginated)
data ListStatements Source #
See: newListStatements smart constructor.
Constructors
| ListStatements' (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe StatusString) |
Instances
newListStatements :: ListStatements Source #
Create a value of ListStatements with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListStatements', listStatements_maxResults - 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.
ListStatements, listStatements_nextToken - 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.
$sel:roleLevel:ListStatements', listStatements_roleLevel - 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.
ListStatements, listStatements_statementName - 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.
ListStatements, listStatements_status - 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.
data ListStatementsResponse Source #
See: newListStatementsResponse smart constructor.
Constructors
| ListStatementsResponse' (Maybe Text) Int [StatementData] |
Instances
newListStatementsResponse Source #
Create a value of ListStatementsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListStatements, listStatementsResponse_nextToken - 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.
$sel:httpStatus:ListStatementsResponse', listStatementsResponse_httpStatus - The response's http status code.
$sel:statements:ListStatementsResponse', listStatementsResponse_statements - The SQL statements.
ListTables (Paginated)
data ListTables Source #
See: newListTables smart constructor.
Constructors
| ListTables' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ListTables |
Create a value of ListTables with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clusterIdentifier:ListTables', listTables_clusterIdentifier - The cluster identifier. This parameter is required when connecting to a
cluster and authenticating using either Secrets Manager or temporary
credentials.
$sel:connectedDatabase:ListTables', listTables_connectedDatabase - A database name. The connected database is specified when you connect
with your authentication credentials.
$sel:dbUser:ListTables', listTables_dbUser - The database user name. This parameter is required when connecting to a
cluster and authenticating using temporary credentials.
$sel:maxResults:ListTables', listTables_maxResults - 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.
ListTables, listTables_nextToken - 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.
$sel:schemaPattern:ListTables', listTables_schemaPattern - 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.
ListTables, listTables_secretArn - The name or ARN of the secret that enables access to the database. This
parameter is required when authenticating using Secrets Manager.
$sel:tablePattern:ListTables', listTables_tablePattern - 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 SchemaPatternare returned. If neither SchemaPattern or
TablePattern are specified, then all tables are returned.
$sel:workgroupName:ListTables', listTables_workgroupName - The serverless workgroup name. This parameter is required when
connecting to a serverless workgroup and authenticating using either
Secrets Manager or temporary credentials.
$sel:database:ListTables', listTables_database - 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.
data ListTablesResponse Source #
See: newListTablesResponse smart constructor.
Constructors
| ListTablesResponse' (Maybe Text) (Maybe [TableMember]) Int |
Instances
newListTablesResponse Source #
Arguments
| :: Int | |
| -> ListTablesResponse |
Create a value of ListTablesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTables, listTablesResponse_nextToken - 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.
$sel:tables:ListTablesResponse', listTablesResponse_tables - The tables that match the request pattern.
$sel:httpStatus:ListTablesResponse', listTablesResponse_httpStatus - The response's http status code.
Types
StatementStatusString
newtype StatementStatusString Source #
Constructors
| StatementStatusString' | |
Fields | |
Bundled Patterns
| pattern StatementStatusString_ABORTED :: StatementStatusString | |
| pattern StatementStatusString_FAILED :: StatementStatusString | |
| pattern StatementStatusString_FINISHED :: StatementStatusString | |
| pattern StatementStatusString_PICKED :: StatementStatusString | |
| pattern StatementStatusString_STARTED :: StatementStatusString | |
| pattern StatementStatusString_SUBMITTED :: StatementStatusString |
Instances
StatusString
newtype StatusString Source #
Constructors
| StatusString' | |
Fields | |
Bundled Patterns
| pattern StatusString_ABORTED :: StatusString | |
| pattern StatusString_ALL :: StatusString | |
| pattern StatusString_FAILED :: StatusString | |
| pattern StatusString_FINISHED :: StatusString | |
| pattern StatusString_PICKED :: StatusString | |
| pattern StatusString_STARTED :: StatusString | |
| pattern StatusString_SUBMITTED :: StatusString |
Instances
ColumnMetadata
data ColumnMetadata Source #
The properties (metadata) of a column.
See: newColumnMetadata smart constructor.
Constructors
| ColumnMetadata' (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newColumnMetadata :: ColumnMetadata Source #
Create a value of ColumnMetadata with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnDefault:ColumnMetadata', columnMetadata_columnDefault - The default value of the column.
$sel:isCaseSensitive:ColumnMetadata', columnMetadata_isCaseSensitive - A value that indicates whether the column is case-sensitive.
$sel:isCurrency:ColumnMetadata', columnMetadata_isCurrency - A value that indicates whether the column contains currency values.
$sel:isSigned:ColumnMetadata', columnMetadata_isSigned - A value that indicates whether an integer column is signed.
$sel:label:ColumnMetadata', columnMetadata_label - The label for the column.
$sel:length:ColumnMetadata', columnMetadata_length - The length of the column.
$sel:name:ColumnMetadata', columnMetadata_name - The name of the column.
$sel:nullable:ColumnMetadata', columnMetadata_nullable - A value that indicates whether the column is nullable.
$sel:precision:ColumnMetadata', columnMetadata_precision - The precision value of a decimal number column.
$sel:scale:ColumnMetadata', columnMetadata_scale - The scale value of a decimal number column.
$sel:schemaName:ColumnMetadata', columnMetadata_schemaName - The name of the schema that contains the table that includes the column.
$sel:tableName:ColumnMetadata', columnMetadata_tableName - The name of the table that includes the column.
$sel:typeName:ColumnMetadata', columnMetadata_typeName - The database-specific data type of the column.
Field
A data value in a column.
See: newField smart constructor.
Constructors
| Field' (Maybe Base64) (Maybe Bool) (Maybe Double) (Maybe Bool) (Maybe Integer) (Maybe Text) |
Instances
Create a value of Field with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blobValue:Field', field_blobValue - A value of the BLOB data type.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
$sel:booleanValue:Field', field_booleanValue - A value of the Boolean data type.
$sel:doubleValue:Field', field_doubleValue - A value of the double data type.
$sel:isNull:Field', field_isNull - A value that indicates whether the data is NULL.
$sel:longValue:Field', field_longValue - A value of the long data type.
$sel:stringValue:Field', field_stringValue - A value of the string data type.
SqlParameter
data SqlParameter Source #
A parameter used in a SQL statement.
See: newSqlParameter smart constructor.
Constructors
| SqlParameter' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> SqlParameter |
Create a value of SqlParameter with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SqlParameter', sqlParameter_name - The name of the parameter.
$sel:value:SqlParameter', sqlParameter_value - The value of the parameter. Amazon Redshift implicitly converts to the
proper data type. For more information, see
Data types
in the Amazon Redshift Database Developer Guide.
StatementData
data StatementData Source #
The SQL statement to run.
See: newStatementData smart constructor.
Constructors
| StatementData' (Maybe POSIX) (Maybe Bool) (Maybe (NonEmpty SqlParameter)) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe StatusString) (Maybe POSIX) Text |
Instances
Arguments
| :: Text | |
| -> StatementData |
Create a value of StatementData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:StatementData', statementData_createdAt - The date and time (UTC) the statement was created.
$sel:isBatchStatement:StatementData', statementData_isBatchStatement - A value that indicates whether the statement is a batch query request.
$sel:queryParameters:StatementData', statementData_queryParameters - The parameters used in a SQL statement.
$sel:queryString:StatementData', statementData_queryString - The SQL statement.
$sel:queryStrings:StatementData', statementData_queryStrings - One or more SQL statements. Each query string in the array corresponds
to one of the queries in a batch query request.
$sel:secretArn:StatementData', statementData_secretArn - The name or Amazon Resource Name (ARN) of the secret that enables access
to the database.
$sel:statementName:StatementData', statementData_statementName - The name of the SQL statement.
$sel:status:StatementData', statementData_status - The status of the SQL statement. An example is the that the SQL
statement finished.
$sel:updatedAt:StatementData', statementData_updatedAt - The date and time (UTC) that the statement metadata was last updated.
$sel:id:StatementData', statementData_id - The SQL statement identifier. This value is a universally unique
identifier (UUID) generated by Amazon Redshift Data API.
SubStatementData
data SubStatementData Source #
Information about an SQL statement.
See: newSubStatementData smart constructor.
Constructors
| SubStatementData' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe StatementStatusString) (Maybe POSIX) Text |
Instances
Arguments
| :: Text | |
| -> SubStatementData |
Create a value of SubStatementData with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:SubStatementData', subStatementData_createdAt - The date and time (UTC) the statement was created.
$sel:duration:SubStatementData', subStatementData_duration - The amount of time in nanoseconds that the statement ran.
$sel:error:SubStatementData', subStatementData_error - The error message from the cluster if the SQL statement encountered an
error while running.
$sel:hasResultSet:SubStatementData', subStatementData_hasResultSet - A value that indicates whether the statement has a result set. The
result set can be empty. The value is true for an empty result set.
$sel:queryString:SubStatementData', subStatementData_queryString - The SQL statement text.
$sel:redshiftQueryId:SubStatementData', subStatementData_redshiftQueryId - The SQL statement identifier. This value is a universally unique
identifier (UUID) generated by Amazon Redshift Data API.
$sel:resultRows:SubStatementData', subStatementData_resultRows - 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.
$sel:resultSize:SubStatementData', subStatementData_resultSize - The size in bytes of the returned results. A -1 indicates the value is
null.
$sel:status:SubStatementData', subStatementData_status - The status of the SQL statement. An example is the that the SQL
statement finished.
$sel:updatedAt:SubStatementData', subStatementData_updatedAt - The date and time (UTC) that the statement metadata was last updated.
$sel:id:SubStatementData', subStatementData_id - 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.
TableMember
data TableMember Source #
The properties of a table.
See: newTableMember smart constructor.
Instances
newTableMember :: TableMember Source #
Create a value of TableMember with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:TableMember', tableMember_name - The name of the table.
$sel:schema:TableMember', tableMember_schema - The schema containing the table.
$sel:type':TableMember', tableMember_type - The type of the table. Possible values include TABLE, VIEW, SYSTEM
TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.