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 |
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
- 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' {}
- newColumnMetadata :: ColumnMetadata
- columnMetadata_columnDefault :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool)
- columnMetadata_label :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_length :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_name :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int)
- columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text)
- columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text)
- data Field = Field' {}
- newField :: Field
- field_blobValue :: Lens' Field (Maybe ByteString)
- field_booleanValue :: Lens' Field (Maybe Bool)
- field_doubleValue :: Lens' Field (Maybe Double)
- field_isNull :: Lens' Field (Maybe Bool)
- field_longValue :: Lens' Field (Maybe Integer)
- field_stringValue :: Lens' Field (Maybe Text)
- data SqlParameter = SqlParameter' {}
- newSqlParameter :: Text -> Text -> SqlParameter
- sqlParameter_name :: Lens' SqlParameter Text
- sqlParameter_value :: Lens' SqlParameter Text
- data StatementData = StatementData' {
- createdAt :: Maybe POSIX
- isBatchStatement :: Maybe Bool
- queryParameters :: Maybe (NonEmpty SqlParameter)
- queryString :: Maybe Text
- queryStrings :: Maybe [Text]
- secretArn :: Maybe Text
- statementName :: Maybe Text
- status :: Maybe StatusString
- updatedAt :: Maybe POSIX
- id :: Text
- newStatementData :: Text -> StatementData
- statementData_createdAt :: Lens' StatementData (Maybe UTCTime)
- statementData_isBatchStatement :: Lens' StatementData (Maybe Bool)
- statementData_queryParameters :: Lens' StatementData (Maybe (NonEmpty SqlParameter))
- statementData_queryString :: Lens' StatementData (Maybe Text)
- statementData_queryStrings :: Lens' StatementData (Maybe [Text])
- statementData_secretArn :: Lens' StatementData (Maybe Text)
- statementData_statementName :: Lens' StatementData (Maybe Text)
- statementData_status :: Lens' StatementData (Maybe StatusString)
- statementData_updatedAt :: Lens' StatementData (Maybe UTCTime)
- statementData_id :: Lens' StatementData Text
- data SubStatementData = SubStatementData' {}
- newSubStatementData :: Text -> SubStatementData
- subStatementData_createdAt :: Lens' SubStatementData (Maybe UTCTime)
- subStatementData_duration :: Lens' SubStatementData (Maybe Integer)
- subStatementData_error :: Lens' SubStatementData (Maybe Text)
- subStatementData_hasResultSet :: Lens' SubStatementData (Maybe Bool)
- subStatementData_queryString :: Lens' SubStatementData (Maybe Text)
- subStatementData_redshiftQueryId :: Lens' SubStatementData (Maybe Integer)
- subStatementData_resultRows :: Lens' SubStatementData (Maybe Integer)
- subStatementData_resultSize :: Lens' SubStatementData (Maybe Integer)
- subStatementData_status :: Lens' SubStatementData (Maybe StatementStatusString)
- subStatementData_updatedAt :: Lens' SubStatementData (Maybe UTCTime)
- subStatementData_id :: Lens' SubStatementData Text
- data TableMember = TableMember' {}
- newTableMember :: TableMember
- tableMember_name :: Lens' TableMember (Maybe Text)
- tableMember_schema :: Lens' TableMember (Maybe Text)
- tableMember_type :: Lens' TableMember (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2019-12-20
of the Amazon Redshift Data API Service SDK configuration.
Errors
_ActiveStatementsExceededException :: AsError a => Fold a ServiceError Source #
The number of active statements exceeds the limit.
_BatchExecuteStatementException :: AsError a => Fold a ServiceError Source #
An SQL statement encountered an environmental error while running.
_DatabaseConnectionException :: AsError a => Fold a ServiceError Source #
Connection to a database failed.
_ExecuteStatementException :: AsError a => Fold a ServiceError Source #
The SQL statement encountered an environmental error while running.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The Amazon Redshift Data API operation failed due to invalid input.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The Amazon Redshift Data API operation failed due to a missing resource.
_ValidationException :: AsError a => Fold a ServiceError Source #
The Amazon Redshift Data API operation failed due to invalid input.
StatementStatusString
newtype StatementStatusString Source #
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 #
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.
ColumnMetadata' | |
|
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.
columnMetadata_columnDefault :: Lens' ColumnMetadata (Maybe Text) Source #
The default value of the column.
columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether the column is case-sensitive.
columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether the column contains currency values.
columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool) Source #
A value that indicates whether an integer column is signed.
columnMetadata_label :: Lens' ColumnMetadata (Maybe Text) Source #
The label for the column.
columnMetadata_length :: Lens' ColumnMetadata (Maybe Int) Source #
The length of the column.
columnMetadata_name :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the column.
columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int) Source #
A value that indicates whether the column is nullable.
columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int) Source #
The precision value of a decimal number column.
columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int) Source #
The scale value of a decimal number column.
columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the schema that contains the table that includes the column.
columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text) Source #
The name of the table that includes the column.
columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text) Source #
The database-specific data type of the column.
Field
A data value in a column.
See: newField
smart constructor.
Field' | |
|
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.
field_blobValue :: Lens' Field (Maybe ByteString) Source #
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.
SqlParameter
data SqlParameter Source #
A parameter used in a SQL statement.
See: newSqlParameter
smart constructor.
SqlParameter' | |
|
Instances
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.
sqlParameter_name :: Lens' SqlParameter Text Source #
The name of the parameter.
sqlParameter_value :: Lens' SqlParameter Text Source #
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.
StatementData' | |
|
Instances
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.
statementData_createdAt :: Lens' StatementData (Maybe UTCTime) Source #
The date and time (UTC) the statement was created.
statementData_isBatchStatement :: Lens' StatementData (Maybe Bool) Source #
A value that indicates whether the statement is a batch query request.
statementData_queryParameters :: Lens' StatementData (Maybe (NonEmpty SqlParameter)) Source #
The parameters used in a SQL statement.
statementData_queryString :: Lens' StatementData (Maybe Text) Source #
The SQL statement.
statementData_queryStrings :: Lens' StatementData (Maybe [Text]) Source #
One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.
statementData_secretArn :: Lens' StatementData (Maybe Text) Source #
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
statementData_statementName :: Lens' StatementData (Maybe Text) Source #
The name of the SQL statement.
statementData_status :: Lens' StatementData (Maybe StatusString) Source #
The status of the SQL statement. An example is the that the SQL statement finished.
statementData_updatedAt :: Lens' StatementData (Maybe UTCTime) Source #
The date and time (UTC) that the statement metadata was last updated.
statementData_id :: Lens' StatementData Text Source #
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.
SubStatementData' | |
|
Instances
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.
subStatementData_createdAt :: Lens' SubStatementData (Maybe UTCTime) Source #
The date and time (UTC) the statement was created.
subStatementData_duration :: Lens' SubStatementData (Maybe Integer) Source #
The amount of time in nanoseconds that the statement ran.
subStatementData_error :: Lens' SubStatementData (Maybe Text) Source #
The error message from the cluster if the SQL statement encountered an error while running.
subStatementData_hasResultSet :: Lens' SubStatementData (Maybe Bool) Source #
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.
subStatementData_queryString :: Lens' SubStatementData (Maybe Text) Source #
The SQL statement text.
subStatementData_redshiftQueryId :: Lens' SubStatementData (Maybe Integer) Source #
The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
subStatementData_resultRows :: Lens' SubStatementData (Maybe Integer) Source #
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.
subStatementData_resultSize :: Lens' SubStatementData (Maybe Integer) Source #
The size in bytes of the returned results. A -1
indicates the value is
null.
subStatementData_status :: Lens' SubStatementData (Maybe StatementStatusString) Source #
The status of the SQL statement. An example is the that the SQL statement finished.
subStatementData_updatedAt :: Lens' SubStatementData (Maybe UTCTime) Source #
The date and time (UTC) that the statement metadata was last updated.
subStatementData_id :: Lens' SubStatementData Text Source #
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.
tableMember_name :: Lens' TableMember (Maybe Text) Source #
The name of the table.
tableMember_schema :: Lens' TableMember (Maybe Text) Source #
The schema containing the table.
tableMember_type :: Lens' TableMember (Maybe Text) Source #
The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.