-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Amazon Redshift Data API Service SDK. -- -- Derived from API version 2019-12-20 of the AWS service -- descriptions, licensed under Apache 2.0. -- -- The types from this library are intended to be used with -- amazonka, which provides mechanisms for specifying AuthN/AuthZ -- information, sending requests, and receiving responses. -- -- It is recommended to use generic lenses or optics from packages such -- as generic-lens or optics to modify optional fields and -- deconstruct responses. -- -- Generated lenses can be found in Amazonka.RedshiftData.Lens and -- are suitable for use with a lens package such as lens or -- lens-family-core. -- -- See Amazonka.RedshiftData and the AWS documentation to -- get started. @package amazonka-redshift-data @version 2.0 module Amazonka.RedshiftData.Types.ColumnMetadata -- | The properties (metadata) of a column. -- -- See: newColumnMetadata smart constructor. 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 -> ColumnMetadata -- | The default value of the column. [$sel:columnDefault:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | A value that indicates whether the column is case-sensitive. [$sel:isCaseSensitive:ColumnMetadata'] :: ColumnMetadata -> Maybe Bool -- | A value that indicates whether the column contains currency values. [$sel:isCurrency:ColumnMetadata'] :: ColumnMetadata -> Maybe Bool -- | A value that indicates whether an integer column is signed. [$sel:isSigned:ColumnMetadata'] :: ColumnMetadata -> Maybe Bool -- | The label for the column. [$sel:label:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | The length of the column. [$sel:length:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The name of the column. [$sel:name:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | A value that indicates whether the column is nullable. [$sel:nullable:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The precision value of a decimal number column. [$sel:precision:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The scale value of a decimal number column. [$sel:scale:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The name of the schema that contains the table that includes the -- column. [$sel:schemaName:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | The name of the table that includes the column. [$sel:tableName:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | The database-specific data type of the column. [$sel:typeName:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | 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. newColumnMetadata :: ColumnMetadata -- | The default value of the column. columnMetadata_columnDefault :: Lens' ColumnMetadata (Maybe Text) -- | A value that indicates whether the column is case-sensitive. columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool) -- | A value that indicates whether the column contains currency values. columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool) -- | A value that indicates whether an integer column is signed. columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool) -- | The label for the column. columnMetadata_label :: Lens' ColumnMetadata (Maybe Text) -- | The length of the column. columnMetadata_length :: Lens' ColumnMetadata (Maybe Int) -- | The name of the column. columnMetadata_name :: Lens' ColumnMetadata (Maybe Text) -- | A value that indicates whether the column is nullable. columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int) -- | The precision value of a decimal number column. columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int) -- | The scale value of a decimal number column. columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int) -- | The name of the schema that contains the table that includes the -- column. columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text) -- | The name of the table that includes the column. columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text) -- | The database-specific data type of the column. columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text) instance GHC.Generics.Generic Amazonka.RedshiftData.Types.ColumnMetadata.ColumnMetadata instance GHC.Show.Show Amazonka.RedshiftData.Types.ColumnMetadata.ColumnMetadata instance GHC.Read.Read Amazonka.RedshiftData.Types.ColumnMetadata.ColumnMetadata instance GHC.Classes.Eq Amazonka.RedshiftData.Types.ColumnMetadata.ColumnMetadata instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.ColumnMetadata.ColumnMetadata instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.ColumnMetadata.ColumnMetadata instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.ColumnMetadata.ColumnMetadata module Amazonka.RedshiftData.Types.Field -- | A data value in a column. -- -- See: newField smart constructor. data Field Field' :: Maybe Base64 -> Maybe Bool -> Maybe Double -> Maybe Bool -> Maybe Integer -> Maybe Text -> Field -- | A value of the BLOB data type. [$sel:blobValue:Field'] :: Field -> Maybe Base64 -- | A value of the Boolean data type. [$sel:booleanValue:Field'] :: Field -> Maybe Bool -- | A value of the double data type. [$sel:doubleValue:Field'] :: Field -> Maybe Double -- | A value that indicates whether the data is NULL. [$sel:isNull:Field'] :: Field -> Maybe Bool -- | A value of the long data type. [$sel:longValue:Field'] :: Field -> Maybe Integer -- | A value of the string data type. [$sel:stringValue:Field'] :: Field -> Maybe Text -- | 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. newField :: Field -- | 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. field_blobValue :: Lens' Field (Maybe ByteString) -- | A value of the Boolean data type. field_booleanValue :: Lens' Field (Maybe Bool) -- | A value of the double data type. field_doubleValue :: Lens' Field (Maybe Double) -- | A value that indicates whether the data is NULL. field_isNull :: Lens' Field (Maybe Bool) -- | A value of the long data type. field_longValue :: Lens' Field (Maybe Integer) -- | A value of the string data type. field_stringValue :: Lens' Field (Maybe Text) instance GHC.Generics.Generic Amazonka.RedshiftData.Types.Field.Field instance GHC.Show.Show Amazonka.RedshiftData.Types.Field.Field instance GHC.Read.Read Amazonka.RedshiftData.Types.Field.Field instance GHC.Classes.Eq Amazonka.RedshiftData.Types.Field.Field instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.Field.Field instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.Field.Field instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.Field.Field module Amazonka.RedshiftData.Types.SqlParameter -- | A parameter used in a SQL statement. -- -- See: newSqlParameter smart constructor. data SqlParameter SqlParameter' :: Text -> Text -> SqlParameter -- | The name of the parameter. [$sel:name:SqlParameter'] :: SqlParameter -> Text -- | 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. [$sel:value:SqlParameter'] :: SqlParameter -> Text -- | 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. newSqlParameter :: Text -> Text -> SqlParameter -- | The name of the parameter. sqlParameter_name :: Lens' SqlParameter Text -- | 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_value :: Lens' SqlParameter Text instance GHC.Generics.Generic Amazonka.RedshiftData.Types.SqlParameter.SqlParameter instance GHC.Show.Show Amazonka.RedshiftData.Types.SqlParameter.SqlParameter instance GHC.Read.Read Amazonka.RedshiftData.Types.SqlParameter.SqlParameter instance GHC.Classes.Eq Amazonka.RedshiftData.Types.SqlParameter.SqlParameter instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.SqlParameter.SqlParameter instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.SqlParameter.SqlParameter instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.SqlParameter.SqlParameter instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.Types.SqlParameter.SqlParameter module Amazonka.RedshiftData.Types.StatementStatusString newtype StatementStatusString StatementStatusString' :: Text -> StatementStatusString [fromStatementStatusString] :: StatementStatusString -> Text pattern StatementStatusString_ABORTED :: StatementStatusString pattern StatementStatusString_FAILED :: StatementStatusString pattern StatementStatusString_FINISHED :: StatementStatusString pattern StatementStatusString_PICKED :: StatementStatusString pattern StatementStatusString_STARTED :: StatementStatusString pattern StatementStatusString_SUBMITTED :: StatementStatusString instance Amazonka.Data.XML.ToXML Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Amazonka.Data.XML.FromXML Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Amazonka.Data.Headers.ToHeader Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Amazonka.Data.Log.ToLog Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Amazonka.Data.ByteString.ToByteString Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Amazonka.Data.Text.ToText Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Amazonka.Data.Text.FromText Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance GHC.Generics.Generic Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance GHC.Classes.Ord Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance GHC.Classes.Eq Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance GHC.Read.Read Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString instance GHC.Show.Show Amazonka.RedshiftData.Types.StatementStatusString.StatementStatusString module Amazonka.RedshiftData.Types.StatusString newtype StatusString StatusString' :: Text -> StatusString [fromStatusString] :: StatusString -> Text 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 instance Amazonka.Data.XML.ToXML Amazonka.RedshiftData.Types.StatusString.StatusString instance Amazonka.Data.XML.FromXML Amazonka.RedshiftData.Types.StatusString.StatusString instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.RedshiftData.Types.StatusString.StatusString instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.Types.StatusString.StatusString instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.RedshiftData.Types.StatusString.StatusString instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.StatusString.StatusString instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.Types.StatusString.StatusString instance Amazonka.Data.Headers.ToHeader Amazonka.RedshiftData.Types.StatusString.StatusString instance Amazonka.Data.Log.ToLog Amazonka.RedshiftData.Types.StatusString.StatusString instance Amazonka.Data.ByteString.ToByteString Amazonka.RedshiftData.Types.StatusString.StatusString instance Amazonka.Data.Text.ToText Amazonka.RedshiftData.Types.StatusString.StatusString instance Amazonka.Data.Text.FromText Amazonka.RedshiftData.Types.StatusString.StatusString instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.StatusString.StatusString instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.StatusString.StatusString instance GHC.Generics.Generic Amazonka.RedshiftData.Types.StatusString.StatusString instance GHC.Classes.Ord Amazonka.RedshiftData.Types.StatusString.StatusString instance GHC.Classes.Eq Amazonka.RedshiftData.Types.StatusString.StatusString instance GHC.Read.Read Amazonka.RedshiftData.Types.StatusString.StatusString instance GHC.Show.Show Amazonka.RedshiftData.Types.StatusString.StatusString module Amazonka.RedshiftData.Types.StatementData -- | The SQL statement to run. -- -- See: newStatementData smart constructor. data StatementData StatementData' :: Maybe POSIX -> Maybe Bool -> Maybe (NonEmpty SqlParameter) -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe StatusString -> Maybe POSIX -> Text -> StatementData -- | The date and time (UTC) the statement was created. [$sel:createdAt:StatementData'] :: StatementData -> Maybe POSIX -- | A value that indicates whether the statement is a batch query request. [$sel:isBatchStatement:StatementData'] :: StatementData -> Maybe Bool -- | The parameters used in a SQL statement. [$sel:queryParameters:StatementData'] :: StatementData -> Maybe (NonEmpty SqlParameter) -- | The SQL statement. [$sel:queryString:StatementData'] :: StatementData -> Maybe Text -- | One or more SQL statements. Each query string in the array corresponds -- to one of the queries in a batch query request. [$sel:queryStrings:StatementData'] :: StatementData -> Maybe [Text] -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. [$sel:secretArn:StatementData'] :: StatementData -> Maybe Text -- | The name of the SQL statement. [$sel:statementName:StatementData'] :: StatementData -> Maybe Text -- | The status of the SQL statement. An example is the that the SQL -- statement finished. [$sel:status:StatementData'] :: StatementData -> Maybe StatusString -- | The date and time (UTC) that the statement metadata was last updated. [$sel:updatedAt:StatementData'] :: StatementData -> Maybe POSIX -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. [$sel:id:StatementData'] :: StatementData -> Text -- | 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. newStatementData :: Text -> StatementData -- | The date and time (UTC) the statement was created. statementData_createdAt :: Lens' StatementData (Maybe UTCTime) -- | A value that indicates whether the statement is a batch query request. statementData_isBatchStatement :: Lens' StatementData (Maybe Bool) -- | The parameters used in a SQL statement. statementData_queryParameters :: Lens' StatementData (Maybe (NonEmpty SqlParameter)) -- | The SQL statement. statementData_queryString :: Lens' StatementData (Maybe Text) -- | One or more SQL statements. Each query string in the array corresponds -- to one of the queries in a batch query request. statementData_queryStrings :: Lens' StatementData (Maybe [Text]) -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. statementData_secretArn :: Lens' StatementData (Maybe Text) -- | The name of the SQL statement. statementData_statementName :: Lens' StatementData (Maybe Text) -- | The status of the SQL statement. An example is the that the SQL -- statement finished. statementData_status :: Lens' StatementData (Maybe StatusString) -- | The date and time (UTC) that the statement metadata was last updated. statementData_updatedAt :: Lens' StatementData (Maybe UTCTime) -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. statementData_id :: Lens' StatementData Text instance GHC.Generics.Generic Amazonka.RedshiftData.Types.StatementData.StatementData instance GHC.Show.Show Amazonka.RedshiftData.Types.StatementData.StatementData instance GHC.Read.Read Amazonka.RedshiftData.Types.StatementData.StatementData instance GHC.Classes.Eq Amazonka.RedshiftData.Types.StatementData.StatementData instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.StatementData.StatementData instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.StatementData.StatementData instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.StatementData.StatementData module Amazonka.RedshiftData.Types.SubStatementData -- | Information about an SQL statement. -- -- See: newSubStatementData smart constructor. data SubStatementData SubStatementData' :: Maybe POSIX -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe StatementStatusString -> Maybe POSIX -> Text -> SubStatementData -- | The date and time (UTC) the statement was created. [$sel:createdAt:SubStatementData'] :: SubStatementData -> Maybe POSIX -- | The amount of time in nanoseconds that the statement ran. [$sel:duration:SubStatementData'] :: SubStatementData -> Maybe Integer -- | The error message from the cluster if the SQL statement encountered an -- error while running. [$sel:error:SubStatementData'] :: SubStatementData -> Maybe Text -- | 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:hasResultSet:SubStatementData'] :: SubStatementData -> Maybe Bool -- | The SQL statement text. [$sel:queryString:SubStatementData'] :: SubStatementData -> Maybe Text -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. [$sel:redshiftQueryId:SubStatementData'] :: SubStatementData -> Maybe 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. [$sel:resultRows:SubStatementData'] :: SubStatementData -> Maybe Integer -- | The size in bytes of the returned results. A -1 indicates the -- value is null. [$sel:resultSize:SubStatementData'] :: SubStatementData -> Maybe Integer -- | The status of the SQL statement. An example is the that the SQL -- statement finished. [$sel:status:SubStatementData'] :: SubStatementData -> Maybe StatementStatusString -- | The date and time (UTC) that the statement metadata was last updated. [$sel:updatedAt:SubStatementData'] :: SubStatementData -> Maybe POSIX -- | 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. [$sel:id:SubStatementData'] :: SubStatementData -> Text -- | 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. newSubStatementData :: Text -> SubStatementData -- | The date and time (UTC) the statement was created. subStatementData_createdAt :: Lens' SubStatementData (Maybe UTCTime) -- | The amount of time in nanoseconds that the statement ran. subStatementData_duration :: Lens' SubStatementData (Maybe Integer) -- | The error message from the cluster if the SQL statement encountered an -- error while running. subStatementData_error :: Lens' SubStatementData (Maybe Text) -- | 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_hasResultSet :: Lens' SubStatementData (Maybe Bool) -- | The SQL statement text. subStatementData_queryString :: Lens' SubStatementData (Maybe Text) -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. subStatementData_redshiftQueryId :: Lens' SubStatementData (Maybe 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. subStatementData_resultRows :: Lens' SubStatementData (Maybe Integer) -- | The size in bytes of the returned results. A -1 indicates the -- value is null. subStatementData_resultSize :: Lens' SubStatementData (Maybe Integer) -- | The status of the SQL statement. An example is the that the SQL -- statement finished. subStatementData_status :: Lens' SubStatementData (Maybe StatementStatusString) -- | The date and time (UTC) that the statement metadata was last updated. subStatementData_updatedAt :: Lens' SubStatementData (Maybe UTCTime) -- | 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_id :: Lens' SubStatementData Text instance GHC.Generics.Generic Amazonka.RedshiftData.Types.SubStatementData.SubStatementData instance GHC.Show.Show Amazonka.RedshiftData.Types.SubStatementData.SubStatementData instance GHC.Read.Read Amazonka.RedshiftData.Types.SubStatementData.SubStatementData instance GHC.Classes.Eq Amazonka.RedshiftData.Types.SubStatementData.SubStatementData instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.SubStatementData.SubStatementData instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.SubStatementData.SubStatementData instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.SubStatementData.SubStatementData module Amazonka.RedshiftData.Types.TableMember -- | The properties of a table. -- -- See: newTableMember smart constructor. data TableMember TableMember' :: Maybe Text -> Maybe Text -> Maybe Text -> TableMember -- | The name of the table. [$sel:name:TableMember'] :: TableMember -> Maybe Text -- | The schema containing the table. [$sel:schema:TableMember'] :: TableMember -> Maybe Text -- | The type of the table. Possible values include TABLE, VIEW, SYSTEM -- TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. [$sel:type':TableMember'] :: TableMember -> Maybe Text -- | 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. newTableMember :: TableMember -- | The name of the table. tableMember_name :: Lens' TableMember (Maybe Text) -- | The schema containing the table. tableMember_schema :: Lens' TableMember (Maybe Text) -- | The type of the table. Possible values include TABLE, VIEW, SYSTEM -- TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. tableMember_type :: Lens' TableMember (Maybe Text) instance GHC.Generics.Generic Amazonka.RedshiftData.Types.TableMember.TableMember instance GHC.Show.Show Amazonka.RedshiftData.Types.TableMember.TableMember instance GHC.Read.Read Amazonka.RedshiftData.Types.TableMember.TableMember instance GHC.Classes.Eq Amazonka.RedshiftData.Types.TableMember.TableMember instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.RedshiftData.Types.TableMember.TableMember instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.Types.TableMember.TableMember instance Control.DeepSeq.NFData Amazonka.RedshiftData.Types.TableMember.TableMember module Amazonka.RedshiftData.Types -- | API version 2019-12-20 of the Amazon Redshift Data API -- Service SDK configuration. defaultService :: Service -- | The number of active statements exceeds the limit. _ActiveStatementsExceededException :: AsError a => Fold a ServiceError -- | An SQL statement encountered an environmental error while running. _BatchExecuteStatementException :: AsError a => Fold a ServiceError -- | Connection to a database failed. _DatabaseConnectionException :: AsError a => Fold a ServiceError -- | The SQL statement encountered an environmental error while running. _ExecuteStatementException :: AsError a => Fold a ServiceError -- | The Amazon Redshift Data API operation failed due to invalid input. _InternalServerException :: AsError a => Fold a ServiceError -- | The Amazon Redshift Data API operation failed due to a missing -- resource. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The Amazon Redshift Data API operation failed due to invalid input. _ValidationException :: AsError a => Fold a ServiceError newtype StatementStatusString StatementStatusString' :: Text -> StatementStatusString [fromStatementStatusString] :: StatementStatusString -> Text 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 StatusString' :: Text -> StatusString [fromStatusString] :: StatusString -> Text 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 -- | The properties (metadata) of a column. -- -- See: newColumnMetadata smart constructor. 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 -> ColumnMetadata -- | The default value of the column. [$sel:columnDefault:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | A value that indicates whether the column is case-sensitive. [$sel:isCaseSensitive:ColumnMetadata'] :: ColumnMetadata -> Maybe Bool -- | A value that indicates whether the column contains currency values. [$sel:isCurrency:ColumnMetadata'] :: ColumnMetadata -> Maybe Bool -- | A value that indicates whether an integer column is signed. [$sel:isSigned:ColumnMetadata'] :: ColumnMetadata -> Maybe Bool -- | The label for the column. [$sel:label:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | The length of the column. [$sel:length:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The name of the column. [$sel:name:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | A value that indicates whether the column is nullable. [$sel:nullable:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The precision value of a decimal number column. [$sel:precision:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The scale value of a decimal number column. [$sel:scale:ColumnMetadata'] :: ColumnMetadata -> Maybe Int -- | The name of the schema that contains the table that includes the -- column. [$sel:schemaName:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | The name of the table that includes the column. [$sel:tableName:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | The database-specific data type of the column. [$sel:typeName:ColumnMetadata'] :: ColumnMetadata -> Maybe Text -- | 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. newColumnMetadata :: ColumnMetadata -- | The default value of the column. columnMetadata_columnDefault :: Lens' ColumnMetadata (Maybe Text) -- | A value that indicates whether the column is case-sensitive. columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool) -- | A value that indicates whether the column contains currency values. columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool) -- | A value that indicates whether an integer column is signed. columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool) -- | The label for the column. columnMetadata_label :: Lens' ColumnMetadata (Maybe Text) -- | The length of the column. columnMetadata_length :: Lens' ColumnMetadata (Maybe Int) -- | The name of the column. columnMetadata_name :: Lens' ColumnMetadata (Maybe Text) -- | A value that indicates whether the column is nullable. columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int) -- | The precision value of a decimal number column. columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int) -- | The scale value of a decimal number column. columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int) -- | The name of the schema that contains the table that includes the -- column. columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text) -- | The name of the table that includes the column. columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text) -- | The database-specific data type of the column. columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text) -- | A data value in a column. -- -- See: newField smart constructor. data Field Field' :: Maybe Base64 -> Maybe Bool -> Maybe Double -> Maybe Bool -> Maybe Integer -> Maybe Text -> Field -- | A value of the BLOB data type. [$sel:blobValue:Field'] :: Field -> Maybe Base64 -- | A value of the Boolean data type. [$sel:booleanValue:Field'] :: Field -> Maybe Bool -- | A value of the double data type. [$sel:doubleValue:Field'] :: Field -> Maybe Double -- | A value that indicates whether the data is NULL. [$sel:isNull:Field'] :: Field -> Maybe Bool -- | A value of the long data type. [$sel:longValue:Field'] :: Field -> Maybe Integer -- | A value of the string data type. [$sel:stringValue:Field'] :: Field -> Maybe Text -- | 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. newField :: Field -- | 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. field_blobValue :: Lens' Field (Maybe ByteString) -- | A value of the Boolean data type. field_booleanValue :: Lens' Field (Maybe Bool) -- | A value of the double data type. field_doubleValue :: Lens' Field (Maybe Double) -- | A value that indicates whether the data is NULL. field_isNull :: Lens' Field (Maybe Bool) -- | A value of the long data type. field_longValue :: Lens' Field (Maybe Integer) -- | A value of the string data type. field_stringValue :: Lens' Field (Maybe Text) -- | A parameter used in a SQL statement. -- -- See: newSqlParameter smart constructor. data SqlParameter SqlParameter' :: Text -> Text -> SqlParameter -- | The name of the parameter. [$sel:name:SqlParameter'] :: SqlParameter -> Text -- | 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. [$sel:value:SqlParameter'] :: SqlParameter -> Text -- | 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. newSqlParameter :: Text -> Text -> SqlParameter -- | The name of the parameter. sqlParameter_name :: Lens' SqlParameter Text -- | 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_value :: Lens' SqlParameter Text -- | The SQL statement to run. -- -- See: newStatementData smart constructor. data StatementData StatementData' :: Maybe POSIX -> Maybe Bool -> Maybe (NonEmpty SqlParameter) -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe StatusString -> Maybe POSIX -> Text -> StatementData -- | The date and time (UTC) the statement was created. [$sel:createdAt:StatementData'] :: StatementData -> Maybe POSIX -- | A value that indicates whether the statement is a batch query request. [$sel:isBatchStatement:StatementData'] :: StatementData -> Maybe Bool -- | The parameters used in a SQL statement. [$sel:queryParameters:StatementData'] :: StatementData -> Maybe (NonEmpty SqlParameter) -- | The SQL statement. [$sel:queryString:StatementData'] :: StatementData -> Maybe Text -- | One or more SQL statements. Each query string in the array corresponds -- to one of the queries in a batch query request. [$sel:queryStrings:StatementData'] :: StatementData -> Maybe [Text] -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. [$sel:secretArn:StatementData'] :: StatementData -> Maybe Text -- | The name of the SQL statement. [$sel:statementName:StatementData'] :: StatementData -> Maybe Text -- | The status of the SQL statement. An example is the that the SQL -- statement finished. [$sel:status:StatementData'] :: StatementData -> Maybe StatusString -- | The date and time (UTC) that the statement metadata was last updated. [$sel:updatedAt:StatementData'] :: StatementData -> Maybe POSIX -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. [$sel:id:StatementData'] :: StatementData -> Text -- | 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. newStatementData :: Text -> StatementData -- | The date and time (UTC) the statement was created. statementData_createdAt :: Lens' StatementData (Maybe UTCTime) -- | A value that indicates whether the statement is a batch query request. statementData_isBatchStatement :: Lens' StatementData (Maybe Bool) -- | The parameters used in a SQL statement. statementData_queryParameters :: Lens' StatementData (Maybe (NonEmpty SqlParameter)) -- | The SQL statement. statementData_queryString :: Lens' StatementData (Maybe Text) -- | One or more SQL statements. Each query string in the array corresponds -- to one of the queries in a batch query request. statementData_queryStrings :: Lens' StatementData (Maybe [Text]) -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. statementData_secretArn :: Lens' StatementData (Maybe Text) -- | The name of the SQL statement. statementData_statementName :: Lens' StatementData (Maybe Text) -- | The status of the SQL statement. An example is the that the SQL -- statement finished. statementData_status :: Lens' StatementData (Maybe StatusString) -- | The date and time (UTC) that the statement metadata was last updated. statementData_updatedAt :: Lens' StatementData (Maybe UTCTime) -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. statementData_id :: Lens' StatementData Text -- | Information about an SQL statement. -- -- See: newSubStatementData smart constructor. data SubStatementData SubStatementData' :: Maybe POSIX -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe StatementStatusString -> Maybe POSIX -> Text -> SubStatementData -- | The date and time (UTC) the statement was created. [$sel:createdAt:SubStatementData'] :: SubStatementData -> Maybe POSIX -- | The amount of time in nanoseconds that the statement ran. [$sel:duration:SubStatementData'] :: SubStatementData -> Maybe Integer -- | The error message from the cluster if the SQL statement encountered an -- error while running. [$sel:error:SubStatementData'] :: SubStatementData -> Maybe Text -- | 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:hasResultSet:SubStatementData'] :: SubStatementData -> Maybe Bool -- | The SQL statement text. [$sel:queryString:SubStatementData'] :: SubStatementData -> Maybe Text -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. [$sel:redshiftQueryId:SubStatementData'] :: SubStatementData -> Maybe 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. [$sel:resultRows:SubStatementData'] :: SubStatementData -> Maybe Integer -- | The size in bytes of the returned results. A -1 indicates the -- value is null. [$sel:resultSize:SubStatementData'] :: SubStatementData -> Maybe Integer -- | The status of the SQL statement. An example is the that the SQL -- statement finished. [$sel:status:SubStatementData'] :: SubStatementData -> Maybe StatementStatusString -- | The date and time (UTC) that the statement metadata was last updated. [$sel:updatedAt:SubStatementData'] :: SubStatementData -> Maybe POSIX -- | 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. [$sel:id:SubStatementData'] :: SubStatementData -> Text -- | 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. newSubStatementData :: Text -> SubStatementData -- | The date and time (UTC) the statement was created. subStatementData_createdAt :: Lens' SubStatementData (Maybe UTCTime) -- | The amount of time in nanoseconds that the statement ran. subStatementData_duration :: Lens' SubStatementData (Maybe Integer) -- | The error message from the cluster if the SQL statement encountered an -- error while running. subStatementData_error :: Lens' SubStatementData (Maybe Text) -- | 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_hasResultSet :: Lens' SubStatementData (Maybe Bool) -- | The SQL statement text. subStatementData_queryString :: Lens' SubStatementData (Maybe Text) -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. subStatementData_redshiftQueryId :: Lens' SubStatementData (Maybe 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. subStatementData_resultRows :: Lens' SubStatementData (Maybe Integer) -- | The size in bytes of the returned results. A -1 indicates the -- value is null. subStatementData_resultSize :: Lens' SubStatementData (Maybe Integer) -- | The status of the SQL statement. An example is the that the SQL -- statement finished. subStatementData_status :: Lens' SubStatementData (Maybe StatementStatusString) -- | The date and time (UTC) that the statement metadata was last updated. subStatementData_updatedAt :: Lens' SubStatementData (Maybe UTCTime) -- | 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_id :: Lens' SubStatementData Text -- | The properties of a table. -- -- See: newTableMember smart constructor. data TableMember TableMember' :: Maybe Text -> Maybe Text -> Maybe Text -> TableMember -- | The name of the table. [$sel:name:TableMember'] :: TableMember -> Maybe Text -- | The schema containing the table. [$sel:schema:TableMember'] :: TableMember -> Maybe Text -- | The type of the table. Possible values include TABLE, VIEW, SYSTEM -- TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. [$sel:type':TableMember'] :: TableMember -> Maybe Text -- | 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. newTableMember :: TableMember -- | The name of the table. tableMember_name :: Lens' TableMember (Maybe Text) -- | The schema containing the table. tableMember_schema :: Lens' TableMember (Maybe Text) -- | The type of the table. Possible values include TABLE, VIEW, SYSTEM -- TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. tableMember_type :: Lens' TableMember (Maybe Text) -- | 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: -- -- -- -- 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. -- -- This operation returns paginated results. module Amazonka.RedshiftData.ListTables -- | See: newListTables smart constructor. data ListTables ListTables' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> ListTables -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. [$sel:clusterIdentifier:ListTables'] :: ListTables -> Maybe Text -- | A database name. The connected database is specified when you connect -- with your authentication credentials. [$sel:connectedDatabase:ListTables'] :: ListTables -> Maybe Text -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. [$sel:dbUser:ListTables'] :: ListTables -> Maybe Text -- | 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. [$sel:maxResults:ListTables'] :: ListTables -> Maybe Natural -- | 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:nextToken:ListTables'] :: ListTables -> Maybe Text -- | 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. [$sel:schemaPattern:ListTables'] :: ListTables -> Maybe Text -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. [$sel:secretArn:ListTables'] :: ListTables -> Maybe Text -- | 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:tablePattern:ListTables'] :: ListTables -> Maybe Text -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. [$sel:workgroupName:ListTables'] :: ListTables -> Maybe Text -- | 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. [$sel:database:ListTables'] :: ListTables -> Text -- | 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. newListTables :: Text -> ListTables -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. listTables_clusterIdentifier :: Lens' ListTables (Maybe Text) -- | A database name. The connected database is specified when you connect -- with your authentication credentials. listTables_connectedDatabase :: Lens' ListTables (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. listTables_dbUser :: Lens' ListTables (Maybe Text) -- | 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_maxResults :: Lens' ListTables (Maybe Natural) -- | 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. listTables_nextToken :: Lens' ListTables (Maybe Text) -- | 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_schemaPattern :: Lens' ListTables (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. listTables_secretArn :: Lens' ListTables (Maybe Text) -- | 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. listTables_tablePattern :: Lens' ListTables (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. listTables_workgroupName :: Lens' ListTables (Maybe Text) -- | 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. listTables_database :: Lens' ListTables Text -- | See: newListTablesResponse smart constructor. data ListTablesResponse ListTablesResponse' :: Maybe Text -> Maybe [TableMember] -> Int -> ListTablesResponse -- | 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:nextToken:ListTablesResponse'] :: ListTablesResponse -> Maybe Text -- | The tables that match the request pattern. [$sel:tables:ListTablesResponse'] :: ListTablesResponse -> Maybe [TableMember] -- | The response's http status code. [$sel:httpStatus:ListTablesResponse'] :: ListTablesResponse -> Int -- | 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. newListTablesResponse :: Int -> ListTablesResponse -- | 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. listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text) -- | The tables that match the request pattern. listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableMember]) -- | The response's http status code. listTablesResponse_httpStatus :: Lens' ListTablesResponse Int instance GHC.Generics.Generic Amazonka.RedshiftData.ListTables.ListTables instance GHC.Show.Show Amazonka.RedshiftData.ListTables.ListTables instance GHC.Read.Read Amazonka.RedshiftData.ListTables.ListTables instance GHC.Classes.Eq Amazonka.RedshiftData.ListTables.ListTables instance GHC.Generics.Generic Amazonka.RedshiftData.ListTables.ListTablesResponse instance GHC.Show.Show Amazonka.RedshiftData.ListTables.ListTablesResponse instance GHC.Read.Read Amazonka.RedshiftData.ListTables.ListTablesResponse instance GHC.Classes.Eq Amazonka.RedshiftData.ListTables.ListTablesResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.ListTables.ListTables instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListTables.ListTablesResponse instance Amazonka.Pager.AWSPager Amazonka.RedshiftData.ListTables.ListTables instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.ListTables.ListTables instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListTables.ListTables instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.ListTables.ListTables instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.ListTables.ListTables instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.ListTables.ListTables instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.ListTables.ListTables -- | List of SQL statements. By default, only finished statements are -- shown. A token is returned to page through the statement list. -- -- For more information about the Amazon Redshift Data API and CLI usage -- examples, see Using the Amazon Redshift Data API in the -- Amazon Redshift Management Guide. -- -- This operation returns paginated results. module Amazonka.RedshiftData.ListStatements -- | See: newListStatements smart constructor. data ListStatements ListStatements' :: Maybe Natural -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe StatusString -> ListStatements -- | 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. [$sel:maxResults:ListStatements'] :: ListStatements -> Maybe Natural -- | 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:nextToken:ListStatements'] :: ListStatements -> Maybe Text -- | 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. [$sel:roleLevel:ListStatements'] :: ListStatements -> Maybe Bool -- | 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. [$sel:statementName:ListStatements'] :: ListStatements -> Maybe Text -- | The status of the SQL statement to list. Status values are defined as -- follows: -- -- [$sel:status:ListStatements'] :: ListStatements -> Maybe StatusString -- | 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: -- -- newListStatements :: ListStatements -- | 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_maxResults :: Lens' ListStatements (Maybe Natural) -- | 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. listStatements_nextToken :: Lens' ListStatements (Maybe Text) -- | 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_roleLevel :: Lens' ListStatements (Maybe Bool) -- | 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_statementName :: Lens' ListStatements (Maybe Text) -- | The status of the SQL statement to list. Status values are defined as -- follows: -- -- listStatements_status :: Lens' ListStatements (Maybe StatusString) -- | See: newListStatementsResponse smart constructor. data ListStatementsResponse ListStatementsResponse' :: Maybe Text -> Int -> [StatementData] -> ListStatementsResponse -- | 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:nextToken:ListStatementsResponse'] :: ListStatementsResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListStatementsResponse'] :: ListStatementsResponse -> Int -- | The SQL statements. [$sel:statements:ListStatementsResponse'] :: ListStatementsResponse -> [StatementData] -- | 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. newListStatementsResponse :: Int -> ListStatementsResponse -- | 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. listStatementsResponse_nextToken :: Lens' ListStatementsResponse (Maybe Text) -- | The response's http status code. listStatementsResponse_httpStatus :: Lens' ListStatementsResponse Int -- | The SQL statements. listStatementsResponse_statements :: Lens' ListStatementsResponse [StatementData] instance GHC.Generics.Generic Amazonka.RedshiftData.ListStatements.ListStatements instance GHC.Show.Show Amazonka.RedshiftData.ListStatements.ListStatements instance GHC.Read.Read Amazonka.RedshiftData.ListStatements.ListStatements instance GHC.Classes.Eq Amazonka.RedshiftData.ListStatements.ListStatements instance GHC.Generics.Generic Amazonka.RedshiftData.ListStatements.ListStatementsResponse instance GHC.Show.Show Amazonka.RedshiftData.ListStatements.ListStatementsResponse instance GHC.Read.Read Amazonka.RedshiftData.ListStatements.ListStatementsResponse instance GHC.Classes.Eq Amazonka.RedshiftData.ListStatements.ListStatementsResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.ListStatements.ListStatements instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListStatements.ListStatementsResponse instance Amazonka.Pager.AWSPager Amazonka.RedshiftData.ListStatements.ListStatements instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.ListStatements.ListStatements instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListStatements.ListStatements instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.ListStatements.ListStatements instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.ListStatements.ListStatements instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.ListStatements.ListStatements instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.ListStatements.ListStatements -- | 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: -- -- -- -- 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. -- -- This operation returns paginated results. module Amazonka.RedshiftData.ListSchemas -- | See: newListSchemas smart constructor. data ListSchemas ListSchemas' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> ListSchemas -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. [$sel:clusterIdentifier:ListSchemas'] :: ListSchemas -> Maybe Text -- | A database name. The connected database is specified when you connect -- with your authentication credentials. [$sel:connectedDatabase:ListSchemas'] :: ListSchemas -> Maybe Text -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. [$sel:dbUser:ListSchemas'] :: ListSchemas -> Maybe Text -- | 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. [$sel:maxResults:ListSchemas'] :: ListSchemas -> Maybe Natural -- | 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:nextToken:ListSchemas'] :: ListSchemas -> Maybe Text -- | 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. [$sel:schemaPattern:ListSchemas'] :: ListSchemas -> Maybe Text -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. [$sel:secretArn:ListSchemas'] :: ListSchemas -> Maybe Text -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. [$sel:workgroupName:ListSchemas'] :: ListSchemas -> Maybe Text -- | 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. [$sel:database:ListSchemas'] :: ListSchemas -> Text -- | 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. newListSchemas :: Text -> ListSchemas -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. listSchemas_clusterIdentifier :: Lens' ListSchemas (Maybe Text) -- | A database name. The connected database is specified when you connect -- with your authentication credentials. listSchemas_connectedDatabase :: Lens' ListSchemas (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. listSchemas_dbUser :: Lens' ListSchemas (Maybe Text) -- | 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_maxResults :: Lens' ListSchemas (Maybe Natural) -- | 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. listSchemas_nextToken :: Lens' ListSchemas (Maybe Text) -- | 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_schemaPattern :: Lens' ListSchemas (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. listSchemas_secretArn :: Lens' ListSchemas (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. listSchemas_workgroupName :: Lens' ListSchemas (Maybe Text) -- | 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. listSchemas_database :: Lens' ListSchemas Text -- | See: newListSchemasResponse smart constructor. data ListSchemasResponse ListSchemasResponse' :: Maybe Text -> Maybe [Text] -> Int -> ListSchemasResponse -- | 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:nextToken:ListSchemasResponse'] :: ListSchemasResponse -> Maybe Text -- | The schemas that match the request pattern. [$sel:schemas:ListSchemasResponse'] :: ListSchemasResponse -> Maybe [Text] -- | The response's http status code. [$sel:httpStatus:ListSchemasResponse'] :: ListSchemasResponse -> Int -- | 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. newListSchemasResponse :: Int -> ListSchemasResponse -- | 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. listSchemasResponse_nextToken :: Lens' ListSchemasResponse (Maybe Text) -- | The schemas that match the request pattern. listSchemasResponse_schemas :: Lens' ListSchemasResponse (Maybe [Text]) -- | The response's http status code. listSchemasResponse_httpStatus :: Lens' ListSchemasResponse Int instance GHC.Generics.Generic Amazonka.RedshiftData.ListSchemas.ListSchemas instance GHC.Show.Show Amazonka.RedshiftData.ListSchemas.ListSchemas instance GHC.Read.Read Amazonka.RedshiftData.ListSchemas.ListSchemas instance GHC.Classes.Eq Amazonka.RedshiftData.ListSchemas.ListSchemas instance GHC.Generics.Generic Amazonka.RedshiftData.ListSchemas.ListSchemasResponse instance GHC.Show.Show Amazonka.RedshiftData.ListSchemas.ListSchemasResponse instance GHC.Read.Read Amazonka.RedshiftData.ListSchemas.ListSchemasResponse instance GHC.Classes.Eq Amazonka.RedshiftData.ListSchemas.ListSchemasResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.ListSchemas.ListSchemas instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListSchemas.ListSchemasResponse instance Amazonka.Pager.AWSPager Amazonka.RedshiftData.ListSchemas.ListSchemas instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.ListSchemas.ListSchemas instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListSchemas.ListSchemas instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.ListSchemas.ListSchemas instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.ListSchemas.ListSchemas instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.ListSchemas.ListSchemas instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.ListSchemas.ListSchemas -- | 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: -- -- -- -- 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. -- -- This operation returns paginated results. module Amazonka.RedshiftData.ListDatabases -- | See: newListDatabases smart constructor. data ListDatabases ListDatabases' :: Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> ListDatabases -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. [$sel:clusterIdentifier:ListDatabases'] :: ListDatabases -> Maybe Text -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. [$sel:dbUser:ListDatabases'] :: ListDatabases -> Maybe Text -- | 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. [$sel:maxResults:ListDatabases'] :: ListDatabases -> Maybe Natural -- | 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:nextToken:ListDatabases'] :: ListDatabases -> Maybe Text -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. [$sel:secretArn:ListDatabases'] :: ListDatabases -> Maybe Text -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. [$sel:workgroupName:ListDatabases'] :: ListDatabases -> Maybe Text -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. [$sel:database:ListDatabases'] :: ListDatabases -> Text -- | 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. newListDatabases :: Text -> ListDatabases -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. listDatabases_clusterIdentifier :: Lens' ListDatabases (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. listDatabases_dbUser :: Lens' ListDatabases (Maybe Text) -- | 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_maxResults :: Lens' ListDatabases (Maybe Natural) -- | 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_nextToken :: Lens' ListDatabases (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. listDatabases_secretArn :: Lens' ListDatabases (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. listDatabases_workgroupName :: Lens' ListDatabases (Maybe Text) -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. listDatabases_database :: Lens' ListDatabases Text -- | See: newListDatabasesResponse smart constructor. data ListDatabasesResponse ListDatabasesResponse' :: Maybe [Text] -> Maybe Text -> Int -> ListDatabasesResponse -- | The names of databases. [$sel:databases:ListDatabasesResponse'] :: ListDatabasesResponse -> Maybe [Text] -- | 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:nextToken:ListDatabasesResponse'] :: ListDatabasesResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ListDatabasesResponse'] :: ListDatabasesResponse -> Int -- | 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. newListDatabasesResponse :: Int -> ListDatabasesResponse -- | The names of databases. listDatabasesResponse_databases :: Lens' ListDatabasesResponse (Maybe [Text]) -- | 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. listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (Maybe Text) -- | The response's http status code. listDatabasesResponse_httpStatus :: Lens' ListDatabasesResponse Int instance GHC.Generics.Generic Amazonka.RedshiftData.ListDatabases.ListDatabases instance GHC.Show.Show Amazonka.RedshiftData.ListDatabases.ListDatabases instance GHC.Read.Read Amazonka.RedshiftData.ListDatabases.ListDatabases instance GHC.Classes.Eq Amazonka.RedshiftData.ListDatabases.ListDatabases instance GHC.Generics.Generic Amazonka.RedshiftData.ListDatabases.ListDatabasesResponse instance GHC.Show.Show Amazonka.RedshiftData.ListDatabases.ListDatabasesResponse instance GHC.Read.Read Amazonka.RedshiftData.ListDatabases.ListDatabasesResponse instance GHC.Classes.Eq Amazonka.RedshiftData.ListDatabases.ListDatabasesResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.ListDatabases.ListDatabases instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListDatabases.ListDatabasesResponse instance Amazonka.Pager.AWSPager Amazonka.RedshiftData.ListDatabases.ListDatabases instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.ListDatabases.ListDatabases instance Control.DeepSeq.NFData Amazonka.RedshiftData.ListDatabases.ListDatabases instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.ListDatabases.ListDatabases instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.ListDatabases.ListDatabases instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.ListDatabases.ListDatabases instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.ListDatabases.ListDatabases -- | Fetches the temporarily cached result of an SQL statement. A token is -- returned to page through the statement results. -- -- For more information about the Amazon Redshift Data API and CLI usage -- examples, see Using the Amazon Redshift Data API in the -- Amazon Redshift Management Guide. -- -- This operation returns paginated results. module Amazonka.RedshiftData.GetStatementResult -- | See: newGetStatementResult smart constructor. data GetStatementResult GetStatementResult' :: Maybe Text -> Text -> GetStatementResult -- | 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:nextToken:GetStatementResult'] :: GetStatementResult -> Maybe Text -- | 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. [$sel:id:GetStatementResult'] :: GetStatementResult -> Text -- | 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. newGetStatementResult :: Text -> GetStatementResult -- | 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_nextToken :: Lens' GetStatementResult (Maybe Text) -- | 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. getStatementResult_id :: Lens' GetStatementResult Text -- | See: newGetStatementResultResponse smart constructor. data GetStatementResultResponse GetStatementResultResponse' :: Maybe [ColumnMetadata] -> Maybe Text -> Maybe Integer -> Int -> [[Field]] -> GetStatementResultResponse -- | The properties (metadata) of a column. [$sel:columnMetadata:GetStatementResultResponse'] :: GetStatementResultResponse -> Maybe [ColumnMetadata] -- | 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:nextToken:GetStatementResultResponse'] :: GetStatementResultResponse -> Maybe Text -- | 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:totalNumRows:GetStatementResultResponse'] :: GetStatementResultResponse -> Maybe Integer -- | The response's http status code. [$sel:httpStatus:GetStatementResultResponse'] :: GetStatementResultResponse -> Int -- | The results of the SQL statement. [$sel:records:GetStatementResultResponse'] :: GetStatementResultResponse -> [[Field]] -- | 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. newGetStatementResultResponse :: Int -> GetStatementResultResponse -- | The properties (metadata) of a column. getStatementResultResponse_columnMetadata :: Lens' GetStatementResultResponse (Maybe [ColumnMetadata]) -- | 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. getStatementResultResponse_nextToken :: Lens' GetStatementResultResponse (Maybe Text) -- | 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. getStatementResultResponse_totalNumRows :: Lens' GetStatementResultResponse (Maybe Integer) -- | The response's http status code. getStatementResultResponse_httpStatus :: Lens' GetStatementResultResponse Int -- | The results of the SQL statement. getStatementResultResponse_records :: Lens' GetStatementResultResponse [[Field]] instance GHC.Generics.Generic Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance GHC.Show.Show Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance GHC.Read.Read Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance GHC.Classes.Eq Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance GHC.Generics.Generic Amazonka.RedshiftData.GetStatementResult.GetStatementResultResponse instance GHC.Show.Show Amazonka.RedshiftData.GetStatementResult.GetStatementResultResponse instance GHC.Read.Read Amazonka.RedshiftData.GetStatementResult.GetStatementResultResponse instance GHC.Classes.Eq Amazonka.RedshiftData.GetStatementResult.GetStatementResultResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance Control.DeepSeq.NFData Amazonka.RedshiftData.GetStatementResult.GetStatementResultResponse instance Amazonka.Pager.AWSPager Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance Control.DeepSeq.NFData Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.GetStatementResult.GetStatementResult instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.GetStatementResult.GetStatementResult -- | 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: -- -- -- -- 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. module Amazonka.RedshiftData.ExecuteStatement -- | See: newExecuteStatement smart constructor. data ExecuteStatement ExecuteStatement' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe (NonEmpty SqlParameter) -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Text -> Text -> Text -> ExecuteStatement -- | A unique, case-sensitive identifier that you provide to ensure the -- idempotency of the request. [$sel:clientToken:ExecuteStatement'] :: ExecuteStatement -> Maybe Text -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. [$sel:clusterIdentifier:ExecuteStatement'] :: ExecuteStatement -> Maybe Text -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. [$sel:dbUser:ExecuteStatement'] :: ExecuteStatement -> Maybe Text -- | The parameters for the SQL statement. [$sel:parameters:ExecuteStatement'] :: ExecuteStatement -> Maybe (NonEmpty SqlParameter) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. [$sel:secretArn:ExecuteStatement'] :: ExecuteStatement -> Maybe Text -- | The name of the SQL statement. You can name the SQL statement when you -- create it to identify the query. [$sel:statementName:ExecuteStatement'] :: ExecuteStatement -> Maybe Text -- | A value that indicates whether to send an event to the Amazon -- EventBridge event bus after the SQL statement runs. [$sel:withEvent:ExecuteStatement'] :: ExecuteStatement -> Maybe Bool -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. [$sel:workgroupName:ExecuteStatement'] :: ExecuteStatement -> Maybe Text -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. [$sel:database:ExecuteStatement'] :: ExecuteStatement -> Text -- | The SQL statement text to run. [$sel:sql:ExecuteStatement'] :: ExecuteStatement -> Text -- | 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. newExecuteStatement :: Text -> Text -> ExecuteStatement -- | A unique, case-sensitive identifier that you provide to ensure the -- idempotency of the request. executeStatement_clientToken :: Lens' ExecuteStatement (Maybe Text) -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. executeStatement_clusterIdentifier :: Lens' ExecuteStatement (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. executeStatement_dbUser :: Lens' ExecuteStatement (Maybe Text) -- | The parameters for the SQL statement. executeStatement_parameters :: Lens' ExecuteStatement (Maybe (NonEmpty SqlParameter)) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. executeStatement_secretArn :: Lens' ExecuteStatement (Maybe Text) -- | The name of the SQL statement. You can name the SQL statement when you -- create it to identify the query. executeStatement_statementName :: Lens' ExecuteStatement (Maybe Text) -- | A value that indicates whether to send an event to the Amazon -- EventBridge event bus after the SQL statement runs. executeStatement_withEvent :: Lens' ExecuteStatement (Maybe Bool) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. executeStatement_workgroupName :: Lens' ExecuteStatement (Maybe Text) -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. executeStatement_database :: Lens' ExecuteStatement Text -- | The SQL statement text to run. executeStatement_sql :: Lens' ExecuteStatement Text -- | See: newExecuteStatementResponse smart constructor. data ExecuteStatementResponse ExecuteStatementResponse' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Int -> ExecuteStatementResponse -- | The cluster identifier. This element is not returned when connecting -- to a serverless workgroup. [$sel:clusterIdentifier:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Maybe Text -- | The date and time (UTC) the statement was created. [$sel:createdAt:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Maybe POSIX -- | The name of the database. [$sel:database:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Maybe Text -- | The database user name. [$sel:dbUser:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Maybe Text -- | 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. [$sel:id:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Maybe Text -- | The name or ARN of the secret that enables access to the database. [$sel:secretArn:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Maybe Text -- | The serverless workgroup name. This element is not returned when -- connecting to a provisioned cluster. [$sel:workgroupName:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:ExecuteStatementResponse'] :: ExecuteStatementResponse -> Int -- | 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. newExecuteStatementResponse :: Int -> ExecuteStatementResponse -- | The cluster identifier. This element is not returned when connecting -- to a serverless workgroup. executeStatementResponse_clusterIdentifier :: Lens' ExecuteStatementResponse (Maybe Text) -- | The date and time (UTC) the statement was created. executeStatementResponse_createdAt :: Lens' ExecuteStatementResponse (Maybe UTCTime) -- | The name of the database. executeStatementResponse_database :: Lens' ExecuteStatementResponse (Maybe Text) -- | The database user name. executeStatementResponse_dbUser :: Lens' ExecuteStatementResponse (Maybe Text) -- | 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. executeStatementResponse_id :: Lens' ExecuteStatementResponse (Maybe Text) -- | The name or ARN of the secret that enables access to the database. executeStatementResponse_secretArn :: Lens' ExecuteStatementResponse (Maybe Text) -- | The serverless workgroup name. This element is not returned when -- connecting to a provisioned cluster. executeStatementResponse_workgroupName :: Lens' ExecuteStatementResponse (Maybe Text) -- | The response's http status code. executeStatementResponse_httpStatus :: Lens' ExecuteStatementResponse Int instance GHC.Generics.Generic Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance GHC.Show.Show Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance GHC.Read.Read Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance GHC.Classes.Eq Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance GHC.Generics.Generic Amazonka.RedshiftData.ExecuteStatement.ExecuteStatementResponse instance GHC.Show.Show Amazonka.RedshiftData.ExecuteStatement.ExecuteStatementResponse instance GHC.Read.Read Amazonka.RedshiftData.ExecuteStatement.ExecuteStatementResponse instance GHC.Classes.Eq Amazonka.RedshiftData.ExecuteStatement.ExecuteStatementResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.ExecuteStatement.ExecuteStatementResponse instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.ExecuteStatement.ExecuteStatement -- | 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: -- -- -- -- 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. -- -- This operation returns paginated results. module Amazonka.RedshiftData.DescribeTable -- | See: newDescribeTable smart constructor. data DescribeTable DescribeTable' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Text -> DescribeTable -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. [$sel:clusterIdentifier:DescribeTable'] :: DescribeTable -> Maybe Text -- | A database name. The connected database is specified when you connect -- with your authentication credentials. [$sel:connectedDatabase:DescribeTable'] :: DescribeTable -> Maybe Text -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. [$sel:dbUser:DescribeTable'] :: DescribeTable -> Maybe Text -- | 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. [$sel:maxResults:DescribeTable'] :: DescribeTable -> Maybe Natural -- | 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:nextToken:DescribeTable'] :: DescribeTable -> Maybe Text -- | The schema that contains the table. If no schema is specified, then -- matching tables for all schemas are returned. [$sel:schema:DescribeTable'] :: DescribeTable -> Maybe Text -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. [$sel:secretArn:DescribeTable'] :: DescribeTable -> Maybe Text -- | 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:table:DescribeTable'] :: DescribeTable -> Maybe Text -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. [$sel:workgroupName:DescribeTable'] :: DescribeTable -> Maybe Text -- | 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. [$sel:database:DescribeTable'] :: DescribeTable -> Text -- | 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. newDescribeTable :: Text -> DescribeTable -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. describeTable_clusterIdentifier :: Lens' DescribeTable (Maybe Text) -- | A database name. The connected database is specified when you connect -- with your authentication credentials. describeTable_connectedDatabase :: Lens' DescribeTable (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. describeTable_dbUser :: Lens' DescribeTable (Maybe Text) -- | 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_maxResults :: Lens' DescribeTable (Maybe Natural) -- | 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_nextToken :: Lens' DescribeTable (Maybe Text) -- | The schema that contains the table. If no schema is specified, then -- matching tables for all schemas are returned. describeTable_schema :: Lens' DescribeTable (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. describeTable_secretArn :: Lens' DescribeTable (Maybe Text) -- | 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 describeTable_table :: Lens' DescribeTable (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. describeTable_workgroupName :: Lens' DescribeTable (Maybe Text) -- | 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. describeTable_database :: Lens' DescribeTable Text -- | See: newDescribeTableResponse smart constructor. data DescribeTableResponse DescribeTableResponse' :: Maybe [ColumnMetadata] -> Maybe Text -> Maybe Text -> Int -> DescribeTableResponse -- | A list of columns in the table. [$sel:columnList:DescribeTableResponse'] :: DescribeTableResponse -> Maybe [ColumnMetadata] -- | 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:nextToken:DescribeTableResponse'] :: DescribeTableResponse -> Maybe Text -- | The table name. [$sel:tableName:DescribeTableResponse'] :: DescribeTableResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:DescribeTableResponse'] :: DescribeTableResponse -> Int -- | 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. newDescribeTableResponse :: Int -> DescribeTableResponse -- | A list of columns in the table. describeTableResponse_columnList :: Lens' DescribeTableResponse (Maybe [ColumnMetadata]) -- | 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_nextToken :: Lens' DescribeTableResponse (Maybe Text) -- | The table name. describeTableResponse_tableName :: Lens' DescribeTableResponse (Maybe Text) -- | The response's http status code. describeTableResponse_httpStatus :: Lens' DescribeTableResponse Int instance GHC.Generics.Generic Amazonka.RedshiftData.DescribeTable.DescribeTable instance GHC.Show.Show Amazonka.RedshiftData.DescribeTable.DescribeTable instance GHC.Read.Read Amazonka.RedshiftData.DescribeTable.DescribeTable instance GHC.Classes.Eq Amazonka.RedshiftData.DescribeTable.DescribeTable instance GHC.Generics.Generic Amazonka.RedshiftData.DescribeTable.DescribeTableResponse instance GHC.Show.Show Amazonka.RedshiftData.DescribeTable.DescribeTableResponse instance GHC.Read.Read Amazonka.RedshiftData.DescribeTable.DescribeTableResponse instance GHC.Classes.Eq Amazonka.RedshiftData.DescribeTable.DescribeTableResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.DescribeTable.DescribeTable instance Control.DeepSeq.NFData Amazonka.RedshiftData.DescribeTable.DescribeTableResponse instance Amazonka.Pager.AWSPager Amazonka.RedshiftData.DescribeTable.DescribeTable instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.DescribeTable.DescribeTable instance Control.DeepSeq.NFData Amazonka.RedshiftData.DescribeTable.DescribeTable instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.DescribeTable.DescribeTable instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.DescribeTable.DescribeTable instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.DescribeTable.DescribeTable instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.DescribeTable.DescribeTable -- | Describes the details about a specific instance when a query was run -- by the Amazon Redshift Data API. The information includes when the -- query started, when it finished, the query status, the number of rows -- returned, and the SQL statement. -- -- For more information about the Amazon Redshift Data API and CLI usage -- examples, see Using the Amazon Redshift Data API in the -- Amazon Redshift Management Guide. module Amazonka.RedshiftData.DescribeStatement -- | See: newDescribeStatement smart constructor. data DescribeStatement DescribeStatement' :: Text -> DescribeStatement -- | 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. [$sel:id:DescribeStatement'] :: DescribeStatement -> Text -- | 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. newDescribeStatement :: Text -> DescribeStatement -- | 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. describeStatement_id :: Lens' DescribeStatement Text -- | See: newDescribeStatementResponse smart constructor. 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 -> DescribeStatementResponse -- | The cluster identifier. [$sel:clusterIdentifier:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Text -- | The date and time (UTC) when the SQL statement was submitted to run. [$sel:createdAt:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe POSIX -- | The name of the database. [$sel:database:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Text -- | The database user name. [$sel:dbUser:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Text -- | The amount of time in nanoseconds that the statement ran. [$sel:duration:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Integer -- | The error message from the cluster if the SQL statement encountered an -- error while running. [$sel:error:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Text -- | 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. [$sel:hasResultSet:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Bool -- | The parameters for the SQL statement. [$sel:queryParameters:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe (NonEmpty SqlParameter) -- | The SQL statement text. [$sel:queryString:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Text -- | The process identifier from Amazon Redshift. [$sel:redshiftPid:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe 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. [$sel:redshiftQueryId:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe 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. [$sel:resultRows:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Integer -- | The size in bytes of the returned results. A -1 indicates the -- value is null. [$sel:resultSize:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Integer -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. [$sel:secretArn:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Text -- | The status of the SQL statement being described. Status values are -- defined as follows: -- -- [$sel:status:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe StatusString -- | The SQL statements from a multiple statement run. [$sel:subStatements:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe [SubStatementData] -- | 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:updatedAt:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe POSIX -- | The serverless workgroup name. [$sel:workgroupName:DescribeStatementResponse'] :: DescribeStatementResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:DescribeStatementResponse'] :: DescribeStatementResponse -> Int -- | The identifier of the SQL statement described. This value is a -- universally unique identifier (UUID) generated by Amazon Redshift Data -- API. [$sel:id:DescribeStatementResponse'] :: DescribeStatementResponse -> Text -- | 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: -- -- -- -- $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. newDescribeStatementResponse :: Int -> Text -> DescribeStatementResponse -- | The cluster identifier. describeStatementResponse_clusterIdentifier :: Lens' DescribeStatementResponse (Maybe Text) -- | The date and time (UTC) when the SQL statement was submitted to run. describeStatementResponse_createdAt :: Lens' DescribeStatementResponse (Maybe UTCTime) -- | The name of the database. describeStatementResponse_database :: Lens' DescribeStatementResponse (Maybe Text) -- | The database user name. describeStatementResponse_dbUser :: Lens' DescribeStatementResponse (Maybe Text) -- | The amount of time in nanoseconds that the statement ran. describeStatementResponse_duration :: Lens' DescribeStatementResponse (Maybe Integer) -- | The error message from the cluster if the SQL statement encountered an -- error while running. describeStatementResponse_error :: Lens' DescribeStatementResponse (Maybe Text) -- | 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_hasResultSet :: Lens' DescribeStatementResponse (Maybe Bool) -- | The parameters for the SQL statement. describeStatementResponse_queryParameters :: Lens' DescribeStatementResponse (Maybe (NonEmpty SqlParameter)) -- | The SQL statement text. describeStatementResponse_queryString :: Lens' DescribeStatementResponse (Maybe Text) -- | The process identifier from Amazon Redshift. describeStatementResponse_redshiftPid :: Lens' DescribeStatementResponse (Maybe 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. describeStatementResponse_redshiftQueryId :: Lens' DescribeStatementResponse (Maybe 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. describeStatementResponse_resultRows :: Lens' DescribeStatementResponse (Maybe Integer) -- | The size in bytes of the returned results. A -1 indicates the -- value is null. describeStatementResponse_resultSize :: Lens' DescribeStatementResponse (Maybe Integer) -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. describeStatementResponse_secretArn :: Lens' DescribeStatementResponse (Maybe Text) -- | The status of the SQL statement being described. Status values are -- defined as follows: -- -- describeStatementResponse_status :: Lens' DescribeStatementResponse (Maybe StatusString) -- | The SQL statements from a multiple statement run. describeStatementResponse_subStatements :: Lens' DescribeStatementResponse (Maybe [SubStatementData]) -- | The date and time (UTC) that the metadata for the SQL statement was -- last updated. An example is the time the status last changed. describeStatementResponse_updatedAt :: Lens' DescribeStatementResponse (Maybe UTCTime) -- | The serverless workgroup name. describeStatementResponse_workgroupName :: Lens' DescribeStatementResponse (Maybe Text) -- | The response's http status code. describeStatementResponse_httpStatus :: Lens' DescribeStatementResponse Int -- | The identifier of the SQL statement described. This value is a -- universally unique identifier (UUID) generated by Amazon Redshift Data -- API. describeStatementResponse_id :: Lens' DescribeStatementResponse Text instance GHC.Generics.Generic Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance GHC.Show.Show Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance GHC.Read.Read Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance GHC.Classes.Eq Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance GHC.Generics.Generic Amazonka.RedshiftData.DescribeStatement.DescribeStatementResponse instance GHC.Show.Show Amazonka.RedshiftData.DescribeStatement.DescribeStatementResponse instance GHC.Read.Read Amazonka.RedshiftData.DescribeStatement.DescribeStatementResponse instance GHC.Classes.Eq Amazonka.RedshiftData.DescribeStatement.DescribeStatementResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.DescribeStatement.DescribeStatementResponse instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.DescribeStatement.DescribeStatement instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.DescribeStatement.DescribeStatement -- | Cancels a running query. To be canceled, a query must be running. -- -- For more information about the Amazon Redshift Data API and CLI usage -- examples, see Using the Amazon Redshift Data API in the -- Amazon Redshift Management Guide. module Amazonka.RedshiftData.CancelStatement -- | See: newCancelStatement smart constructor. data CancelStatement CancelStatement' :: Text -> CancelStatement -- | 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. [$sel:id:CancelStatement'] :: CancelStatement -> Text -- | 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. newCancelStatement :: Text -> CancelStatement -- | 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. cancelStatement_id :: Lens' CancelStatement Text -- | See: newCancelStatementResponse smart constructor. data CancelStatementResponse CancelStatementResponse' :: Maybe Bool -> Int -> CancelStatementResponse -- | A value that indicates whether the cancel statement succeeded (true). [$sel:status:CancelStatementResponse'] :: CancelStatementResponse -> Maybe Bool -- | The response's http status code. [$sel:httpStatus:CancelStatementResponse'] :: CancelStatementResponse -> Int -- | 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. newCancelStatementResponse :: Int -> CancelStatementResponse -- | A value that indicates whether the cancel statement succeeded (true). cancelStatementResponse_status :: Lens' CancelStatementResponse (Maybe Bool) -- | The response's http status code. cancelStatementResponse_httpStatus :: Lens' CancelStatementResponse Int instance GHC.Generics.Generic Amazonka.RedshiftData.CancelStatement.CancelStatement instance GHC.Show.Show Amazonka.RedshiftData.CancelStatement.CancelStatement instance GHC.Read.Read Amazonka.RedshiftData.CancelStatement.CancelStatement instance GHC.Classes.Eq Amazonka.RedshiftData.CancelStatement.CancelStatement instance GHC.Generics.Generic Amazonka.RedshiftData.CancelStatement.CancelStatementResponse instance GHC.Show.Show Amazonka.RedshiftData.CancelStatement.CancelStatementResponse instance GHC.Read.Read Amazonka.RedshiftData.CancelStatement.CancelStatementResponse instance GHC.Classes.Eq Amazonka.RedshiftData.CancelStatement.CancelStatementResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.CancelStatement.CancelStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.CancelStatement.CancelStatementResponse instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.CancelStatement.CancelStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.CancelStatement.CancelStatement instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.CancelStatement.CancelStatement instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.CancelStatement.CancelStatement instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.CancelStatement.CancelStatement instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.CancelStatement.CancelStatement -- | 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: -- -- -- -- 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. module Amazonka.RedshiftData.BatchExecuteStatement -- | See: newBatchExecuteStatement smart constructor. data BatchExecuteStatement BatchExecuteStatement' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Text -> Text -> NonEmpty Text -> BatchExecuteStatement -- | A unique, case-sensitive identifier that you provide to ensure the -- idempotency of the request. [$sel:clientToken:BatchExecuteStatement'] :: BatchExecuteStatement -> Maybe Text -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. [$sel:clusterIdentifier:BatchExecuteStatement'] :: BatchExecuteStatement -> Maybe Text -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. [$sel:dbUser:BatchExecuteStatement'] :: BatchExecuteStatement -> Maybe Text -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. [$sel:secretArn:BatchExecuteStatement'] :: BatchExecuteStatement -> Maybe Text -- | The name of the SQL statements. You can name the SQL statements when -- you create them to identify the query. [$sel:statementName:BatchExecuteStatement'] :: BatchExecuteStatement -> Maybe Text -- | A value that indicates whether to send an event to the Amazon -- EventBridge event bus after the SQL statements run. [$sel:withEvent:BatchExecuteStatement'] :: BatchExecuteStatement -> Maybe Bool -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. [$sel:workgroupName:BatchExecuteStatement'] :: BatchExecuteStatement -> Maybe Text -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. [$sel:database:BatchExecuteStatement'] :: BatchExecuteStatement -> Text -- | 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>
--
[$sel:sqls:BatchExecuteStatement'] :: BatchExecuteStatement -> NonEmpty Text -- | 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>
--
newBatchExecuteStatement :: Text -> NonEmpty Text -> BatchExecuteStatement -- | A unique, case-sensitive identifier that you provide to ensure the -- idempotency of the request. batchExecuteStatement_clientToken :: Lens' BatchExecuteStatement (Maybe Text) -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. batchExecuteStatement_clusterIdentifier :: Lens' BatchExecuteStatement (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. batchExecuteStatement_dbUser :: Lens' BatchExecuteStatement (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. batchExecuteStatement_secretArn :: Lens' BatchExecuteStatement (Maybe Text) -- | The name of the SQL statements. You can name the SQL statements when -- you create them to identify the query. batchExecuteStatement_statementName :: Lens' BatchExecuteStatement (Maybe Text) -- | A value that indicates whether to send an event to the Amazon -- EventBridge event bus after the SQL statements run. batchExecuteStatement_withEvent :: Lens' BatchExecuteStatement (Maybe Bool) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. batchExecuteStatement_workgroupName :: Lens' BatchExecuteStatement (Maybe Text) -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. batchExecuteStatement_database :: Lens' BatchExecuteStatement Text -- | 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>
--
batchExecuteStatement_sqls :: Lens' BatchExecuteStatement (NonEmpty Text) -- | See: newBatchExecuteStatementResponse smart constructor. data BatchExecuteStatementResponse BatchExecuteStatementResponse' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Int -> BatchExecuteStatementResponse -- | The cluster identifier. This element is not returned when connecting -- to a serverless workgroup. [$sel:clusterIdentifier:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Maybe Text -- | The date and time (UTC) the statement was created. [$sel:createdAt:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Maybe POSIX -- | The name of the database. [$sel:database:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Maybe Text -- | The database user name. [$sel:dbUser:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Maybe Text -- | 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. [$sel:id:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Maybe Text -- | The name or ARN of the secret that enables access to the database. [$sel:secretArn:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Maybe Text -- | The serverless workgroup name. This element is not returned when -- connecting to a provisioned cluster. [$sel:workgroupName:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Maybe Text -- | The response's http status code. [$sel:httpStatus:BatchExecuteStatementResponse'] :: BatchExecuteStatementResponse -> Int -- | 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. newBatchExecuteStatementResponse :: Int -> BatchExecuteStatementResponse -- | The cluster identifier. This element is not returned when connecting -- to a serverless workgroup. batchExecuteStatementResponse_clusterIdentifier :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The date and time (UTC) the statement was created. batchExecuteStatementResponse_createdAt :: Lens' BatchExecuteStatementResponse (Maybe UTCTime) -- | The name of the database. batchExecuteStatementResponse_database :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The database user name. batchExecuteStatementResponse_dbUser :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | 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. batchExecuteStatementResponse_id :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The name or ARN of the secret that enables access to the database. batchExecuteStatementResponse_secretArn :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The serverless workgroup name. This element is not returned when -- connecting to a provisioned cluster. batchExecuteStatementResponse_workgroupName :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The response's http status code. batchExecuteStatementResponse_httpStatus :: Lens' BatchExecuteStatementResponse Int instance GHC.Generics.Generic Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance GHC.Show.Show Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance GHC.Read.Read Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance GHC.Classes.Eq Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance GHC.Generics.Generic Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatementResponse instance GHC.Show.Show Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatementResponse instance GHC.Read.Read Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatementResponse instance GHC.Classes.Eq Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatementResponse instance Amazonka.Types.AWSRequest Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatementResponse instance Data.Hashable.Class.Hashable Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance Control.DeepSeq.NFData Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance Amazonka.Data.Headers.ToHeaders Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance Amazonka.Data.Path.ToPath Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement instance Amazonka.Data.Query.ToQuery Amazonka.RedshiftData.BatchExecuteStatement.BatchExecuteStatement module Amazonka.RedshiftData.Lens -- | A unique, case-sensitive identifier that you provide to ensure the -- idempotency of the request. batchExecuteStatement_clientToken :: Lens' BatchExecuteStatement (Maybe Text) -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. batchExecuteStatement_clusterIdentifier :: Lens' BatchExecuteStatement (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. batchExecuteStatement_dbUser :: Lens' BatchExecuteStatement (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. batchExecuteStatement_secretArn :: Lens' BatchExecuteStatement (Maybe Text) -- | The name of the SQL statements. You can name the SQL statements when -- you create them to identify the query. batchExecuteStatement_statementName :: Lens' BatchExecuteStatement (Maybe Text) -- | A value that indicates whether to send an event to the Amazon -- EventBridge event bus after the SQL statements run. batchExecuteStatement_withEvent :: Lens' BatchExecuteStatement (Maybe Bool) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. batchExecuteStatement_workgroupName :: Lens' BatchExecuteStatement (Maybe Text) -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. batchExecuteStatement_database :: Lens' BatchExecuteStatement Text -- | 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>
--
batchExecuteStatement_sqls :: Lens' BatchExecuteStatement (NonEmpty Text) -- | The cluster identifier. This element is not returned when connecting -- to a serverless workgroup. batchExecuteStatementResponse_clusterIdentifier :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The date and time (UTC) the statement was created. batchExecuteStatementResponse_createdAt :: Lens' BatchExecuteStatementResponse (Maybe UTCTime) -- | The name of the database. batchExecuteStatementResponse_database :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The database user name. batchExecuteStatementResponse_dbUser :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | 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. batchExecuteStatementResponse_id :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The name or ARN of the secret that enables access to the database. batchExecuteStatementResponse_secretArn :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The serverless workgroup name. This element is not returned when -- connecting to a provisioned cluster. batchExecuteStatementResponse_workgroupName :: Lens' BatchExecuteStatementResponse (Maybe Text) -- | The response's http status code. batchExecuteStatementResponse_httpStatus :: Lens' BatchExecuteStatementResponse Int -- | 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. cancelStatement_id :: Lens' CancelStatement Text -- | A value that indicates whether the cancel statement succeeded (true). cancelStatementResponse_status :: Lens' CancelStatementResponse (Maybe Bool) -- | The response's http status code. cancelStatementResponse_httpStatus :: Lens' CancelStatementResponse Int -- | 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. describeStatement_id :: Lens' DescribeStatement Text -- | The cluster identifier. describeStatementResponse_clusterIdentifier :: Lens' DescribeStatementResponse (Maybe Text) -- | The date and time (UTC) when the SQL statement was submitted to run. describeStatementResponse_createdAt :: Lens' DescribeStatementResponse (Maybe UTCTime) -- | The name of the database. describeStatementResponse_database :: Lens' DescribeStatementResponse (Maybe Text) -- | The database user name. describeStatementResponse_dbUser :: Lens' DescribeStatementResponse (Maybe Text) -- | The amount of time in nanoseconds that the statement ran. describeStatementResponse_duration :: Lens' DescribeStatementResponse (Maybe Integer) -- | The error message from the cluster if the SQL statement encountered an -- error while running. describeStatementResponse_error :: Lens' DescribeStatementResponse (Maybe Text) -- | 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_hasResultSet :: Lens' DescribeStatementResponse (Maybe Bool) -- | The parameters for the SQL statement. describeStatementResponse_queryParameters :: Lens' DescribeStatementResponse (Maybe (NonEmpty SqlParameter)) -- | The SQL statement text. describeStatementResponse_queryString :: Lens' DescribeStatementResponse (Maybe Text) -- | The process identifier from Amazon Redshift. describeStatementResponse_redshiftPid :: Lens' DescribeStatementResponse (Maybe 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. describeStatementResponse_redshiftQueryId :: Lens' DescribeStatementResponse (Maybe 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. describeStatementResponse_resultRows :: Lens' DescribeStatementResponse (Maybe Integer) -- | The size in bytes of the returned results. A -1 indicates the -- value is null. describeStatementResponse_resultSize :: Lens' DescribeStatementResponse (Maybe Integer) -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. describeStatementResponse_secretArn :: Lens' DescribeStatementResponse (Maybe Text) -- | The status of the SQL statement being described. Status values are -- defined as follows: -- -- describeStatementResponse_status :: Lens' DescribeStatementResponse (Maybe StatusString) -- | The SQL statements from a multiple statement run. describeStatementResponse_subStatements :: Lens' DescribeStatementResponse (Maybe [SubStatementData]) -- | The date and time (UTC) that the metadata for the SQL statement was -- last updated. An example is the time the status last changed. describeStatementResponse_updatedAt :: Lens' DescribeStatementResponse (Maybe UTCTime) -- | The serverless workgroup name. describeStatementResponse_workgroupName :: Lens' DescribeStatementResponse (Maybe Text) -- | The response's http status code. describeStatementResponse_httpStatus :: Lens' DescribeStatementResponse Int -- | The identifier of the SQL statement described. This value is a -- universally unique identifier (UUID) generated by Amazon Redshift Data -- API. describeStatementResponse_id :: Lens' DescribeStatementResponse Text -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. describeTable_clusterIdentifier :: Lens' DescribeTable (Maybe Text) -- | A database name. The connected database is specified when you connect -- with your authentication credentials. describeTable_connectedDatabase :: Lens' DescribeTable (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. describeTable_dbUser :: Lens' DescribeTable (Maybe Text) -- | 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_maxResults :: Lens' DescribeTable (Maybe Natural) -- | 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_nextToken :: Lens' DescribeTable (Maybe Text) -- | The schema that contains the table. If no schema is specified, then -- matching tables for all schemas are returned. describeTable_schema :: Lens' DescribeTable (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. describeTable_secretArn :: Lens' DescribeTable (Maybe Text) -- | 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 describeTable_table :: Lens' DescribeTable (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. describeTable_workgroupName :: Lens' DescribeTable (Maybe Text) -- | 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. describeTable_database :: Lens' DescribeTable Text -- | A list of columns in the table. describeTableResponse_columnList :: Lens' DescribeTableResponse (Maybe [ColumnMetadata]) -- | 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_nextToken :: Lens' DescribeTableResponse (Maybe Text) -- | The table name. describeTableResponse_tableName :: Lens' DescribeTableResponse (Maybe Text) -- | The response's http status code. describeTableResponse_httpStatus :: Lens' DescribeTableResponse Int -- | A unique, case-sensitive identifier that you provide to ensure the -- idempotency of the request. executeStatement_clientToken :: Lens' ExecuteStatement (Maybe Text) -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. executeStatement_clusterIdentifier :: Lens' ExecuteStatement (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. executeStatement_dbUser :: Lens' ExecuteStatement (Maybe Text) -- | The parameters for the SQL statement. executeStatement_parameters :: Lens' ExecuteStatement (Maybe (NonEmpty SqlParameter)) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. executeStatement_secretArn :: Lens' ExecuteStatement (Maybe Text) -- | The name of the SQL statement. You can name the SQL statement when you -- create it to identify the query. executeStatement_statementName :: Lens' ExecuteStatement (Maybe Text) -- | A value that indicates whether to send an event to the Amazon -- EventBridge event bus after the SQL statement runs. executeStatement_withEvent :: Lens' ExecuteStatement (Maybe Bool) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. executeStatement_workgroupName :: Lens' ExecuteStatement (Maybe Text) -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. executeStatement_database :: Lens' ExecuteStatement Text -- | The SQL statement text to run. executeStatement_sql :: Lens' ExecuteStatement Text -- | The cluster identifier. This element is not returned when connecting -- to a serverless workgroup. executeStatementResponse_clusterIdentifier :: Lens' ExecuteStatementResponse (Maybe Text) -- | The date and time (UTC) the statement was created. executeStatementResponse_createdAt :: Lens' ExecuteStatementResponse (Maybe UTCTime) -- | The name of the database. executeStatementResponse_database :: Lens' ExecuteStatementResponse (Maybe Text) -- | The database user name. executeStatementResponse_dbUser :: Lens' ExecuteStatementResponse (Maybe Text) -- | 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. executeStatementResponse_id :: Lens' ExecuteStatementResponse (Maybe Text) -- | The name or ARN of the secret that enables access to the database. executeStatementResponse_secretArn :: Lens' ExecuteStatementResponse (Maybe Text) -- | The serverless workgroup name. This element is not returned when -- connecting to a provisioned cluster. executeStatementResponse_workgroupName :: Lens' ExecuteStatementResponse (Maybe Text) -- | The response's http status code. executeStatementResponse_httpStatus :: Lens' ExecuteStatementResponse Int -- | 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_nextToken :: Lens' GetStatementResult (Maybe Text) -- | 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. getStatementResult_id :: Lens' GetStatementResult Text -- | The properties (metadata) of a column. getStatementResultResponse_columnMetadata :: Lens' GetStatementResultResponse (Maybe [ColumnMetadata]) -- | 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. getStatementResultResponse_nextToken :: Lens' GetStatementResultResponse (Maybe Text) -- | 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. getStatementResultResponse_totalNumRows :: Lens' GetStatementResultResponse (Maybe Integer) -- | The response's http status code. getStatementResultResponse_httpStatus :: Lens' GetStatementResultResponse Int -- | The results of the SQL statement. getStatementResultResponse_records :: Lens' GetStatementResultResponse [[Field]] -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. listDatabases_clusterIdentifier :: Lens' ListDatabases (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. listDatabases_dbUser :: Lens' ListDatabases (Maybe Text) -- | 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_maxResults :: Lens' ListDatabases (Maybe Natural) -- | 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_nextToken :: Lens' ListDatabases (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. listDatabases_secretArn :: Lens' ListDatabases (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. listDatabases_workgroupName :: Lens' ListDatabases (Maybe Text) -- | The name of the database. This parameter is required when -- authenticating using either Secrets Manager or temporary credentials. listDatabases_database :: Lens' ListDatabases Text -- | The names of databases. listDatabasesResponse_databases :: Lens' ListDatabasesResponse (Maybe [Text]) -- | 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. listDatabasesResponse_nextToken :: Lens' ListDatabasesResponse (Maybe Text) -- | The response's http status code. listDatabasesResponse_httpStatus :: Lens' ListDatabasesResponse Int -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. listSchemas_clusterIdentifier :: Lens' ListSchemas (Maybe Text) -- | A database name. The connected database is specified when you connect -- with your authentication credentials. listSchemas_connectedDatabase :: Lens' ListSchemas (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. listSchemas_dbUser :: Lens' ListSchemas (Maybe Text) -- | 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_maxResults :: Lens' ListSchemas (Maybe Natural) -- | 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. listSchemas_nextToken :: Lens' ListSchemas (Maybe Text) -- | 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_schemaPattern :: Lens' ListSchemas (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. listSchemas_secretArn :: Lens' ListSchemas (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. listSchemas_workgroupName :: Lens' ListSchemas (Maybe Text) -- | 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. listSchemas_database :: Lens' ListSchemas Text -- | 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. listSchemasResponse_nextToken :: Lens' ListSchemasResponse (Maybe Text) -- | The schemas that match the request pattern. listSchemasResponse_schemas :: Lens' ListSchemasResponse (Maybe [Text]) -- | The response's http status code. listSchemasResponse_httpStatus :: Lens' ListSchemasResponse Int -- | 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_maxResults :: Lens' ListStatements (Maybe Natural) -- | 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. listStatements_nextToken :: Lens' ListStatements (Maybe Text) -- | 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_roleLevel :: Lens' ListStatements (Maybe Bool) -- | 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_statementName :: Lens' ListStatements (Maybe Text) -- | The status of the SQL statement to list. Status values are defined as -- follows: -- -- listStatements_status :: Lens' ListStatements (Maybe StatusString) -- | 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. listStatementsResponse_nextToken :: Lens' ListStatementsResponse (Maybe Text) -- | The response's http status code. listStatementsResponse_httpStatus :: Lens' ListStatementsResponse Int -- | The SQL statements. listStatementsResponse_statements :: Lens' ListStatementsResponse [StatementData] -- | The cluster identifier. This parameter is required when connecting to -- a cluster and authenticating using either Secrets Manager or temporary -- credentials. listTables_clusterIdentifier :: Lens' ListTables (Maybe Text) -- | A database name. The connected database is specified when you connect -- with your authentication credentials. listTables_connectedDatabase :: Lens' ListTables (Maybe Text) -- | The database user name. This parameter is required when connecting to -- a cluster and authenticating using temporary credentials. listTables_dbUser :: Lens' ListTables (Maybe Text) -- | 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_maxResults :: Lens' ListTables (Maybe Natural) -- | 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. listTables_nextToken :: Lens' ListTables (Maybe Text) -- | 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_schemaPattern :: Lens' ListTables (Maybe Text) -- | The name or ARN of the secret that enables access to the database. -- This parameter is required when authenticating using Secrets Manager. listTables_secretArn :: Lens' ListTables (Maybe Text) -- | 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. listTables_tablePattern :: Lens' ListTables (Maybe Text) -- | The serverless workgroup name. This parameter is required when -- connecting to a serverless workgroup and authenticating using either -- Secrets Manager or temporary credentials. listTables_workgroupName :: Lens' ListTables (Maybe Text) -- | 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. listTables_database :: Lens' ListTables Text -- | 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. listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text) -- | The tables that match the request pattern. listTablesResponse_tables :: Lens' ListTablesResponse (Maybe [TableMember]) -- | The response's http status code. listTablesResponse_httpStatus :: Lens' ListTablesResponse Int -- | The default value of the column. columnMetadata_columnDefault :: Lens' ColumnMetadata (Maybe Text) -- | A value that indicates whether the column is case-sensitive. columnMetadata_isCaseSensitive :: Lens' ColumnMetadata (Maybe Bool) -- | A value that indicates whether the column contains currency values. columnMetadata_isCurrency :: Lens' ColumnMetadata (Maybe Bool) -- | A value that indicates whether an integer column is signed. columnMetadata_isSigned :: Lens' ColumnMetadata (Maybe Bool) -- | The label for the column. columnMetadata_label :: Lens' ColumnMetadata (Maybe Text) -- | The length of the column. columnMetadata_length :: Lens' ColumnMetadata (Maybe Int) -- | The name of the column. columnMetadata_name :: Lens' ColumnMetadata (Maybe Text) -- | A value that indicates whether the column is nullable. columnMetadata_nullable :: Lens' ColumnMetadata (Maybe Int) -- | The precision value of a decimal number column. columnMetadata_precision :: Lens' ColumnMetadata (Maybe Int) -- | The scale value of a decimal number column. columnMetadata_scale :: Lens' ColumnMetadata (Maybe Int) -- | The name of the schema that contains the table that includes the -- column. columnMetadata_schemaName :: Lens' ColumnMetadata (Maybe Text) -- | The name of the table that includes the column. columnMetadata_tableName :: Lens' ColumnMetadata (Maybe Text) -- | The database-specific data type of the column. columnMetadata_typeName :: Lens' ColumnMetadata (Maybe Text) -- | 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. field_blobValue :: Lens' Field (Maybe ByteString) -- | A value of the Boolean data type. field_booleanValue :: Lens' Field (Maybe Bool) -- | A value of the double data type. field_doubleValue :: Lens' Field (Maybe Double) -- | A value that indicates whether the data is NULL. field_isNull :: Lens' Field (Maybe Bool) -- | A value of the long data type. field_longValue :: Lens' Field (Maybe Integer) -- | A value of the string data type. field_stringValue :: Lens' Field (Maybe Text) -- | The name of the parameter. sqlParameter_name :: Lens' SqlParameter Text -- | 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_value :: Lens' SqlParameter Text -- | The date and time (UTC) the statement was created. statementData_createdAt :: Lens' StatementData (Maybe UTCTime) -- | A value that indicates whether the statement is a batch query request. statementData_isBatchStatement :: Lens' StatementData (Maybe Bool) -- | The parameters used in a SQL statement. statementData_queryParameters :: Lens' StatementData (Maybe (NonEmpty SqlParameter)) -- | The SQL statement. statementData_queryString :: Lens' StatementData (Maybe Text) -- | One or more SQL statements. Each query string in the array corresponds -- to one of the queries in a batch query request. statementData_queryStrings :: Lens' StatementData (Maybe [Text]) -- | The name or Amazon Resource Name (ARN) of the secret that enables -- access to the database. statementData_secretArn :: Lens' StatementData (Maybe Text) -- | The name of the SQL statement. statementData_statementName :: Lens' StatementData (Maybe Text) -- | The status of the SQL statement. An example is the that the SQL -- statement finished. statementData_status :: Lens' StatementData (Maybe StatusString) -- | The date and time (UTC) that the statement metadata was last updated. statementData_updatedAt :: Lens' StatementData (Maybe UTCTime) -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. statementData_id :: Lens' StatementData Text -- | The date and time (UTC) the statement was created. subStatementData_createdAt :: Lens' SubStatementData (Maybe UTCTime) -- | The amount of time in nanoseconds that the statement ran. subStatementData_duration :: Lens' SubStatementData (Maybe Integer) -- | The error message from the cluster if the SQL statement encountered an -- error while running. subStatementData_error :: Lens' SubStatementData (Maybe Text) -- | 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_hasResultSet :: Lens' SubStatementData (Maybe Bool) -- | The SQL statement text. subStatementData_queryString :: Lens' SubStatementData (Maybe Text) -- | The SQL statement identifier. This value is a universally unique -- identifier (UUID) generated by Amazon Redshift Data API. subStatementData_redshiftQueryId :: Lens' SubStatementData (Maybe 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. subStatementData_resultRows :: Lens' SubStatementData (Maybe Integer) -- | The size in bytes of the returned results. A -1 indicates the -- value is null. subStatementData_resultSize :: Lens' SubStatementData (Maybe Integer) -- | The status of the SQL statement. An example is the that the SQL -- statement finished. subStatementData_status :: Lens' SubStatementData (Maybe StatementStatusString) -- | The date and time (UTC) that the statement metadata was last updated. subStatementData_updatedAt :: Lens' SubStatementData (Maybe UTCTime) -- | 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_id :: Lens' SubStatementData Text -- | The name of the table. tableMember_name :: Lens' TableMember (Maybe Text) -- | The schema containing the table. tableMember_schema :: Lens' TableMember (Maybe Text) -- | The type of the table. Possible values include TABLE, VIEW, SYSTEM -- TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM. tableMember_type :: Lens' TableMember (Maybe Text) module Amazonka.RedshiftData.Waiters -- | 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. module Amazonka.RedshiftData -- | API version 2019-12-20 of the Amazon Redshift Data API -- Service SDK configuration. defaultService :: Service -- | The number of active statements exceeds the limit. _ActiveStatementsExceededException :: AsError a => Fold a ServiceError -- | An SQL statement encountered an environmental error while running. _BatchExecuteStatementException :: AsError a => Fold a ServiceError -- | Connection to a database failed. _DatabaseConnectionException :: AsError a => Fold a ServiceError -- | The SQL statement encountered an environmental error while running. _ExecuteStatementException :: AsError a => Fold a ServiceError -- | The Amazon Redshift Data API operation failed due to invalid input. _InternalServerException :: AsError a => Fold a ServiceError -- | The Amazon Redshift Data API operation failed due to a missing -- resource. _ResourceNotFoundException :: AsError a => Fold a ServiceError -- | The Amazon Redshift Data API operation failed due to invalid input. _ValidationException :: AsError a => Fold a ServiceError -- | See: newBatchExecuteStatement smart constructor. data BatchExecuteStatement BatchExecuteStatement' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Text -> 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>
--
newBatchExecuteStatement :: Text -> NonEmpty Text -> BatchExecuteStatement -- | See: newBatchExecuteStatementResponse smart constructor. data BatchExecuteStatementResponse BatchExecuteStatementResponse' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Int -> BatchExecuteStatementResponse -- | 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. newBatchExecuteStatementResponse :: Int -> BatchExecuteStatementResponse -- | See: newCancelStatement smart constructor. data CancelStatement CancelStatement' :: 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. newCancelStatement :: Text -> CancelStatement -- | See: newCancelStatementResponse smart constructor. data CancelStatementResponse CancelStatementResponse' :: Maybe Bool -> Int -> CancelStatementResponse -- | 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. newCancelStatementResponse :: Int -> CancelStatementResponse -- | See: newDescribeStatement smart constructor. data DescribeStatement DescribeStatement' :: 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. newDescribeStatement :: Text -> DescribeStatement -- | See: newDescribeStatementResponse smart constructor. 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 -> 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: -- -- -- -- $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. newDescribeStatementResponse :: Int -> Text -> DescribeStatementResponse -- | See: newDescribeTable smart constructor. data DescribeTable DescribeTable' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> 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. newDescribeTable :: Text -> DescribeTable -- | See: newDescribeTableResponse smart constructor. data DescribeTableResponse DescribeTableResponse' :: Maybe [ColumnMetadata] -> Maybe Text -> Maybe Text -> Int -> DescribeTableResponse -- | 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. newDescribeTableResponse :: Int -> DescribeTableResponse -- | See: newExecuteStatement smart constructor. data ExecuteStatement ExecuteStatement' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe (NonEmpty SqlParameter) -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Text -> 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. newExecuteStatement :: Text -> Text -> ExecuteStatement -- | See: newExecuteStatementResponse smart constructor. data ExecuteStatementResponse ExecuteStatementResponse' :: Maybe Text -> Maybe POSIX -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Int -> ExecuteStatementResponse -- | 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. newExecuteStatementResponse :: Int -> ExecuteStatementResponse -- | See: newGetStatementResult smart constructor. data GetStatementResult GetStatementResult' :: Maybe Text -> 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. newGetStatementResult :: Text -> GetStatementResult -- | See: newGetStatementResultResponse smart constructor. data GetStatementResultResponse GetStatementResultResponse' :: Maybe [ColumnMetadata] -> Maybe Text -> Maybe Integer -> Int -> [[Field]] -> GetStatementResultResponse -- | 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. newGetStatementResultResponse :: Int -> GetStatementResultResponse -- | See: newListDatabases smart constructor. data ListDatabases ListDatabases' :: Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> 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. newListDatabases :: Text -> ListDatabases -- | See: newListDatabasesResponse smart constructor. data ListDatabasesResponse ListDatabasesResponse' :: Maybe [Text] -> Maybe Text -> Int -> ListDatabasesResponse -- | 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. newListDatabasesResponse :: Int -> ListDatabasesResponse -- | See: newListSchemas smart constructor. data ListSchemas ListSchemas' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> 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. newListSchemas :: Text -> ListSchemas -- | See: newListSchemasResponse smart constructor. data ListSchemasResponse ListSchemasResponse' :: Maybe Text -> Maybe [Text] -> 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. newListSchemasResponse :: Int -> ListSchemasResponse -- | See: newListStatements smart constructor. data ListStatements ListStatements' :: Maybe Natural -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe StatusString -> ListStatements -- | 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: -- -- newListStatements :: ListStatements -- | See: newListStatementsResponse smart constructor. data ListStatementsResponse ListStatementsResponse' :: Maybe Text -> Int -> [StatementData] -> ListStatementsResponse -- | 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. newListStatementsResponse :: Int -> ListStatementsResponse -- | See: newListTables smart constructor. data ListTables ListTables' :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe Natural -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> 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. newListTables :: Text -> ListTables -- | See: newListTablesResponse smart constructor. data ListTablesResponse ListTablesResponse' :: Maybe Text -> Maybe [TableMember] -> 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. newListTablesResponse :: Int -> ListTablesResponse newtype StatementStatusString StatementStatusString' :: Text -> StatementStatusString [fromStatementStatusString] :: StatementStatusString -> Text 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 StatusString' :: Text -> StatusString [fromStatusString] :: StatusString -> Text 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 -- | The properties (metadata) of a column. -- -- See: newColumnMetadata smart constructor. 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 -> ColumnMetadata -- | 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. newColumnMetadata :: ColumnMetadata -- | A data value in a column. -- -- See: newField smart constructor. data Field Field' :: Maybe Base64 -> Maybe Bool -> Maybe Double -> Maybe Bool -> Maybe Integer -> Maybe Text -> Field -- | 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. newField :: Field -- | A parameter used in a SQL statement. -- -- See: newSqlParameter smart constructor. data SqlParameter SqlParameter' :: 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. newSqlParameter :: Text -> Text -> SqlParameter -- | The SQL statement to run. -- -- See: newStatementData smart constructor. data StatementData StatementData' :: Maybe POSIX -> Maybe Bool -> Maybe (NonEmpty SqlParameter) -> Maybe Text -> Maybe [Text] -> Maybe Text -> Maybe Text -> Maybe StatusString -> Maybe POSIX -> 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. newStatementData :: Text -> StatementData -- | Information about an SQL statement. -- -- See: newSubStatementData smart constructor. data SubStatementData SubStatementData' :: Maybe POSIX -> Maybe Integer -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe StatementStatusString -> Maybe POSIX -> 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. newSubStatementData :: Text -> SubStatementData -- | The properties of a table. -- -- See: newTableMember smart constructor. data TableMember TableMember' :: Maybe Text -> Maybe Text -> Maybe Text -> TableMember -- | 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. newTableMember :: TableMember