-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon Honeycode SDK.
--
-- Derived from API version 2020-03-01 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.HoneyCode.Lens and
-- are suitable for use with a lens package such as lens or
-- lens-family-core.
--
-- See Amazonka.HoneyCode and the AWS documentation to get
-- started.
@package amazonka-honeycode
@version 2.0
module Amazonka.HoneyCode.Types.CellInput
-- | CellInput object contains the data needed to create or update cells in
-- a table.
--
-- CellInput object has only a facts field or a fact field, but not both.
-- A 400 bad request will be thrown if both fact and facts field are
-- present.
--
-- See: newCellInput smart constructor.
data CellInput
CellInput' :: Maybe (Sensitive Text) -> Maybe [Sensitive Text] -> CellInput
-- | Fact represents the data that is entered into a cell. This data can be
-- free text or a formula. Formulas need to start with the equals (=)
-- sign.
[$sel:fact:CellInput'] :: CellInput -> Maybe (Sensitive Text)
-- | A list representing the values that are entered into a ROWSET cell.
-- Facts list can have either only values or rowIDs, and rowIDs should
-- from the same table.
[$sel:facts:CellInput'] :: CellInput -> Maybe [Sensitive Text]
-- | Create a value of CellInput 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:fact:CellInput', cellInput_fact - Fact represents
-- the data that is entered into a cell. This data can be free text or a
-- formula. Formulas need to start with the equals (=) sign.
--
-- $sel:facts:CellInput', cellInput_facts - A list
-- representing the values that are entered into a ROWSET cell. Facts
-- list can have either only values or rowIDs, and rowIDs should from the
-- same table.
newCellInput :: CellInput
-- | Fact represents the data that is entered into a cell. This data can be
-- free text or a formula. Formulas need to start with the equals (=)
-- sign.
cellInput_fact :: Lens' CellInput (Maybe Text)
-- | A list representing the values that are entered into a ROWSET cell.
-- Facts list can have either only values or rowIDs, and rowIDs should
-- from the same table.
cellInput_facts :: Lens' CellInput (Maybe [Text])
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.CellInput.CellInput
instance GHC.Show.Show Amazonka.HoneyCode.Types.CellInput.CellInput
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.CellInput.CellInput
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.CellInput.CellInput
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.CellInput.CellInput
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.CellInput.CellInput
module Amazonka.HoneyCode.Types.CreateRowData
-- | Data needed to create a single row in a table as part of the
-- BatchCreateTableRows request.
--
-- See: newCreateRowData smart constructor.
data CreateRowData
CreateRowData' :: Text -> HashMap Text CellInput -> CreateRowData
-- | An external identifier that represents the single row that is being
-- created as part of the BatchCreateTableRows request. This can be any
-- string that you can use to identify the row in the request. The
-- BatchCreateTableRows API puts the batch item id in the results to
-- allow you to link data in the request to data in the results.
[$sel:batchItemId:CreateRowData'] :: CreateRowData -> Text
-- | A map representing the cells to create in the new row. The key is the
-- column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
[$sel:cellsToCreate:CreateRowData'] :: CreateRowData -> HashMap Text CellInput
-- | Create a value of CreateRowData 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:batchItemId:CreateRowData',
-- createRowData_batchItemId - An external identifier that
-- represents the single row that is being created as part of the
-- BatchCreateTableRows request. This can be any string that you can use
-- to identify the row in the request. The BatchCreateTableRows API puts
-- the batch item id in the results to allow you to link data in the
-- request to data in the results.
--
-- $sel:cellsToCreate:CreateRowData',
-- createRowData_cellsToCreate - A map representing the cells to
-- create in the new row. The key is the column id of the cell and the
-- value is the CellInput object that represents the data to set in that
-- cell.
newCreateRowData :: Text -> CreateRowData
-- | An external identifier that represents the single row that is being
-- created as part of the BatchCreateTableRows request. This can be any
-- string that you can use to identify the row in the request. The
-- BatchCreateTableRows API puts the batch item id in the results to
-- allow you to link data in the request to data in the results.
createRowData_batchItemId :: Lens' CreateRowData Text
-- | A map representing the cells to create in the new row. The key is the
-- column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
createRowData_cellsToCreate :: Lens' CreateRowData (HashMap Text CellInput)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.CreateRowData.CreateRowData
instance GHC.Show.Show Amazonka.HoneyCode.Types.CreateRowData.CreateRowData
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.CreateRowData.CreateRowData
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.CreateRowData.CreateRowData
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.CreateRowData.CreateRowData
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.CreateRowData.CreateRowData
module Amazonka.HoneyCode.Types.ErrorCode
newtype ErrorCode
ErrorCode' :: Text -> ErrorCode
[fromErrorCode] :: ErrorCode -> Text
pattern ErrorCode_ACCESS_DENIED :: ErrorCode
pattern ErrorCode_FILE_EMPTY_ERROR :: ErrorCode
pattern ErrorCode_FILE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_FILE_PARSING_ERROR :: ErrorCode
pattern ErrorCode_FILE_SIZE_LIMIT_ERROR :: ErrorCode
pattern ErrorCode_INVALID_FILE_TYPE_ERROR :: ErrorCode
pattern ErrorCode_INVALID_IMPORT_OPTIONS_ERROR :: ErrorCode
pattern ErrorCode_INVALID_TABLE_COLUMN_ID_ERROR :: ErrorCode
pattern ErrorCode_INVALID_TABLE_ID_ERROR :: ErrorCode
pattern ErrorCode_INVALID_URL_ERROR :: ErrorCode
pattern ErrorCode_RESOURCE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_SYSTEM_LIMIT_ERROR :: ErrorCode
pattern ErrorCode_TABLE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_UNKNOWN_ERROR :: ErrorCode
instance Amazonka.Data.XML.ToXML Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Amazonka.Data.XML.FromXML Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Amazonka.Data.Headers.ToHeader Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Amazonka.Data.Log.ToLog Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Amazonka.Data.ByteString.ToByteString Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Amazonka.Data.Text.ToText Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Amazonka.Data.Text.FromText Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance GHC.Classes.Ord Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance GHC.Read.Read Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
instance GHC.Show.Show Amazonka.HoneyCode.Types.ErrorCode.ErrorCode
module Amazonka.HoneyCode.Types.FailedBatchItem
-- | A single item in a batch that failed to perform the intended action
-- because of an error preventing it from succeeding.
--
-- See: newFailedBatchItem smart constructor.
data FailedBatchItem
FailedBatchItem' :: Text -> Text -> FailedBatchItem
-- | The id of the batch item that failed. This is the batch item id for
-- the BatchCreateTableRows and BatchUpsertTableRows operations and the
-- row id for the BatchUpdateTableRows and BatchDeleteTableRows
-- operations.
[$sel:id:FailedBatchItem'] :: FailedBatchItem -> Text
-- | The error message that indicates why the batch item failed.
[$sel:errorMessage:FailedBatchItem'] :: FailedBatchItem -> Text
-- | Create a value of FailedBatchItem 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:id:FailedBatchItem', failedBatchItem_id - The id of
-- the batch item that failed. This is the batch item id for the
-- BatchCreateTableRows and BatchUpsertTableRows operations and the row
-- id for the BatchUpdateTableRows and BatchDeleteTableRows operations.
--
-- $sel:errorMessage:FailedBatchItem',
-- failedBatchItem_errorMessage - The error message that indicates
-- why the batch item failed.
newFailedBatchItem :: Text -> Text -> FailedBatchItem
-- | The id of the batch item that failed. This is the batch item id for
-- the BatchCreateTableRows and BatchUpsertTableRows operations and the
-- row id for the BatchUpdateTableRows and BatchDeleteTableRows
-- operations.
failedBatchItem_id :: Lens' FailedBatchItem Text
-- | The error message that indicates why the batch item failed.
failedBatchItem_errorMessage :: Lens' FailedBatchItem Text
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.FailedBatchItem.FailedBatchItem
instance GHC.Show.Show Amazonka.HoneyCode.Types.FailedBatchItem.FailedBatchItem
instance GHC.Read.Read Amazonka.HoneyCode.Types.FailedBatchItem.FailedBatchItem
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.FailedBatchItem.FailedBatchItem
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.FailedBatchItem.FailedBatchItem
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.FailedBatchItem.FailedBatchItem
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.FailedBatchItem.FailedBatchItem
module Amazonka.HoneyCode.Types.Filter
-- | An object that represents a filter formula along with the id of the
-- context row under which the filter function needs to evaluate.
--
-- See: newFilter smart constructor.
data Filter
Filter' :: Maybe Text -> Sensitive Text -> Filter
-- | The optional contextRowId attribute can be used to specify the row id
-- of the context row if the filter formula contains unqualified
-- references to table columns and needs a context row to evaluate them
-- successfully.
[$sel:contextRowId:Filter'] :: Filter -> Maybe Text
-- | A formula representing a filter function that returns zero or more
-- matching rows from a table. Valid formulas in this field return a list
-- of rows from a table. The most common ways of writing a formula to
-- return a list of rows are to use the FindRow() or Filter() functions.
-- Any other formula that returns zero or more rows is also acceptable.
-- For example, you can use a formula that points to a cell that contains
-- a filter function.
[$sel:formula:Filter'] :: Filter -> Sensitive Text
-- | Create a value of Filter 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:contextRowId:Filter', filter_contextRowId - The
-- optional contextRowId attribute can be used to specify the row id of
-- the context row if the filter formula contains unqualified references
-- to table columns and needs a context row to evaluate them
-- successfully.
--
-- $sel:formula:Filter', filter_formula - A formula
-- representing a filter function that returns zero or more matching rows
-- from a table. Valid formulas in this field return a list of rows from
-- a table. The most common ways of writing a formula to return a list of
-- rows are to use the FindRow() or Filter() functions. Any other formula
-- that returns zero or more rows is also acceptable. For example, you
-- can use a formula that points to a cell that contains a filter
-- function.
newFilter :: Text -> Filter
-- | The optional contextRowId attribute can be used to specify the row id
-- of the context row if the filter formula contains unqualified
-- references to table columns and needs a context row to evaluate them
-- successfully.
filter_contextRowId :: Lens' Filter (Maybe Text)
-- | A formula representing a filter function that returns zero or more
-- matching rows from a table. Valid formulas in this field return a list
-- of rows from a table. The most common ways of writing a formula to
-- return a list of rows are to use the FindRow() or Filter() functions.
-- Any other formula that returns zero or more rows is also acceptable.
-- For example, you can use a formula that points to a cell that contains
-- a filter function.
filter_formula :: Lens' Filter Text
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.Filter.Filter
instance GHC.Show.Show Amazonka.HoneyCode.Types.Filter.Filter
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.Filter.Filter
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.Filter.Filter
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.Filter.Filter
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.Filter.Filter
module Amazonka.HoneyCode.Types.Format
newtype Format
Format' :: Text -> Format
[fromFormat] :: Format -> Text
pattern Format_ACCOUNTING :: Format
pattern Format_AUTO :: Format
pattern Format_CONTACT :: Format
pattern Format_CURRENCY :: Format
pattern Format_DATE :: Format
pattern Format_DATE_TIME :: Format
pattern Format_NUMBER :: Format
pattern Format_PERCENTAGE :: Format
pattern Format_ROWLINK :: Format
pattern Format_ROWSET :: Format
pattern Format_TEXT :: Format
pattern Format_TIME :: Format
instance Amazonka.Data.XML.ToXML Amazonka.HoneyCode.Types.Format.Format
instance Amazonka.Data.XML.FromXML Amazonka.HoneyCode.Types.Format.Format
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.HoneyCode.Types.Format.Format
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.Format.Format
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.HoneyCode.Types.Format.Format
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.Format.Format
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.Types.Format.Format
instance Amazonka.Data.Headers.ToHeader Amazonka.HoneyCode.Types.Format.Format
instance Amazonka.Data.Log.ToLog Amazonka.HoneyCode.Types.Format.Format
instance Amazonka.Data.ByteString.ToByteString Amazonka.HoneyCode.Types.Format.Format
instance Amazonka.Data.Text.ToText Amazonka.HoneyCode.Types.Format.Format
instance Amazonka.Data.Text.FromText Amazonka.HoneyCode.Types.Format.Format
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.Format.Format
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.Format.Format
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.Format.Format
instance GHC.Classes.Ord Amazonka.HoneyCode.Types.Format.Format
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.Format.Format
instance GHC.Read.Read Amazonka.HoneyCode.Types.Format.Format
instance GHC.Show.Show Amazonka.HoneyCode.Types.Format.Format
module Amazonka.HoneyCode.Types.DataItem
-- | The data in a particular data cell defined on the screen.
--
-- See: newDataItem smart constructor.
data DataItem
DataItem' :: Maybe Text -> Maybe Format -> Maybe Text -> DataItem
-- | The formatted value of the data. e.g. John Smith.
[$sel:formattedValue:DataItem'] :: DataItem -> Maybe Text
-- | The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
[$sel:overrideFormat:DataItem'] :: DataItem -> Maybe Format
-- | The raw value of the data. e.g. jsmith@example.com
[$sel:rawValue:DataItem'] :: DataItem -> Maybe Text
-- | Create a value of DataItem 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:formattedValue:DataItem', dataItem_formattedValue -
-- The formatted value of the data. e.g. John Smith.
--
-- $sel:overrideFormat:DataItem', dataItem_overrideFormat -
-- The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
--
-- $sel:rawValue:DataItem', dataItem_rawValue - The raw
-- value of the data. e.g. jsmith@example.com
newDataItem :: DataItem
-- | The formatted value of the data. e.g. John Smith.
dataItem_formattedValue :: Lens' DataItem (Maybe Text)
-- | The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
dataItem_overrideFormat :: Lens' DataItem (Maybe Format)
-- | The raw value of the data. e.g. jsmith@example.com
dataItem_rawValue :: Lens' DataItem (Maybe Text)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.DataItem.DataItem
instance GHC.Show.Show Amazonka.HoneyCode.Types.DataItem.DataItem
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.DataItem.DataItem
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.DataItem.DataItem
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.DataItem.DataItem
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.DataItem.DataItem
module Amazonka.HoneyCode.Types.ColumnMetadata
-- | Metadata for column in the table.
--
-- See: newColumnMetadata smart constructor.
data ColumnMetadata
ColumnMetadata' :: Sensitive Text -> Format -> ColumnMetadata
-- | The name of the column.
[$sel:name:ColumnMetadata'] :: ColumnMetadata -> Sensitive Text
-- | The format of the column.
[$sel:format:ColumnMetadata'] :: ColumnMetadata -> Format
-- | 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:name:ColumnMetadata', columnMetadata_name - The
-- name of the column.
--
-- $sel:format:ColumnMetadata', columnMetadata_format - The
-- format of the column.
newColumnMetadata :: Text -> Format -> ColumnMetadata
-- | The name of the column.
columnMetadata_name :: Lens' ColumnMetadata Text
-- | The format of the column.
columnMetadata_format :: Lens' ColumnMetadata Format
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ColumnMetadata.ColumnMetadata
instance GHC.Show.Show Amazonka.HoneyCode.Types.ColumnMetadata.ColumnMetadata
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ColumnMetadata.ColumnMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ColumnMetadata.ColumnMetadata
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ColumnMetadata.ColumnMetadata
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ColumnMetadata.ColumnMetadata
module Amazonka.HoneyCode.Types.Cell
-- | An object that represents a single cell in a table.
--
-- See: newCell smart constructor.
data Cell
Cell' :: Maybe Format -> Maybe Text -> Maybe [Text] -> Maybe (Sensitive Text) -> Maybe Text -> Cell
-- | The format of the cell. If this field is empty, then the format is
-- either not specified in the workbook or the format is set to AUTO.
[$sel:format:Cell'] :: Cell -> Maybe Format
-- | The formatted value of the cell. This is the value that you see
-- displayed in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
[$sel:formattedValue:Cell'] :: Cell -> Maybe Text
-- | A list of formatted values of the cell. This field is only returned
-- when the cell is ROWSET format (aka multi-select or multi-record
-- picklist). Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
[$sel:formattedValues:Cell'] :: Cell -> Maybe [Text]
-- | The formula contained in the cell. This field is empty if a cell does
-- not have a formula.
[$sel:formula:Cell'] :: Cell -> Maybe (Sensitive Text)
-- | The raw value of the data contained in the cell. The raw value depends
-- on the format of the data in the cell. However the attribute in the
-- API return value is always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
[$sel:rawValue:Cell'] :: Cell -> Maybe Text
-- | Create a value of Cell 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:format:Cell', cell_format - The format of the cell.
-- If this field is empty, then the format is either not specified in the
-- workbook or the format is set to AUTO.
--
-- $sel:formattedValue:Cell', cell_formattedValue - The
-- formatted value of the cell. This is the value that you see displayed
-- in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
--
-- $sel:formattedValues:Cell', cell_formattedValues - A
-- list of formatted values of the cell. This field is only returned when
-- the cell is ROWSET format (aka multi-select or multi-record picklist).
-- Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
--
-- $sel:formula:Cell', cell_formula - The formula contained
-- in the cell. This field is empty if a cell does not have a formula.
--
-- $sel:rawValue:Cell', cell_rawValue - The raw value of
-- the data contained in the cell. The raw value depends on the format of
-- the data in the cell. However the attribute in the API return value is
-- always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
newCell :: Cell
-- | The format of the cell. If this field is empty, then the format is
-- either not specified in the workbook or the format is set to AUTO.
cell_format :: Lens' Cell (Maybe Format)
-- | The formatted value of the cell. This is the value that you see
-- displayed in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
cell_formattedValue :: Lens' Cell (Maybe Text)
-- | A list of formatted values of the cell. This field is only returned
-- when the cell is ROWSET format (aka multi-select or multi-record
-- picklist). Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
cell_formattedValues :: Lens' Cell (Maybe [Text])
-- | The formula contained in the cell. This field is empty if a cell does
-- not have a formula.
cell_formula :: Lens' Cell (Maybe Text)
-- | The raw value of the data contained in the cell. The raw value depends
-- on the format of the data in the cell. However the attribute in the
-- API return value is always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
cell_rawValue :: Lens' Cell (Maybe Text)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.Cell.Cell
instance GHC.Show.Show Amazonka.HoneyCode.Types.Cell.Cell
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.Cell.Cell
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.Cell.Cell
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.Cell.Cell
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.Cell.Cell
module Amazonka.HoneyCode.Types.ImportDataCharacterEncoding
newtype ImportDataCharacterEncoding
ImportDataCharacterEncoding' :: Text -> ImportDataCharacterEncoding
[fromImportDataCharacterEncoding] :: ImportDataCharacterEncoding -> Text
pattern ImportDataCharacterEncoding_ISO_8859_1 :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_US_ASCII :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16 :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16BE :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16LE :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_8 :: ImportDataCharacterEncoding
instance Amazonka.Data.XML.ToXML Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Amazonka.Data.XML.FromXML Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Amazonka.Data.Headers.ToHeader Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Amazonka.Data.Log.ToLog Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Amazonka.Data.ByteString.ToByteString Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Amazonka.Data.Text.ToText Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Amazonka.Data.Text.FromText Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance GHC.Classes.Ord Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance GHC.Read.Read Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
instance GHC.Show.Show Amazonka.HoneyCode.Types.ImportDataCharacterEncoding.ImportDataCharacterEncoding
module Amazonka.HoneyCode.Types.DelimitedTextImportOptions
-- | An object that contains the options relating to parsing delimited text
-- as part of an import request.
--
-- See: newDelimitedTextImportOptions smart constructor.
data DelimitedTextImportOptions
DelimitedTextImportOptions' :: Maybe ImportDataCharacterEncoding -> Maybe Bool -> Maybe Bool -> Text -> DelimitedTextImportOptions
-- | The encoding of the data in the input file.
[$sel:dataCharacterEncoding:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Maybe ImportDataCharacterEncoding
-- | Indicates whether the input file has a header row at the top
-- containing the column names.
[$sel:hasHeaderRow:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Maybe Bool
-- | A parameter to indicate whether empty rows should be ignored or be
-- included in the import.
[$sel:ignoreEmptyRows:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Maybe Bool
-- | The delimiter to use for separating columns in a single row of the
-- input.
[$sel:delimiter:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Text
-- | Create a value of DelimitedTextImportOptions 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:dataCharacterEncoding:DelimitedTextImportOptions',
-- delimitedTextImportOptions_dataCharacterEncoding - The encoding
-- of the data in the input file.
--
-- $sel:hasHeaderRow:DelimitedTextImportOptions',
-- delimitedTextImportOptions_hasHeaderRow - Indicates whether the
-- input file has a header row at the top containing the column names.
--
-- $sel:ignoreEmptyRows:DelimitedTextImportOptions',
-- delimitedTextImportOptions_ignoreEmptyRows - A parameter to
-- indicate whether empty rows should be ignored or be included in the
-- import.
--
-- $sel:delimiter:DelimitedTextImportOptions',
-- delimitedTextImportOptions_delimiter - The delimiter to use for
-- separating columns in a single row of the input.
newDelimitedTextImportOptions :: Text -> DelimitedTextImportOptions
-- | The encoding of the data in the input file.
delimitedTextImportOptions_dataCharacterEncoding :: Lens' DelimitedTextImportOptions (Maybe ImportDataCharacterEncoding)
-- | Indicates whether the input file has a header row at the top
-- containing the column names.
delimitedTextImportOptions_hasHeaderRow :: Lens' DelimitedTextImportOptions (Maybe Bool)
-- | A parameter to indicate whether empty rows should be ignored or be
-- included in the import.
delimitedTextImportOptions_ignoreEmptyRows :: Lens' DelimitedTextImportOptions (Maybe Bool)
-- | The delimiter to use for separating columns in a single row of the
-- input.
delimitedTextImportOptions_delimiter :: Lens' DelimitedTextImportOptions Text
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
instance GHC.Show.Show Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
instance GHC.Read.Read Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.DelimitedTextImportOptions.DelimitedTextImportOptions
module Amazonka.HoneyCode.Types.ImportDataSourceConfig
-- | An object that contains the configuration parameters for the data
-- source of an import request.
--
-- See: newImportDataSourceConfig smart constructor.
data ImportDataSourceConfig
ImportDataSourceConfig' :: Maybe (Sensitive Text) -> ImportDataSourceConfig
-- | The URL from which source data will be downloaded for the import
-- request.
[$sel:dataSourceUrl:ImportDataSourceConfig'] :: ImportDataSourceConfig -> Maybe (Sensitive Text)
-- | Create a value of ImportDataSourceConfig 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:dataSourceUrl:ImportDataSourceConfig',
-- importDataSourceConfig_dataSourceUrl - The URL from which
-- source data will be downloaded for the import request.
newImportDataSourceConfig :: ImportDataSourceConfig
-- | The URL from which source data will be downloaded for the import
-- request.
importDataSourceConfig_dataSourceUrl :: Lens' ImportDataSourceConfig (Maybe Text)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ImportDataSourceConfig.ImportDataSourceConfig
instance GHC.Show.Show Amazonka.HoneyCode.Types.ImportDataSourceConfig.ImportDataSourceConfig
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ImportDataSourceConfig.ImportDataSourceConfig
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ImportDataSourceConfig.ImportDataSourceConfig
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ImportDataSourceConfig.ImportDataSourceConfig
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ImportDataSourceConfig.ImportDataSourceConfig
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.ImportDataSourceConfig.ImportDataSourceConfig
module Amazonka.HoneyCode.Types.ImportDataSource
-- | An object that has details about the source of the data that was
-- submitted for import.
--
-- See: newImportDataSource smart constructor.
data ImportDataSource
ImportDataSource' :: ImportDataSourceConfig -> ImportDataSource
-- | The configuration parameters for the data source of the import
[$sel:dataSourceConfig:ImportDataSource'] :: ImportDataSource -> ImportDataSourceConfig
-- | Create a value of ImportDataSource 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:dataSourceConfig:ImportDataSource',
-- importDataSource_dataSourceConfig - The configuration
-- parameters for the data source of the import
newImportDataSource :: ImportDataSourceConfig -> ImportDataSource
-- | The configuration parameters for the data source of the import
importDataSource_dataSourceConfig :: Lens' ImportDataSource ImportDataSourceConfig
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ImportDataSource.ImportDataSource
instance GHC.Show.Show Amazonka.HoneyCode.Types.ImportDataSource.ImportDataSource
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ImportDataSource.ImportDataSource
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ImportDataSource.ImportDataSource
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ImportDataSource.ImportDataSource
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ImportDataSource.ImportDataSource
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.ImportDataSource.ImportDataSource
module Amazonka.HoneyCode.Types.ImportJobSubmitter
-- | An object that contains the attributes of the submitter of the import
-- job.
--
-- See: newImportJobSubmitter smart constructor.
data ImportJobSubmitter
ImportJobSubmitter' :: Maybe (Sensitive Text) -> Maybe Text -> ImportJobSubmitter
-- | The email id of the submitter of the import job, if available.
[$sel:email:ImportJobSubmitter'] :: ImportJobSubmitter -> Maybe (Sensitive Text)
-- | The AWS user ARN of the submitter of the import job, if available.
[$sel:userArn:ImportJobSubmitter'] :: ImportJobSubmitter -> Maybe Text
-- | Create a value of ImportJobSubmitter 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:email:ImportJobSubmitter', importJobSubmitter_email
-- - The email id of the submitter of the import job, if available.
--
-- $sel:userArn:ImportJobSubmitter',
-- importJobSubmitter_userArn - The AWS user ARN of the submitter
-- of the import job, if available.
newImportJobSubmitter :: ImportJobSubmitter
-- | The email id of the submitter of the import job, if available.
importJobSubmitter_email :: Lens' ImportJobSubmitter (Maybe Text)
-- | The AWS user ARN of the submitter of the import job, if available.
importJobSubmitter_userArn :: Lens' ImportJobSubmitter (Maybe Text)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ImportJobSubmitter.ImportJobSubmitter
instance GHC.Show.Show Amazonka.HoneyCode.Types.ImportJobSubmitter.ImportJobSubmitter
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ImportJobSubmitter.ImportJobSubmitter
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ImportJobSubmitter.ImportJobSubmitter
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ImportJobSubmitter.ImportJobSubmitter
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ImportJobSubmitter.ImportJobSubmitter
module Amazonka.HoneyCode.Types.ImportSourceDataFormat
newtype ImportSourceDataFormat
ImportSourceDataFormat' :: Text -> ImportSourceDataFormat
[fromImportSourceDataFormat] :: ImportSourceDataFormat -> Text
pattern ImportSourceDataFormat_DELIMITED_TEXT :: ImportSourceDataFormat
instance Amazonka.Data.XML.ToXML Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Amazonka.Data.XML.FromXML Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Amazonka.Data.Headers.ToHeader Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Amazonka.Data.Log.ToLog Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Amazonka.Data.ByteString.ToByteString Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Amazonka.Data.Text.ToText Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Amazonka.Data.Text.FromText Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance GHC.Classes.Ord Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance GHC.Read.Read Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
instance GHC.Show.Show Amazonka.HoneyCode.Types.ImportSourceDataFormat.ImportSourceDataFormat
module Amazonka.HoneyCode.Types.ResultRow
-- | A single row in the ResultSet.
--
-- See: newResultRow smart constructor.
data ResultRow
ResultRow' :: Maybe Text -> [Sensitive DataItem] -> ResultRow
-- | The ID for a particular row.
[$sel:rowId:ResultRow'] :: ResultRow -> Maybe Text
-- | List of all the data cells in a row.
[$sel:dataItems:ResultRow'] :: ResultRow -> [Sensitive DataItem]
-- | Create a value of ResultRow 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:rowId:ResultRow', resultRow_rowId - The ID for a
-- particular row.
--
-- $sel:dataItems:ResultRow', resultRow_dataItems - List of
-- all the data cells in a row.
newResultRow :: ResultRow
-- | The ID for a particular row.
resultRow_rowId :: Lens' ResultRow (Maybe Text)
-- | List of all the data cells in a row.
resultRow_dataItems :: Lens' ResultRow [DataItem]
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ResultRow.ResultRow
instance GHC.Show.Show Amazonka.HoneyCode.Types.ResultRow.ResultRow
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ResultRow.ResultRow
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ResultRow.ResultRow
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ResultRow.ResultRow
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ResultRow.ResultRow
module Amazonka.HoneyCode.Types.ResultSet
-- | ResultSet contains the results of the request for a single block or
-- list defined on the screen.
--
-- See: newResultSet smart constructor.
data ResultSet
ResultSet' :: [ColumnMetadata] -> [ResultRow] -> ResultSet
-- | List of headers for all the data cells in the block. The header
-- identifies the name and default format of the data cell. Data cells
-- appear in the same order in all rows as defined in the header. The
-- names and formats are not repeated in the rows. If a particular row
-- does not have a value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
[$sel:headers:ResultSet'] :: ResultSet -> [ColumnMetadata]
-- | List of rows returned by the request. Each row has a row Id and a list
-- of data cells in that row. The data cells will be present in the same
-- order as they are defined in the header.
[$sel:rows:ResultSet'] :: ResultSet -> [ResultRow]
-- | Create a value of ResultSet 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:headers:ResultSet', resultSet_headers - List of
-- headers for all the data cells in the block. The header identifies the
-- name and default format of the data cell. Data cells appear in the
-- same order in all rows as defined in the header. The names and formats
-- are not repeated in the rows. If a particular row does not have a
-- value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
--
-- $sel:rows:ResultSet', resultSet_rows - List of rows
-- returned by the request. Each row has a row Id and a list of data
-- cells in that row. The data cells will be present in the same order as
-- they are defined in the header.
newResultSet :: ResultSet
-- | List of headers for all the data cells in the block. The header
-- identifies the name and default format of the data cell. Data cells
-- appear in the same order in all rows as defined in the header. The
-- names and formats are not repeated in the rows. If a particular row
-- does not have a value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
resultSet_headers :: Lens' ResultSet [ColumnMetadata]
-- | List of rows returned by the request. Each row has a row Id and a list
-- of data cells in that row. The data cells will be present in the same
-- order as they are defined in the header.
resultSet_rows :: Lens' ResultSet [ResultRow]
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ResultSet.ResultSet
instance GHC.Show.Show Amazonka.HoneyCode.Types.ResultSet.ResultSet
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ResultSet.ResultSet
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ResultSet.ResultSet
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ResultSet.ResultSet
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ResultSet.ResultSet
module Amazonka.HoneyCode.Types.SourceDataColumnProperties
-- | An object that contains the properties for importing data to a
-- specific column in a table.
--
-- See: newSourceDataColumnProperties smart constructor.
data SourceDataColumnProperties
SourceDataColumnProperties' :: Maybe Natural -> SourceDataColumnProperties
-- | The index of the column in the input file.
[$sel:columnIndex:SourceDataColumnProperties'] :: SourceDataColumnProperties -> Maybe Natural
-- | Create a value of SourceDataColumnProperties 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:columnIndex:SourceDataColumnProperties',
-- sourceDataColumnProperties_columnIndex - The index of the
-- column in the input file.
newSourceDataColumnProperties :: SourceDataColumnProperties
-- | The index of the column in the input file.
sourceDataColumnProperties_columnIndex :: Lens' SourceDataColumnProperties (Maybe Natural)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
instance GHC.Show.Show Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
instance GHC.Read.Read Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.SourceDataColumnProperties.SourceDataColumnProperties
module Amazonka.HoneyCode.Types.DestinationOptions
-- | An object that contains the options relating to the destination of the
-- import request.
--
-- See: newDestinationOptions smart constructor.
data DestinationOptions
DestinationOptions' :: Maybe (HashMap Text SourceDataColumnProperties) -> DestinationOptions
-- | A map of the column id to the import properties for each column.
[$sel:columnMap:DestinationOptions'] :: DestinationOptions -> Maybe (HashMap Text SourceDataColumnProperties)
-- | Create a value of DestinationOptions 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:columnMap:DestinationOptions',
-- destinationOptions_columnMap - A map of the column id to the
-- import properties for each column.
newDestinationOptions :: DestinationOptions
-- | A map of the column id to the import properties for each column.
destinationOptions_columnMap :: Lens' DestinationOptions (Maybe (HashMap Text SourceDataColumnProperties))
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
instance GHC.Show.Show Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
instance GHC.Read.Read Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.DestinationOptions.DestinationOptions
module Amazonka.HoneyCode.Types.ImportOptions
-- | An object that contains the options specified by the sumitter of the
-- import request.
--
-- See: newImportOptions smart constructor.
data ImportOptions
ImportOptions' :: Maybe DelimitedTextImportOptions -> Maybe DestinationOptions -> ImportOptions
-- | Options relating to parsing delimited text. Required if dataFormat is
-- DELIMITED_TEXT.
[$sel:delimitedTextOptions:ImportOptions'] :: ImportOptions -> Maybe DelimitedTextImportOptions
-- | Options relating to the destination of the import request.
[$sel:destinationOptions:ImportOptions'] :: ImportOptions -> Maybe DestinationOptions
-- | Create a value of ImportOptions 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:delimitedTextOptions:ImportOptions',
-- importOptions_delimitedTextOptions - Options relating to
-- parsing delimited text. Required if dataFormat is DELIMITED_TEXT.
--
-- $sel:destinationOptions:ImportOptions',
-- importOptions_destinationOptions - Options relating to the
-- destination of the import request.
newImportOptions :: ImportOptions
-- | Options relating to parsing delimited text. Required if dataFormat is
-- DELIMITED_TEXT.
importOptions_delimitedTextOptions :: Lens' ImportOptions (Maybe DelimitedTextImportOptions)
-- | Options relating to the destination of the import request.
importOptions_destinationOptions :: Lens' ImportOptions (Maybe DestinationOptions)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
instance GHC.Show.Show Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
instance GHC.Read.Read Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.ImportOptions.ImportOptions
module Amazonka.HoneyCode.Types.Table
-- | An object representing the properties of a table in a workbook.
--
-- See: newTable smart constructor.
data Table
Table' :: Maybe Text -> Maybe Text -> Table
-- | The id of the table.
[$sel:tableId:Table'] :: Table -> Maybe Text
-- | The name of the table.
[$sel:tableName:Table'] :: Table -> Maybe Text
-- | Create a value of Table 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:tableId:Table', table_tableId - The id of the
-- table.
--
-- $sel:tableName:Table', table_tableName - The name of the
-- table.
newTable :: Table
-- | The id of the table.
table_tableId :: Lens' Table (Maybe Text)
-- | The name of the table.
table_tableName :: Lens' Table (Maybe Text)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.Table.Table
instance GHC.Show.Show Amazonka.HoneyCode.Types.Table.Table
instance GHC.Read.Read Amazonka.HoneyCode.Types.Table.Table
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.Table.Table
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.Table.Table
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.Table.Table
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.Table.Table
module Amazonka.HoneyCode.Types.TableColumn
-- | An object that contains attributes about a single column in a table
--
-- See: newTableColumn smart constructor.
data TableColumn
TableColumn' :: Maybe Format -> Maybe Text -> Maybe Text -> TableColumn
-- | The column level format that is applied in the table. An empty value
-- in this field means that the column format is the default value
-- 'AUTO'.
[$sel:format:TableColumn'] :: TableColumn -> Maybe Format
-- | The id of the column in the table.
[$sel:tableColumnId:TableColumn'] :: TableColumn -> Maybe Text
-- | The name of the column in the table.
[$sel:tableColumnName:TableColumn'] :: TableColumn -> Maybe Text
-- | Create a value of TableColumn 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:format:TableColumn', tableColumn_format - The
-- column level format that is applied in the table. An empty value in
-- this field means that the column format is the default value 'AUTO'.
--
-- $sel:tableColumnId:TableColumn',
-- tableColumn_tableColumnId - The id of the column in the table.
--
-- $sel:tableColumnName:TableColumn',
-- tableColumn_tableColumnName - The name of the column in the
-- table.
newTableColumn :: TableColumn
-- | The column level format that is applied in the table. An empty value
-- in this field means that the column format is the default value
-- 'AUTO'.
tableColumn_format :: Lens' TableColumn (Maybe Format)
-- | The id of the column in the table.
tableColumn_tableColumnId :: Lens' TableColumn (Maybe Text)
-- | The name of the column in the table.
tableColumn_tableColumnName :: Lens' TableColumn (Maybe Text)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.TableColumn.TableColumn
instance GHC.Show.Show Amazonka.HoneyCode.Types.TableColumn.TableColumn
instance GHC.Read.Read Amazonka.HoneyCode.Types.TableColumn.TableColumn
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.TableColumn.TableColumn
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.TableColumn.TableColumn
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.TableColumn.TableColumn
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.TableColumn.TableColumn
module Amazonka.HoneyCode.Types.TableDataImportJobMetadata
-- | The metadata associated with the table data import job that was
-- submitted.
--
-- See: newTableDataImportJobMetadata smart constructor.
data TableDataImportJobMetadata
TableDataImportJobMetadata' :: ImportJobSubmitter -> POSIX -> ImportOptions -> ImportDataSource -> TableDataImportJobMetadata
-- | Details about the submitter of the import request.
[$sel:submitter:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> ImportJobSubmitter
-- | The timestamp when the job was submitted for import.
[$sel:submitTime:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> POSIX
-- | The options that was specified at the time of submitting the import
-- request.
[$sel:importOptions:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> ImportOptions
-- | The source of the data that was submitted for import.
[$sel:dataSource:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> ImportDataSource
-- | Create a value of TableDataImportJobMetadata 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:submitter:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_submitter - Details about the
-- submitter of the import request.
--
-- $sel:submitTime:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_submitTime - The timestamp when the
-- job was submitted for import.
--
-- $sel:importOptions:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_importOptions - The options that was
-- specified at the time of submitting the import request.
--
-- $sel:dataSource:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_dataSource - The source of the data
-- that was submitted for import.
newTableDataImportJobMetadata :: ImportJobSubmitter -> UTCTime -> ImportOptions -> ImportDataSource -> TableDataImportJobMetadata
-- | Details about the submitter of the import request.
tableDataImportJobMetadata_submitter :: Lens' TableDataImportJobMetadata ImportJobSubmitter
-- | The timestamp when the job was submitted for import.
tableDataImportJobMetadata_submitTime :: Lens' TableDataImportJobMetadata UTCTime
-- | The options that was specified at the time of submitting the import
-- request.
tableDataImportJobMetadata_importOptions :: Lens' TableDataImportJobMetadata ImportOptions
-- | The source of the data that was submitted for import.
tableDataImportJobMetadata_dataSource :: Lens' TableDataImportJobMetadata ImportDataSource
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.TableDataImportJobMetadata.TableDataImportJobMetadata
instance GHC.Show.Show Amazonka.HoneyCode.Types.TableDataImportJobMetadata.TableDataImportJobMetadata
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.TableDataImportJobMetadata.TableDataImportJobMetadata
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.TableDataImportJobMetadata.TableDataImportJobMetadata
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.TableDataImportJobMetadata.TableDataImportJobMetadata
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.TableDataImportJobMetadata.TableDataImportJobMetadata
module Amazonka.HoneyCode.Types.TableDataImportJobStatus
newtype TableDataImportJobStatus
TableDataImportJobStatus' :: Text -> TableDataImportJobStatus
[fromTableDataImportJobStatus] :: TableDataImportJobStatus -> Text
pattern TableDataImportJobStatus_COMPLETED :: TableDataImportJobStatus
pattern TableDataImportJobStatus_FAILED :: TableDataImportJobStatus
pattern TableDataImportJobStatus_IN_PROGRESS :: TableDataImportJobStatus
pattern TableDataImportJobStatus_SUBMITTED :: TableDataImportJobStatus
instance Amazonka.Data.XML.ToXML Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Amazonka.Data.XML.FromXML Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Amazonka.Data.Headers.ToHeader Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Amazonka.Data.Log.ToLog Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Amazonka.Data.ByteString.ToByteString Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Amazonka.Data.Text.ToText Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Amazonka.Data.Text.FromText Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance GHC.Classes.Ord Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance GHC.Read.Read Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
instance GHC.Show.Show Amazonka.HoneyCode.Types.TableDataImportJobStatus.TableDataImportJobStatus
module Amazonka.HoneyCode.Types.TableRow
-- | An object that contains attributes about a single row in a table
--
-- See: newTableRow smart constructor.
data TableRow
TableRow' :: Text -> [Sensitive Cell] -> TableRow
-- | The id of the row in the table.
[$sel:rowId:TableRow'] :: TableRow -> Text
-- | A list of cells in the table row. The cells appear in the same order
-- as the columns of the table.
[$sel:cells:TableRow'] :: TableRow -> [Sensitive Cell]
-- | Create a value of TableRow 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:rowId:TableRow', tableRow_rowId - The id of the row
-- in the table.
--
-- $sel:cells:TableRow', tableRow_cells - A list of cells
-- in the table row. The cells appear in the same order as the columns of
-- the table.
newTableRow :: Text -> TableRow
-- | The id of the row in the table.
tableRow_rowId :: Lens' TableRow Text
-- | A list of cells in the table row. The cells appear in the same order
-- as the columns of the table.
tableRow_cells :: Lens' TableRow [Cell]
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.TableRow.TableRow
instance GHC.Show.Show Amazonka.HoneyCode.Types.TableRow.TableRow
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.TableRow.TableRow
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.TableRow.TableRow
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.TableRow.TableRow
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.TableRow.TableRow
module Amazonka.HoneyCode.Types.UpdateRowData
-- | Data needed to create a single row in a table as part of the
-- BatchCreateTableRows request.
--
-- See: newUpdateRowData smart constructor.
data UpdateRowData
UpdateRowData' :: Text -> HashMap Text CellInput -> UpdateRowData
-- | The id of the row that needs to be updated.
[$sel:rowId:UpdateRowData'] :: UpdateRowData -> Text
-- | A map representing the cells to update in the given row. The key is
-- the column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
[$sel:cellsToUpdate:UpdateRowData'] :: UpdateRowData -> HashMap Text CellInput
-- | Create a value of UpdateRowData 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:rowId:UpdateRowData', updateRowData_rowId - The id
-- of the row that needs to be updated.
--
-- $sel:cellsToUpdate:UpdateRowData',
-- updateRowData_cellsToUpdate - A map representing the cells to
-- update in the given row. The key is the column id of the cell and the
-- value is the CellInput object that represents the data to set in that
-- cell.
newUpdateRowData :: Text -> UpdateRowData
-- | The id of the row that needs to be updated.
updateRowData_rowId :: Lens' UpdateRowData Text
-- | A map representing the cells to update in the given row. The key is
-- the column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
updateRowData_cellsToUpdate :: Lens' UpdateRowData (HashMap Text CellInput)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.UpdateRowData.UpdateRowData
instance GHC.Show.Show Amazonka.HoneyCode.Types.UpdateRowData.UpdateRowData
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.UpdateRowData.UpdateRowData
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.UpdateRowData.UpdateRowData
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.UpdateRowData.UpdateRowData
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.UpdateRowData.UpdateRowData
module Amazonka.HoneyCode.Types.UpsertAction
newtype UpsertAction
UpsertAction' :: Text -> UpsertAction
[fromUpsertAction] :: UpsertAction -> Text
pattern UpsertAction_APPENDED :: UpsertAction
pattern UpsertAction_UPDATED :: UpsertAction
instance Amazonka.Data.XML.ToXML Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Amazonka.Data.XML.FromXML Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Data.Aeson.Types.ToJSON.ToJSONKey Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Data.Aeson.Types.FromJSON.FromJSONKey Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Amazonka.Data.Headers.ToHeader Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Amazonka.Data.Log.ToLog Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Amazonka.Data.ByteString.ToByteString Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Amazonka.Data.Text.ToText Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Amazonka.Data.Text.FromText Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance GHC.Classes.Ord Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance GHC.Read.Read Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
instance GHC.Show.Show Amazonka.HoneyCode.Types.UpsertAction.UpsertAction
module Amazonka.HoneyCode.Types.UpsertRowData
-- | Data needed to upsert rows in a table as part of a single item in the
-- BatchUpsertTableRows request.
--
-- See: newUpsertRowData smart constructor.
data UpsertRowData
UpsertRowData' :: Text -> Filter -> HashMap Text CellInput -> UpsertRowData
-- | An external identifier that represents a single item in the request
-- that is being upserted as part of the BatchUpsertTableRows request.
-- This can be any string that you can use to identify the item in the
-- request. The BatchUpsertTableRows API puts the batch item id in the
-- results to allow you to link data in the request to data in the
-- results.
[$sel:batchItemId:UpsertRowData'] :: UpsertRowData -> Text
-- | The filter formula to use to find existing matching rows to update.
-- The formula needs to return zero or more rows. If the formula returns
-- 0 rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
[$sel:filter':UpsertRowData'] :: UpsertRowData -> Filter
-- | A map representing the cells to update for the matching rows or an
-- appended row. The key is the column id of the cell and the value is
-- the CellInput object that represents the data to set in that cell.
[$sel:cellsToUpdate:UpsertRowData'] :: UpsertRowData -> HashMap Text CellInput
-- | Create a value of UpsertRowData 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:batchItemId:UpsertRowData',
-- upsertRowData_batchItemId - An external identifier that
-- represents a single item in the request that is being upserted as part
-- of the BatchUpsertTableRows request. This can be any string that you
-- can use to identify the item in the request. The BatchUpsertTableRows
-- API puts the batch item id in the results to allow you to link data in
-- the request to data in the results.
--
-- $sel:filter':UpsertRowData', upsertRowData_filter - The
-- filter formula to use to find existing matching rows to update. The
-- formula needs to return zero or more rows. If the formula returns 0
-- rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
--
-- $sel:cellsToUpdate:UpsertRowData',
-- upsertRowData_cellsToUpdate - A map representing the cells to
-- update for the matching rows or an appended row. The key is the column
-- id of the cell and the value is the CellInput object that represents
-- the data to set in that cell.
newUpsertRowData :: Text -> Filter -> UpsertRowData
-- | An external identifier that represents a single item in the request
-- that is being upserted as part of the BatchUpsertTableRows request.
-- This can be any string that you can use to identify the item in the
-- request. The BatchUpsertTableRows API puts the batch item id in the
-- results to allow you to link data in the request to data in the
-- results.
upsertRowData_batchItemId :: Lens' UpsertRowData Text
-- | The filter formula to use to find existing matching rows to update.
-- The formula needs to return zero or more rows. If the formula returns
-- 0 rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
upsertRowData_filter :: Lens' UpsertRowData Filter
-- | A map representing the cells to update for the matching rows or an
-- appended row. The key is the column id of the cell and the value is
-- the CellInput object that represents the data to set in that cell.
upsertRowData_cellsToUpdate :: Lens' UpsertRowData (HashMap Text CellInput)
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.UpsertRowData.UpsertRowData
instance GHC.Show.Show Amazonka.HoneyCode.Types.UpsertRowData.UpsertRowData
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.UpsertRowData.UpsertRowData
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.UpsertRowData.UpsertRowData
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.UpsertRowData.UpsertRowData
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.UpsertRowData.UpsertRowData
module Amazonka.HoneyCode.Types.UpsertRowsResult
-- | An object that represents the result of a single upsert row request.
--
-- See: newUpsertRowsResult smart constructor.
data UpsertRowsResult
UpsertRowsResult' :: NonEmpty Text -> UpsertAction -> UpsertRowsResult
-- | The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
[$sel:rowIds:UpsertRowsResult'] :: UpsertRowsResult -> NonEmpty Text
-- | The result of the upsert action.
[$sel:upsertAction:UpsertRowsResult'] :: UpsertRowsResult -> UpsertAction
-- | Create a value of UpsertRowsResult 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:rowIds:UpsertRowsResult', upsertRowsResult_rowIds -
-- The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
--
-- $sel:upsertAction:UpsertRowsResult',
-- upsertRowsResult_upsertAction - The result of the upsert
-- action.
newUpsertRowsResult :: NonEmpty Text -> UpsertAction -> UpsertRowsResult
-- | The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
upsertRowsResult_rowIds :: Lens' UpsertRowsResult (NonEmpty Text)
-- | The result of the upsert action.
upsertRowsResult_upsertAction :: Lens' UpsertRowsResult UpsertAction
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.UpsertRowsResult.UpsertRowsResult
instance GHC.Show.Show Amazonka.HoneyCode.Types.UpsertRowsResult.UpsertRowsResult
instance GHC.Read.Read Amazonka.HoneyCode.Types.UpsertRowsResult.UpsertRowsResult
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.UpsertRowsResult.UpsertRowsResult
instance Data.Aeson.Types.FromJSON.FromJSON Amazonka.HoneyCode.Types.UpsertRowsResult.UpsertRowsResult
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.UpsertRowsResult.UpsertRowsResult
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.UpsertRowsResult.UpsertRowsResult
module Amazonka.HoneyCode.Types.VariableValue
-- | The input variables to the app to be used by the
-- InvokeScreenAutomation action request.
--
-- See: newVariableValue smart constructor.
data VariableValue
VariableValue' :: Text -> VariableValue
-- | Raw value of the variable.
[$sel:rawValue:VariableValue'] :: VariableValue -> Text
-- | Create a value of VariableValue 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:rawValue:VariableValue', variableValue_rawValue -
-- Raw value of the variable.
newVariableValue :: Text -> VariableValue
-- | Raw value of the variable.
variableValue_rawValue :: Lens' VariableValue Text
instance GHC.Generics.Generic Amazonka.HoneyCode.Types.VariableValue.VariableValue
instance GHC.Show.Show Amazonka.HoneyCode.Types.VariableValue.VariableValue
instance GHC.Classes.Eq Amazonka.HoneyCode.Types.VariableValue.VariableValue
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.Types.VariableValue.VariableValue
instance Control.DeepSeq.NFData Amazonka.HoneyCode.Types.VariableValue.VariableValue
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.Types.VariableValue.VariableValue
module Amazonka.HoneyCode.Types
-- | API version 2020-03-01 of the Amazon Honeycode SDK
-- configuration.
defaultService :: Service
-- | You do not have sufficient access to perform this action. Check that
-- the workbook is owned by you and your IAM policy allows access to the
-- resource in the request.
_AccessDeniedException :: AsError a => Fold a ServiceError
-- | The automation execution did not end successfully.
_AutomationExecutionException :: AsError a => Fold a ServiceError
-- | The automation execution timed out.
_AutomationExecutionTimeoutException :: AsError a => Fold a ServiceError
-- | There were unexpected errors from the server.
_InternalServerException :: AsError a => Fold a ServiceError
-- | The request timed out.
_RequestTimeoutException :: AsError a => Fold a ServiceError
-- | A Workbook, Table, App, Screen or Screen Automation was not found with
-- the given ID.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
-- | The request caused service quota to be breached.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
-- | Remote service is unreachable.
_ServiceUnavailableException :: AsError a => Fold a ServiceError
-- | Tps(transactions per second) rate reached.
_ThrottlingException :: AsError a => Fold a ServiceError
-- | Request is invalid. The message in the response contains details on
-- why the request is invalid.
_ValidationException :: AsError a => Fold a ServiceError
newtype ErrorCode
ErrorCode' :: Text -> ErrorCode
[fromErrorCode] :: ErrorCode -> Text
pattern ErrorCode_ACCESS_DENIED :: ErrorCode
pattern ErrorCode_FILE_EMPTY_ERROR :: ErrorCode
pattern ErrorCode_FILE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_FILE_PARSING_ERROR :: ErrorCode
pattern ErrorCode_FILE_SIZE_LIMIT_ERROR :: ErrorCode
pattern ErrorCode_INVALID_FILE_TYPE_ERROR :: ErrorCode
pattern ErrorCode_INVALID_IMPORT_OPTIONS_ERROR :: ErrorCode
pattern ErrorCode_INVALID_TABLE_COLUMN_ID_ERROR :: ErrorCode
pattern ErrorCode_INVALID_TABLE_ID_ERROR :: ErrorCode
pattern ErrorCode_INVALID_URL_ERROR :: ErrorCode
pattern ErrorCode_RESOURCE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_SYSTEM_LIMIT_ERROR :: ErrorCode
pattern ErrorCode_TABLE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_UNKNOWN_ERROR :: ErrorCode
newtype Format
Format' :: Text -> Format
[fromFormat] :: Format -> Text
pattern Format_ACCOUNTING :: Format
pattern Format_AUTO :: Format
pattern Format_CONTACT :: Format
pattern Format_CURRENCY :: Format
pattern Format_DATE :: Format
pattern Format_DATE_TIME :: Format
pattern Format_NUMBER :: Format
pattern Format_PERCENTAGE :: Format
pattern Format_ROWLINK :: Format
pattern Format_ROWSET :: Format
pattern Format_TEXT :: Format
pattern Format_TIME :: Format
newtype ImportDataCharacterEncoding
ImportDataCharacterEncoding' :: Text -> ImportDataCharacterEncoding
[fromImportDataCharacterEncoding] :: ImportDataCharacterEncoding -> Text
pattern ImportDataCharacterEncoding_ISO_8859_1 :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_US_ASCII :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16 :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16BE :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16LE :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_8 :: ImportDataCharacterEncoding
newtype ImportSourceDataFormat
ImportSourceDataFormat' :: Text -> ImportSourceDataFormat
[fromImportSourceDataFormat] :: ImportSourceDataFormat -> Text
pattern ImportSourceDataFormat_DELIMITED_TEXT :: ImportSourceDataFormat
newtype TableDataImportJobStatus
TableDataImportJobStatus' :: Text -> TableDataImportJobStatus
[fromTableDataImportJobStatus] :: TableDataImportJobStatus -> Text
pattern TableDataImportJobStatus_COMPLETED :: TableDataImportJobStatus
pattern TableDataImportJobStatus_FAILED :: TableDataImportJobStatus
pattern TableDataImportJobStatus_IN_PROGRESS :: TableDataImportJobStatus
pattern TableDataImportJobStatus_SUBMITTED :: TableDataImportJobStatus
newtype UpsertAction
UpsertAction' :: Text -> UpsertAction
[fromUpsertAction] :: UpsertAction -> Text
pattern UpsertAction_APPENDED :: UpsertAction
pattern UpsertAction_UPDATED :: UpsertAction
-- | An object that represents a single cell in a table.
--
-- See: newCell smart constructor.
data Cell
Cell' :: Maybe Format -> Maybe Text -> Maybe [Text] -> Maybe (Sensitive Text) -> Maybe Text -> Cell
-- | The format of the cell. If this field is empty, then the format is
-- either not specified in the workbook or the format is set to AUTO.
[$sel:format:Cell'] :: Cell -> Maybe Format
-- | The formatted value of the cell. This is the value that you see
-- displayed in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
[$sel:formattedValue:Cell'] :: Cell -> Maybe Text
-- | A list of formatted values of the cell. This field is only returned
-- when the cell is ROWSET format (aka multi-select or multi-record
-- picklist). Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
[$sel:formattedValues:Cell'] :: Cell -> Maybe [Text]
-- | The formula contained in the cell. This field is empty if a cell does
-- not have a formula.
[$sel:formula:Cell'] :: Cell -> Maybe (Sensitive Text)
-- | The raw value of the data contained in the cell. The raw value depends
-- on the format of the data in the cell. However the attribute in the
-- API return value is always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
[$sel:rawValue:Cell'] :: Cell -> Maybe Text
-- | Create a value of Cell 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:format:Cell', cell_format - The format of the cell.
-- If this field is empty, then the format is either not specified in the
-- workbook or the format is set to AUTO.
--
-- $sel:formattedValue:Cell', cell_formattedValue - The
-- formatted value of the cell. This is the value that you see displayed
-- in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
--
-- $sel:formattedValues:Cell', cell_formattedValues - A
-- list of formatted values of the cell. This field is only returned when
-- the cell is ROWSET format (aka multi-select or multi-record picklist).
-- Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
--
-- $sel:formula:Cell', cell_formula - The formula contained
-- in the cell. This field is empty if a cell does not have a formula.
--
-- $sel:rawValue:Cell', cell_rawValue - The raw value of
-- the data contained in the cell. The raw value depends on the format of
-- the data in the cell. However the attribute in the API return value is
-- always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
newCell :: Cell
-- | The format of the cell. If this field is empty, then the format is
-- either not specified in the workbook or the format is set to AUTO.
cell_format :: Lens' Cell (Maybe Format)
-- | The formatted value of the cell. This is the value that you see
-- displayed in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
cell_formattedValue :: Lens' Cell (Maybe Text)
-- | A list of formatted values of the cell. This field is only returned
-- when the cell is ROWSET format (aka multi-select or multi-record
-- picklist). Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
cell_formattedValues :: Lens' Cell (Maybe [Text])
-- | The formula contained in the cell. This field is empty if a cell does
-- not have a formula.
cell_formula :: Lens' Cell (Maybe Text)
-- | The raw value of the data contained in the cell. The raw value depends
-- on the format of the data in the cell. However the attribute in the
-- API return value is always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
cell_rawValue :: Lens' Cell (Maybe Text)
-- | CellInput object contains the data needed to create or update cells in
-- a table.
--
-- CellInput object has only a facts field or a fact field, but not both.
-- A 400 bad request will be thrown if both fact and facts field are
-- present.
--
-- See: newCellInput smart constructor.
data CellInput
CellInput' :: Maybe (Sensitive Text) -> Maybe [Sensitive Text] -> CellInput
-- | Fact represents the data that is entered into a cell. This data can be
-- free text or a formula. Formulas need to start with the equals (=)
-- sign.
[$sel:fact:CellInput'] :: CellInput -> Maybe (Sensitive Text)
-- | A list representing the values that are entered into a ROWSET cell.
-- Facts list can have either only values or rowIDs, and rowIDs should
-- from the same table.
[$sel:facts:CellInput'] :: CellInput -> Maybe [Sensitive Text]
-- | Create a value of CellInput 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:fact:CellInput', cellInput_fact - Fact represents
-- the data that is entered into a cell. This data can be free text or a
-- formula. Formulas need to start with the equals (=) sign.
--
-- $sel:facts:CellInput', cellInput_facts - A list
-- representing the values that are entered into a ROWSET cell. Facts
-- list can have either only values or rowIDs, and rowIDs should from the
-- same table.
newCellInput :: CellInput
-- | Fact represents the data that is entered into a cell. This data can be
-- free text or a formula. Formulas need to start with the equals (=)
-- sign.
cellInput_fact :: Lens' CellInput (Maybe Text)
-- | A list representing the values that are entered into a ROWSET cell.
-- Facts list can have either only values or rowIDs, and rowIDs should
-- from the same table.
cellInput_facts :: Lens' CellInput (Maybe [Text])
-- | Metadata for column in the table.
--
-- See: newColumnMetadata smart constructor.
data ColumnMetadata
ColumnMetadata' :: Sensitive Text -> Format -> ColumnMetadata
-- | The name of the column.
[$sel:name:ColumnMetadata'] :: ColumnMetadata -> Sensitive Text
-- | The format of the column.
[$sel:format:ColumnMetadata'] :: ColumnMetadata -> Format
-- | 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:name:ColumnMetadata', columnMetadata_name - The
-- name of the column.
--
-- $sel:format:ColumnMetadata', columnMetadata_format - The
-- format of the column.
newColumnMetadata :: Text -> Format -> ColumnMetadata
-- | The name of the column.
columnMetadata_name :: Lens' ColumnMetadata Text
-- | The format of the column.
columnMetadata_format :: Lens' ColumnMetadata Format
-- | Data needed to create a single row in a table as part of the
-- BatchCreateTableRows request.
--
-- See: newCreateRowData smart constructor.
data CreateRowData
CreateRowData' :: Text -> HashMap Text CellInput -> CreateRowData
-- | An external identifier that represents the single row that is being
-- created as part of the BatchCreateTableRows request. This can be any
-- string that you can use to identify the row in the request. The
-- BatchCreateTableRows API puts the batch item id in the results to
-- allow you to link data in the request to data in the results.
[$sel:batchItemId:CreateRowData'] :: CreateRowData -> Text
-- | A map representing the cells to create in the new row. The key is the
-- column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
[$sel:cellsToCreate:CreateRowData'] :: CreateRowData -> HashMap Text CellInput
-- | Create a value of CreateRowData 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:batchItemId:CreateRowData',
-- createRowData_batchItemId - An external identifier that
-- represents the single row that is being created as part of the
-- BatchCreateTableRows request. This can be any string that you can use
-- to identify the row in the request. The BatchCreateTableRows API puts
-- the batch item id in the results to allow you to link data in the
-- request to data in the results.
--
-- $sel:cellsToCreate:CreateRowData',
-- createRowData_cellsToCreate - A map representing the cells to
-- create in the new row. The key is the column id of the cell and the
-- value is the CellInput object that represents the data to set in that
-- cell.
newCreateRowData :: Text -> CreateRowData
-- | An external identifier that represents the single row that is being
-- created as part of the BatchCreateTableRows request. This can be any
-- string that you can use to identify the row in the request. The
-- BatchCreateTableRows API puts the batch item id in the results to
-- allow you to link data in the request to data in the results.
createRowData_batchItemId :: Lens' CreateRowData Text
-- | A map representing the cells to create in the new row. The key is the
-- column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
createRowData_cellsToCreate :: Lens' CreateRowData (HashMap Text CellInput)
-- | The data in a particular data cell defined on the screen.
--
-- See: newDataItem smart constructor.
data DataItem
DataItem' :: Maybe Text -> Maybe Format -> Maybe Text -> DataItem
-- | The formatted value of the data. e.g. John Smith.
[$sel:formattedValue:DataItem'] :: DataItem -> Maybe Text
-- | The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
[$sel:overrideFormat:DataItem'] :: DataItem -> Maybe Format
-- | The raw value of the data. e.g. jsmith@example.com
[$sel:rawValue:DataItem'] :: DataItem -> Maybe Text
-- | Create a value of DataItem 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:formattedValue:DataItem', dataItem_formattedValue -
-- The formatted value of the data. e.g. John Smith.
--
-- $sel:overrideFormat:DataItem', dataItem_overrideFormat -
-- The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
--
-- $sel:rawValue:DataItem', dataItem_rawValue - The raw
-- value of the data. e.g. jsmith@example.com
newDataItem :: DataItem
-- | The formatted value of the data. e.g. John Smith.
dataItem_formattedValue :: Lens' DataItem (Maybe Text)
-- | The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
dataItem_overrideFormat :: Lens' DataItem (Maybe Format)
-- | The raw value of the data. e.g. jsmith@example.com
dataItem_rawValue :: Lens' DataItem (Maybe Text)
-- | An object that contains the options relating to parsing delimited text
-- as part of an import request.
--
-- See: newDelimitedTextImportOptions smart constructor.
data DelimitedTextImportOptions
DelimitedTextImportOptions' :: Maybe ImportDataCharacterEncoding -> Maybe Bool -> Maybe Bool -> Text -> DelimitedTextImportOptions
-- | The encoding of the data in the input file.
[$sel:dataCharacterEncoding:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Maybe ImportDataCharacterEncoding
-- | Indicates whether the input file has a header row at the top
-- containing the column names.
[$sel:hasHeaderRow:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Maybe Bool
-- | A parameter to indicate whether empty rows should be ignored or be
-- included in the import.
[$sel:ignoreEmptyRows:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Maybe Bool
-- | The delimiter to use for separating columns in a single row of the
-- input.
[$sel:delimiter:DelimitedTextImportOptions'] :: DelimitedTextImportOptions -> Text
-- | Create a value of DelimitedTextImportOptions 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:dataCharacterEncoding:DelimitedTextImportOptions',
-- delimitedTextImportOptions_dataCharacterEncoding - The encoding
-- of the data in the input file.
--
-- $sel:hasHeaderRow:DelimitedTextImportOptions',
-- delimitedTextImportOptions_hasHeaderRow - Indicates whether the
-- input file has a header row at the top containing the column names.
--
-- $sel:ignoreEmptyRows:DelimitedTextImportOptions',
-- delimitedTextImportOptions_ignoreEmptyRows - A parameter to
-- indicate whether empty rows should be ignored or be included in the
-- import.
--
-- $sel:delimiter:DelimitedTextImportOptions',
-- delimitedTextImportOptions_delimiter - The delimiter to use for
-- separating columns in a single row of the input.
newDelimitedTextImportOptions :: Text -> DelimitedTextImportOptions
-- | The encoding of the data in the input file.
delimitedTextImportOptions_dataCharacterEncoding :: Lens' DelimitedTextImportOptions (Maybe ImportDataCharacterEncoding)
-- | Indicates whether the input file has a header row at the top
-- containing the column names.
delimitedTextImportOptions_hasHeaderRow :: Lens' DelimitedTextImportOptions (Maybe Bool)
-- | A parameter to indicate whether empty rows should be ignored or be
-- included in the import.
delimitedTextImportOptions_ignoreEmptyRows :: Lens' DelimitedTextImportOptions (Maybe Bool)
-- | The delimiter to use for separating columns in a single row of the
-- input.
delimitedTextImportOptions_delimiter :: Lens' DelimitedTextImportOptions Text
-- | An object that contains the options relating to the destination of the
-- import request.
--
-- See: newDestinationOptions smart constructor.
data DestinationOptions
DestinationOptions' :: Maybe (HashMap Text SourceDataColumnProperties) -> DestinationOptions
-- | A map of the column id to the import properties for each column.
[$sel:columnMap:DestinationOptions'] :: DestinationOptions -> Maybe (HashMap Text SourceDataColumnProperties)
-- | Create a value of DestinationOptions 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:columnMap:DestinationOptions',
-- destinationOptions_columnMap - A map of the column id to the
-- import properties for each column.
newDestinationOptions :: DestinationOptions
-- | A map of the column id to the import properties for each column.
destinationOptions_columnMap :: Lens' DestinationOptions (Maybe (HashMap Text SourceDataColumnProperties))
-- | A single item in a batch that failed to perform the intended action
-- because of an error preventing it from succeeding.
--
-- See: newFailedBatchItem smart constructor.
data FailedBatchItem
FailedBatchItem' :: Text -> Text -> FailedBatchItem
-- | The id of the batch item that failed. This is the batch item id for
-- the BatchCreateTableRows and BatchUpsertTableRows operations and the
-- row id for the BatchUpdateTableRows and BatchDeleteTableRows
-- operations.
[$sel:id:FailedBatchItem'] :: FailedBatchItem -> Text
-- | The error message that indicates why the batch item failed.
[$sel:errorMessage:FailedBatchItem'] :: FailedBatchItem -> Text
-- | Create a value of FailedBatchItem 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:id:FailedBatchItem', failedBatchItem_id - The id of
-- the batch item that failed. This is the batch item id for the
-- BatchCreateTableRows and BatchUpsertTableRows operations and the row
-- id for the BatchUpdateTableRows and BatchDeleteTableRows operations.
--
-- $sel:errorMessage:FailedBatchItem',
-- failedBatchItem_errorMessage - The error message that indicates
-- why the batch item failed.
newFailedBatchItem :: Text -> Text -> FailedBatchItem
-- | The id of the batch item that failed. This is the batch item id for
-- the BatchCreateTableRows and BatchUpsertTableRows operations and the
-- row id for the BatchUpdateTableRows and BatchDeleteTableRows
-- operations.
failedBatchItem_id :: Lens' FailedBatchItem Text
-- | The error message that indicates why the batch item failed.
failedBatchItem_errorMessage :: Lens' FailedBatchItem Text
-- | An object that represents a filter formula along with the id of the
-- context row under which the filter function needs to evaluate.
--
-- See: newFilter smart constructor.
data Filter
Filter' :: Maybe Text -> Sensitive Text -> Filter
-- | The optional contextRowId attribute can be used to specify the row id
-- of the context row if the filter formula contains unqualified
-- references to table columns and needs a context row to evaluate them
-- successfully.
[$sel:contextRowId:Filter'] :: Filter -> Maybe Text
-- | A formula representing a filter function that returns zero or more
-- matching rows from a table. Valid formulas in this field return a list
-- of rows from a table. The most common ways of writing a formula to
-- return a list of rows are to use the FindRow() or Filter() functions.
-- Any other formula that returns zero or more rows is also acceptable.
-- For example, you can use a formula that points to a cell that contains
-- a filter function.
[$sel:formula:Filter'] :: Filter -> Sensitive Text
-- | Create a value of Filter 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:contextRowId:Filter', filter_contextRowId - The
-- optional contextRowId attribute can be used to specify the row id of
-- the context row if the filter formula contains unqualified references
-- to table columns and needs a context row to evaluate them
-- successfully.
--
-- $sel:formula:Filter', filter_formula - A formula
-- representing a filter function that returns zero or more matching rows
-- from a table. Valid formulas in this field return a list of rows from
-- a table. The most common ways of writing a formula to return a list of
-- rows are to use the FindRow() or Filter() functions. Any other formula
-- that returns zero or more rows is also acceptable. For example, you
-- can use a formula that points to a cell that contains a filter
-- function.
newFilter :: Text -> Filter
-- | The optional contextRowId attribute can be used to specify the row id
-- of the context row if the filter formula contains unqualified
-- references to table columns and needs a context row to evaluate them
-- successfully.
filter_contextRowId :: Lens' Filter (Maybe Text)
-- | A formula representing a filter function that returns zero or more
-- matching rows from a table. Valid formulas in this field return a list
-- of rows from a table. The most common ways of writing a formula to
-- return a list of rows are to use the FindRow() or Filter() functions.
-- Any other formula that returns zero or more rows is also acceptable.
-- For example, you can use a formula that points to a cell that contains
-- a filter function.
filter_formula :: Lens' Filter Text
-- | An object that has details about the source of the data that was
-- submitted for import.
--
-- See: newImportDataSource smart constructor.
data ImportDataSource
ImportDataSource' :: ImportDataSourceConfig -> ImportDataSource
-- | The configuration parameters for the data source of the import
[$sel:dataSourceConfig:ImportDataSource'] :: ImportDataSource -> ImportDataSourceConfig
-- | Create a value of ImportDataSource 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:dataSourceConfig:ImportDataSource',
-- importDataSource_dataSourceConfig - The configuration
-- parameters for the data source of the import
newImportDataSource :: ImportDataSourceConfig -> ImportDataSource
-- | The configuration parameters for the data source of the import
importDataSource_dataSourceConfig :: Lens' ImportDataSource ImportDataSourceConfig
-- | An object that contains the configuration parameters for the data
-- source of an import request.
--
-- See: newImportDataSourceConfig smart constructor.
data ImportDataSourceConfig
ImportDataSourceConfig' :: Maybe (Sensitive Text) -> ImportDataSourceConfig
-- | The URL from which source data will be downloaded for the import
-- request.
[$sel:dataSourceUrl:ImportDataSourceConfig'] :: ImportDataSourceConfig -> Maybe (Sensitive Text)
-- | Create a value of ImportDataSourceConfig 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:dataSourceUrl:ImportDataSourceConfig',
-- importDataSourceConfig_dataSourceUrl - The URL from which
-- source data will be downloaded for the import request.
newImportDataSourceConfig :: ImportDataSourceConfig
-- | The URL from which source data will be downloaded for the import
-- request.
importDataSourceConfig_dataSourceUrl :: Lens' ImportDataSourceConfig (Maybe Text)
-- | An object that contains the attributes of the submitter of the import
-- job.
--
-- See: newImportJobSubmitter smart constructor.
data ImportJobSubmitter
ImportJobSubmitter' :: Maybe (Sensitive Text) -> Maybe Text -> ImportJobSubmitter
-- | The email id of the submitter of the import job, if available.
[$sel:email:ImportJobSubmitter'] :: ImportJobSubmitter -> Maybe (Sensitive Text)
-- | The AWS user ARN of the submitter of the import job, if available.
[$sel:userArn:ImportJobSubmitter'] :: ImportJobSubmitter -> Maybe Text
-- | Create a value of ImportJobSubmitter 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:email:ImportJobSubmitter', importJobSubmitter_email
-- - The email id of the submitter of the import job, if available.
--
-- $sel:userArn:ImportJobSubmitter',
-- importJobSubmitter_userArn - The AWS user ARN of the submitter
-- of the import job, if available.
newImportJobSubmitter :: ImportJobSubmitter
-- | The email id of the submitter of the import job, if available.
importJobSubmitter_email :: Lens' ImportJobSubmitter (Maybe Text)
-- | The AWS user ARN of the submitter of the import job, if available.
importJobSubmitter_userArn :: Lens' ImportJobSubmitter (Maybe Text)
-- | An object that contains the options specified by the sumitter of the
-- import request.
--
-- See: newImportOptions smart constructor.
data ImportOptions
ImportOptions' :: Maybe DelimitedTextImportOptions -> Maybe DestinationOptions -> ImportOptions
-- | Options relating to parsing delimited text. Required if dataFormat is
-- DELIMITED_TEXT.
[$sel:delimitedTextOptions:ImportOptions'] :: ImportOptions -> Maybe DelimitedTextImportOptions
-- | Options relating to the destination of the import request.
[$sel:destinationOptions:ImportOptions'] :: ImportOptions -> Maybe DestinationOptions
-- | Create a value of ImportOptions 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:delimitedTextOptions:ImportOptions',
-- importOptions_delimitedTextOptions - Options relating to
-- parsing delimited text. Required if dataFormat is DELIMITED_TEXT.
--
-- $sel:destinationOptions:ImportOptions',
-- importOptions_destinationOptions - Options relating to the
-- destination of the import request.
newImportOptions :: ImportOptions
-- | Options relating to parsing delimited text. Required if dataFormat is
-- DELIMITED_TEXT.
importOptions_delimitedTextOptions :: Lens' ImportOptions (Maybe DelimitedTextImportOptions)
-- | Options relating to the destination of the import request.
importOptions_destinationOptions :: Lens' ImportOptions (Maybe DestinationOptions)
-- | A single row in the ResultSet.
--
-- See: newResultRow smart constructor.
data ResultRow
ResultRow' :: Maybe Text -> [Sensitive DataItem] -> ResultRow
-- | The ID for a particular row.
[$sel:rowId:ResultRow'] :: ResultRow -> Maybe Text
-- | List of all the data cells in a row.
[$sel:dataItems:ResultRow'] :: ResultRow -> [Sensitive DataItem]
-- | Create a value of ResultRow 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:rowId:ResultRow', resultRow_rowId - The ID for a
-- particular row.
--
-- $sel:dataItems:ResultRow', resultRow_dataItems - List of
-- all the data cells in a row.
newResultRow :: ResultRow
-- | The ID for a particular row.
resultRow_rowId :: Lens' ResultRow (Maybe Text)
-- | List of all the data cells in a row.
resultRow_dataItems :: Lens' ResultRow [DataItem]
-- | ResultSet contains the results of the request for a single block or
-- list defined on the screen.
--
-- See: newResultSet smart constructor.
data ResultSet
ResultSet' :: [ColumnMetadata] -> [ResultRow] -> ResultSet
-- | List of headers for all the data cells in the block. The header
-- identifies the name and default format of the data cell. Data cells
-- appear in the same order in all rows as defined in the header. The
-- names and formats are not repeated in the rows. If a particular row
-- does not have a value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
[$sel:headers:ResultSet'] :: ResultSet -> [ColumnMetadata]
-- | List of rows returned by the request. Each row has a row Id and a list
-- of data cells in that row. The data cells will be present in the same
-- order as they are defined in the header.
[$sel:rows:ResultSet'] :: ResultSet -> [ResultRow]
-- | Create a value of ResultSet 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:headers:ResultSet', resultSet_headers - List of
-- headers for all the data cells in the block. The header identifies the
-- name and default format of the data cell. Data cells appear in the
-- same order in all rows as defined in the header. The names and formats
-- are not repeated in the rows. If a particular row does not have a
-- value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
--
-- $sel:rows:ResultSet', resultSet_rows - List of rows
-- returned by the request. Each row has a row Id and a list of data
-- cells in that row. The data cells will be present in the same order as
-- they are defined in the header.
newResultSet :: ResultSet
-- | List of headers for all the data cells in the block. The header
-- identifies the name and default format of the data cell. Data cells
-- appear in the same order in all rows as defined in the header. The
-- names and formats are not repeated in the rows. If a particular row
-- does not have a value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
resultSet_headers :: Lens' ResultSet [ColumnMetadata]
-- | List of rows returned by the request. Each row has a row Id and a list
-- of data cells in that row. The data cells will be present in the same
-- order as they are defined in the header.
resultSet_rows :: Lens' ResultSet [ResultRow]
-- | An object that contains the properties for importing data to a
-- specific column in a table.
--
-- See: newSourceDataColumnProperties smart constructor.
data SourceDataColumnProperties
SourceDataColumnProperties' :: Maybe Natural -> SourceDataColumnProperties
-- | The index of the column in the input file.
[$sel:columnIndex:SourceDataColumnProperties'] :: SourceDataColumnProperties -> Maybe Natural
-- | Create a value of SourceDataColumnProperties 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:columnIndex:SourceDataColumnProperties',
-- sourceDataColumnProperties_columnIndex - The index of the
-- column in the input file.
newSourceDataColumnProperties :: SourceDataColumnProperties
-- | The index of the column in the input file.
sourceDataColumnProperties_columnIndex :: Lens' SourceDataColumnProperties (Maybe Natural)
-- | An object representing the properties of a table in a workbook.
--
-- See: newTable smart constructor.
data Table
Table' :: Maybe Text -> Maybe Text -> Table
-- | The id of the table.
[$sel:tableId:Table'] :: Table -> Maybe Text
-- | The name of the table.
[$sel:tableName:Table'] :: Table -> Maybe Text
-- | Create a value of Table 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:tableId:Table', table_tableId - The id of the
-- table.
--
-- $sel:tableName:Table', table_tableName - The name of the
-- table.
newTable :: Table
-- | The id of the table.
table_tableId :: Lens' Table (Maybe Text)
-- | The name of the table.
table_tableName :: Lens' Table (Maybe Text)
-- | An object that contains attributes about a single column in a table
--
-- See: newTableColumn smart constructor.
data TableColumn
TableColumn' :: Maybe Format -> Maybe Text -> Maybe Text -> TableColumn
-- | The column level format that is applied in the table. An empty value
-- in this field means that the column format is the default value
-- 'AUTO'.
[$sel:format:TableColumn'] :: TableColumn -> Maybe Format
-- | The id of the column in the table.
[$sel:tableColumnId:TableColumn'] :: TableColumn -> Maybe Text
-- | The name of the column in the table.
[$sel:tableColumnName:TableColumn'] :: TableColumn -> Maybe Text
-- | Create a value of TableColumn 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:format:TableColumn', tableColumn_format - The
-- column level format that is applied in the table. An empty value in
-- this field means that the column format is the default value 'AUTO'.
--
-- $sel:tableColumnId:TableColumn',
-- tableColumn_tableColumnId - The id of the column in the table.
--
-- $sel:tableColumnName:TableColumn',
-- tableColumn_tableColumnName - The name of the column in the
-- table.
newTableColumn :: TableColumn
-- | The column level format that is applied in the table. An empty value
-- in this field means that the column format is the default value
-- 'AUTO'.
tableColumn_format :: Lens' TableColumn (Maybe Format)
-- | The id of the column in the table.
tableColumn_tableColumnId :: Lens' TableColumn (Maybe Text)
-- | The name of the column in the table.
tableColumn_tableColumnName :: Lens' TableColumn (Maybe Text)
-- | The metadata associated with the table data import job that was
-- submitted.
--
-- See: newTableDataImportJobMetadata smart constructor.
data TableDataImportJobMetadata
TableDataImportJobMetadata' :: ImportJobSubmitter -> POSIX -> ImportOptions -> ImportDataSource -> TableDataImportJobMetadata
-- | Details about the submitter of the import request.
[$sel:submitter:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> ImportJobSubmitter
-- | The timestamp when the job was submitted for import.
[$sel:submitTime:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> POSIX
-- | The options that was specified at the time of submitting the import
-- request.
[$sel:importOptions:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> ImportOptions
-- | The source of the data that was submitted for import.
[$sel:dataSource:TableDataImportJobMetadata'] :: TableDataImportJobMetadata -> ImportDataSource
-- | Create a value of TableDataImportJobMetadata 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:submitter:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_submitter - Details about the
-- submitter of the import request.
--
-- $sel:submitTime:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_submitTime - The timestamp when the
-- job was submitted for import.
--
-- $sel:importOptions:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_importOptions - The options that was
-- specified at the time of submitting the import request.
--
-- $sel:dataSource:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_dataSource - The source of the data
-- that was submitted for import.
newTableDataImportJobMetadata :: ImportJobSubmitter -> UTCTime -> ImportOptions -> ImportDataSource -> TableDataImportJobMetadata
-- | Details about the submitter of the import request.
tableDataImportJobMetadata_submitter :: Lens' TableDataImportJobMetadata ImportJobSubmitter
-- | The timestamp when the job was submitted for import.
tableDataImportJobMetadata_submitTime :: Lens' TableDataImportJobMetadata UTCTime
-- | The options that was specified at the time of submitting the import
-- request.
tableDataImportJobMetadata_importOptions :: Lens' TableDataImportJobMetadata ImportOptions
-- | The source of the data that was submitted for import.
tableDataImportJobMetadata_dataSource :: Lens' TableDataImportJobMetadata ImportDataSource
-- | An object that contains attributes about a single row in a table
--
-- See: newTableRow smart constructor.
data TableRow
TableRow' :: Text -> [Sensitive Cell] -> TableRow
-- | The id of the row in the table.
[$sel:rowId:TableRow'] :: TableRow -> Text
-- | A list of cells in the table row. The cells appear in the same order
-- as the columns of the table.
[$sel:cells:TableRow'] :: TableRow -> [Sensitive Cell]
-- | Create a value of TableRow 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:rowId:TableRow', tableRow_rowId - The id of the row
-- in the table.
--
-- $sel:cells:TableRow', tableRow_cells - A list of cells
-- in the table row. The cells appear in the same order as the columns of
-- the table.
newTableRow :: Text -> TableRow
-- | The id of the row in the table.
tableRow_rowId :: Lens' TableRow Text
-- | A list of cells in the table row. The cells appear in the same order
-- as the columns of the table.
tableRow_cells :: Lens' TableRow [Cell]
-- | Data needed to create a single row in a table as part of the
-- BatchCreateTableRows request.
--
-- See: newUpdateRowData smart constructor.
data UpdateRowData
UpdateRowData' :: Text -> HashMap Text CellInput -> UpdateRowData
-- | The id of the row that needs to be updated.
[$sel:rowId:UpdateRowData'] :: UpdateRowData -> Text
-- | A map representing the cells to update in the given row. The key is
-- the column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
[$sel:cellsToUpdate:UpdateRowData'] :: UpdateRowData -> HashMap Text CellInput
-- | Create a value of UpdateRowData 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:rowId:UpdateRowData', updateRowData_rowId - The id
-- of the row that needs to be updated.
--
-- $sel:cellsToUpdate:UpdateRowData',
-- updateRowData_cellsToUpdate - A map representing the cells to
-- update in the given row. The key is the column id of the cell and the
-- value is the CellInput object that represents the data to set in that
-- cell.
newUpdateRowData :: Text -> UpdateRowData
-- | The id of the row that needs to be updated.
updateRowData_rowId :: Lens' UpdateRowData Text
-- | A map representing the cells to update in the given row. The key is
-- the column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
updateRowData_cellsToUpdate :: Lens' UpdateRowData (HashMap Text CellInput)
-- | Data needed to upsert rows in a table as part of a single item in the
-- BatchUpsertTableRows request.
--
-- See: newUpsertRowData smart constructor.
data UpsertRowData
UpsertRowData' :: Text -> Filter -> HashMap Text CellInput -> UpsertRowData
-- | An external identifier that represents a single item in the request
-- that is being upserted as part of the BatchUpsertTableRows request.
-- This can be any string that you can use to identify the item in the
-- request. The BatchUpsertTableRows API puts the batch item id in the
-- results to allow you to link data in the request to data in the
-- results.
[$sel:batchItemId:UpsertRowData'] :: UpsertRowData -> Text
-- | The filter formula to use to find existing matching rows to update.
-- The formula needs to return zero or more rows. If the formula returns
-- 0 rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
[$sel:filter':UpsertRowData'] :: UpsertRowData -> Filter
-- | A map representing the cells to update for the matching rows or an
-- appended row. The key is the column id of the cell and the value is
-- the CellInput object that represents the data to set in that cell.
[$sel:cellsToUpdate:UpsertRowData'] :: UpsertRowData -> HashMap Text CellInput
-- | Create a value of UpsertRowData 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:batchItemId:UpsertRowData',
-- upsertRowData_batchItemId - An external identifier that
-- represents a single item in the request that is being upserted as part
-- of the BatchUpsertTableRows request. This can be any string that you
-- can use to identify the item in the request. The BatchUpsertTableRows
-- API puts the batch item id in the results to allow you to link data in
-- the request to data in the results.
--
-- $sel:filter':UpsertRowData', upsertRowData_filter - The
-- filter formula to use to find existing matching rows to update. The
-- formula needs to return zero or more rows. If the formula returns 0
-- rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
--
-- $sel:cellsToUpdate:UpsertRowData',
-- upsertRowData_cellsToUpdate - A map representing the cells to
-- update for the matching rows or an appended row. The key is the column
-- id of the cell and the value is the CellInput object that represents
-- the data to set in that cell.
newUpsertRowData :: Text -> Filter -> UpsertRowData
-- | An external identifier that represents a single item in the request
-- that is being upserted as part of the BatchUpsertTableRows request.
-- This can be any string that you can use to identify the item in the
-- request. The BatchUpsertTableRows API puts the batch item id in the
-- results to allow you to link data in the request to data in the
-- results.
upsertRowData_batchItemId :: Lens' UpsertRowData Text
-- | The filter formula to use to find existing matching rows to update.
-- The formula needs to return zero or more rows. If the formula returns
-- 0 rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
upsertRowData_filter :: Lens' UpsertRowData Filter
-- | A map representing the cells to update for the matching rows or an
-- appended row. The key is the column id of the cell and the value is
-- the CellInput object that represents the data to set in that cell.
upsertRowData_cellsToUpdate :: Lens' UpsertRowData (HashMap Text CellInput)
-- | An object that represents the result of a single upsert row request.
--
-- See: newUpsertRowsResult smart constructor.
data UpsertRowsResult
UpsertRowsResult' :: NonEmpty Text -> UpsertAction -> UpsertRowsResult
-- | The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
[$sel:rowIds:UpsertRowsResult'] :: UpsertRowsResult -> NonEmpty Text
-- | The result of the upsert action.
[$sel:upsertAction:UpsertRowsResult'] :: UpsertRowsResult -> UpsertAction
-- | Create a value of UpsertRowsResult 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:rowIds:UpsertRowsResult', upsertRowsResult_rowIds -
-- The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
--
-- $sel:upsertAction:UpsertRowsResult',
-- upsertRowsResult_upsertAction - The result of the upsert
-- action.
newUpsertRowsResult :: NonEmpty Text -> UpsertAction -> UpsertRowsResult
-- | The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
upsertRowsResult_rowIds :: Lens' UpsertRowsResult (NonEmpty Text)
-- | The result of the upsert action.
upsertRowsResult_upsertAction :: Lens' UpsertRowsResult UpsertAction
-- | The input variables to the app to be used by the
-- InvokeScreenAutomation action request.
--
-- See: newVariableValue smart constructor.
data VariableValue
VariableValue' :: Text -> VariableValue
-- | Raw value of the variable.
[$sel:rawValue:VariableValue'] :: VariableValue -> Text
-- | Create a value of VariableValue 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:rawValue:VariableValue', variableValue_rawValue -
-- Raw value of the variable.
newVariableValue :: Text -> VariableValue
-- | Raw value of the variable.
variableValue_rawValue :: Lens' VariableValue Text
-- | The TagResource API allows you to add tags to an ARN-able resource.
-- Resource includes workbook, table, screen and screen-automation.
module Amazonka.HoneyCode.TagResource
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> HashMap Text Text -> TagResource
-- | The resource's Amazon Resource Name (ARN).
[$sel:resourceArn:TagResource'] :: TagResource -> Text
-- | A list of tags to apply to the resource.
[$sel:tags:TagResource'] :: TagResource -> HashMap Text Text
-- | Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn -
-- The resource's Amazon Resource Name (ARN).
--
-- $sel:tags:TagResource', tagResource_tags - A list of
-- tags to apply to the resource.
newTagResource :: Text -> TagResource
-- | The resource's Amazon Resource Name (ARN).
tagResource_resourceArn :: Lens' TagResource Text
-- | A list of tags to apply to the resource.
tagResource_tags :: Lens' TagResource (HashMap Text Text)
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:TagResourceResponse'] :: TagResourceResponse -> Int
-- | Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse',
-- tagResourceResponse_httpStatus - The response's http status
-- code.
newTagResourceResponse :: Int -> TagResourceResponse
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
instance GHC.Generics.Generic Amazonka.HoneyCode.TagResource.TagResource
instance GHC.Show.Show Amazonka.HoneyCode.TagResource.TagResource
instance GHC.Read.Read Amazonka.HoneyCode.TagResource.TagResource
instance GHC.Classes.Eq Amazonka.HoneyCode.TagResource.TagResource
instance GHC.Generics.Generic Amazonka.HoneyCode.TagResource.TagResourceResponse
instance GHC.Show.Show Amazonka.HoneyCode.TagResource.TagResourceResponse
instance GHC.Read.Read Amazonka.HoneyCode.TagResource.TagResourceResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.TagResource.TagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.HoneyCode.TagResource.TagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.TagResource.TagResource
instance Control.DeepSeq.NFData Amazonka.HoneyCode.TagResource.TagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.TagResource.TagResource
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.TagResource.TagResource
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.TagResource.TagResource
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.TagResource.TagResource
-- | The StartTableDataImportJob API allows you to start an import job on a
-- table. This API will only return the id of the job that was started.
-- To find out the status of the import request, you need to call the
-- DescribeTableDataImportJob API.
module Amazonka.HoneyCode.StartTableDataImportJob
-- | See: newStartTableDataImportJob smart constructor.
data StartTableDataImportJob
StartTableDataImportJob' :: Text -> ImportDataSource -> ImportSourceDataFormat -> Text -> ImportOptions -> Text -> StartTableDataImportJob
-- | The ID of the workbook where the rows are being imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:StartTableDataImportJob'] :: StartTableDataImportJob -> Text
-- | The source of the data that is being imported. The size of source must
-- be no larger than 100 MB. Source must have no more than 100,000 cells
-- and no more than 1,000 rows.
[$sel:dataSource:StartTableDataImportJob'] :: StartTableDataImportJob -> ImportDataSource
-- | The format of the data that is being imported. Currently the only
-- option supported is "DELIMITED_TEXT".
[$sel:dataFormat:StartTableDataImportJob'] :: StartTableDataImportJob -> ImportSourceDataFormat
-- | The ID of the table where the rows are being imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:destinationTableId:StartTableDataImportJob'] :: StartTableDataImportJob -> Text
-- | The options for customizing this import request.
[$sel:importOptions:StartTableDataImportJob'] :: StartTableDataImportJob -> ImportOptions
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
[$sel:clientRequestToken:StartTableDataImportJob'] :: StartTableDataImportJob -> Text
-- | Create a value of StartTableDataImportJob 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:workbookId:StartTableDataImportJob',
-- startTableDataImportJob_workbookId - The ID of the workbook
-- where the rows are being imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- StartTableDataImportJob,
-- startTableDataImportJob_dataSource - The source of the data
-- that is being imported. The size of source must be no larger than 100
-- MB. Source must have no more than 100,000 cells and no more than 1,000
-- rows.
--
-- $sel:dataFormat:StartTableDataImportJob',
-- startTableDataImportJob_dataFormat - The format of the data
-- that is being imported. Currently the only option supported is
-- "DELIMITED_TEXT".
--
-- $sel:destinationTableId:StartTableDataImportJob',
-- startTableDataImportJob_destinationTableId - The ID of the
-- table where the rows are being imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- StartTableDataImportJob,
-- startTableDataImportJob_importOptions - The options for
-- customizing this import request.
--
-- $sel:clientRequestToken:StartTableDataImportJob',
-- startTableDataImportJob_clientRequestToken - The request token
-- for performing the update action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
newStartTableDataImportJob :: Text -> ImportDataSource -> ImportSourceDataFormat -> Text -> ImportOptions -> Text -> StartTableDataImportJob
-- | The ID of the workbook where the rows are being imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
startTableDataImportJob_workbookId :: Lens' StartTableDataImportJob Text
-- | The source of the data that is being imported. The size of source must
-- be no larger than 100 MB. Source must have no more than 100,000 cells
-- and no more than 1,000 rows.
startTableDataImportJob_dataSource :: Lens' StartTableDataImportJob ImportDataSource
-- | The format of the data that is being imported. Currently the only
-- option supported is "DELIMITED_TEXT".
startTableDataImportJob_dataFormat :: Lens' StartTableDataImportJob ImportSourceDataFormat
-- | The ID of the table where the rows are being imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
startTableDataImportJob_destinationTableId :: Lens' StartTableDataImportJob Text
-- | The options for customizing this import request.
startTableDataImportJob_importOptions :: Lens' StartTableDataImportJob ImportOptions
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
startTableDataImportJob_clientRequestToken :: Lens' StartTableDataImportJob Text
-- | See: newStartTableDataImportJobResponse smart
-- constructor.
data StartTableDataImportJobResponse
StartTableDataImportJobResponse' :: Int -> Text -> TableDataImportJobStatus -> StartTableDataImportJobResponse
-- | The response's http status code.
[$sel:httpStatus:StartTableDataImportJobResponse'] :: StartTableDataImportJobResponse -> Int
-- | The id that is assigned to this import job. Future requests to find
-- out the status of this import job need to send this id in the
-- appropriate parameter in the request.
[$sel:jobId:StartTableDataImportJobResponse'] :: StartTableDataImportJobResponse -> Text
-- | The status of the import job immediately after submitting the request.
[$sel:jobStatus:StartTableDataImportJobResponse'] :: StartTableDataImportJobResponse -> TableDataImportJobStatus
-- | Create a value of StartTableDataImportJobResponse 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:httpStatus:StartTableDataImportJobResponse',
-- startTableDataImportJobResponse_httpStatus - The response's
-- http status code.
--
-- $sel:jobId:StartTableDataImportJobResponse',
-- startTableDataImportJobResponse_jobId - The id that is assigned
-- to this import job. Future requests to find out the status of this
-- import job need to send this id in the appropriate parameter in the
-- request.
--
-- $sel:jobStatus:StartTableDataImportJobResponse',
-- startTableDataImportJobResponse_jobStatus - The status of the
-- import job immediately after submitting the request.
newStartTableDataImportJobResponse :: Int -> Text -> TableDataImportJobStatus -> StartTableDataImportJobResponse
-- | The response's http status code.
startTableDataImportJobResponse_httpStatus :: Lens' StartTableDataImportJobResponse Int
-- | The id that is assigned to this import job. Future requests to find
-- out the status of this import job need to send this id in the
-- appropriate parameter in the request.
startTableDataImportJobResponse_jobId :: Lens' StartTableDataImportJobResponse Text
-- | The status of the import job immediately after submitting the request.
startTableDataImportJobResponse_jobStatus :: Lens' StartTableDataImportJobResponse TableDataImportJobStatus
instance GHC.Generics.Generic Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance GHC.Show.Show Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance GHC.Classes.Eq Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance GHC.Generics.Generic Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJobResponse
instance GHC.Show.Show Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJobResponse
instance GHC.Read.Read Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJobResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJobResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance Control.DeepSeq.NFData Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJobResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance Control.DeepSeq.NFData Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.StartTableDataImportJob.StartTableDataImportJob
-- | The QueryTableRows API allows you to use a filter formula to query for
-- specific rows in a table.
--
-- This operation returns paginated results.
module Amazonka.HoneyCode.QueryTableRows
-- | See: newQueryTableRows smart constructor.
data QueryTableRows
QueryTableRows' :: Maybe Natural -> Maybe Text -> Text -> Text -> Filter -> QueryTableRows
-- | The maximum number of rows to return in each page of the results.
[$sel:maxResults:QueryTableRows'] :: QueryTableRows -> Maybe Natural
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
[$sel:nextToken:QueryTableRows'] :: QueryTableRows -> Maybe Text
-- | The ID of the workbook whose table rows are being queried.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:QueryTableRows'] :: QueryTableRows -> Text
-- | The ID of the table whose rows are being queried.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:QueryTableRows'] :: QueryTableRows -> Text
-- | An object that represents a filter formula along with the id of the
-- context row under which the filter function needs to evaluate.
[$sel:filterFormula:QueryTableRows'] :: QueryTableRows -> Filter
-- | Create a value of QueryTableRows 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:QueryTableRows',
-- queryTableRows_maxResults - The maximum number of rows to
-- return in each page of the results.
--
-- QueryTableRows, queryTableRows_nextToken - This
-- parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:workbookId:QueryTableRows',
-- queryTableRows_workbookId - The ID of the workbook whose table
-- rows are being queried.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- QueryTableRows, queryTableRows_tableId - The ID of the
-- table whose rows are being queried.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:filterFormula:QueryTableRows',
-- queryTableRows_filterFormula - An object that represents a
-- filter formula along with the id of the context row under which the
-- filter function needs to evaluate.
newQueryTableRows :: Text -> Text -> Filter -> QueryTableRows
-- | The maximum number of rows to return in each page of the results.
queryTableRows_maxResults :: Lens' QueryTableRows (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
queryTableRows_nextToken :: Lens' QueryTableRows (Maybe Text)
-- | The ID of the workbook whose table rows are being queried.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
queryTableRows_workbookId :: Lens' QueryTableRows Text
-- | The ID of the table whose rows are being queried.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
queryTableRows_tableId :: Lens' QueryTableRows Text
-- | An object that represents a filter formula along with the id of the
-- context row under which the filter function needs to evaluate.
queryTableRows_filterFormula :: Lens' QueryTableRows Filter
-- | See: newQueryTableRowsResponse smart constructor.
data QueryTableRowsResponse
QueryTableRowsResponse' :: Maybe Text -> Int -> NonEmpty Text -> [TableRow] -> Integer -> QueryTableRowsResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
[$sel:nextToken:QueryTableRowsResponse'] :: QueryTableRowsResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:QueryTableRowsResponse'] :: QueryTableRowsResponse -> Int
-- | The list of columns in the table whose row data is returned in the
-- result.
[$sel:columnIds:QueryTableRowsResponse'] :: QueryTableRowsResponse -> NonEmpty Text
-- | The list of rows in the table that match the query filter.
[$sel:rows:QueryTableRowsResponse'] :: QueryTableRowsResponse -> [TableRow]
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
[$sel:workbookCursor:QueryTableRowsResponse'] :: QueryTableRowsResponse -> Integer
-- | Create a value of QueryTableRowsResponse 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:
--
-- QueryTableRows, queryTableRowsResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
--
-- $sel:httpStatus:QueryTableRowsResponse',
-- queryTableRowsResponse_httpStatus - The response's http status
-- code.
--
-- $sel:columnIds:QueryTableRowsResponse',
-- queryTableRowsResponse_columnIds - The list of columns in the
-- table whose row data is returned in the result.
--
-- QueryTableRowsResponse, queryTableRowsResponse_rows -
-- The list of rows in the table that match the query filter.
--
-- $sel:workbookCursor:QueryTableRowsResponse',
-- queryTableRowsResponse_workbookCursor - Indicates the cursor of
-- the workbook at which the data returned by this request is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
newQueryTableRowsResponse :: Int -> NonEmpty Text -> Integer -> QueryTableRowsResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
queryTableRowsResponse_nextToken :: Lens' QueryTableRowsResponse (Maybe Text)
-- | The response's http status code.
queryTableRowsResponse_httpStatus :: Lens' QueryTableRowsResponse Int
-- | The list of columns in the table whose row data is returned in the
-- result.
queryTableRowsResponse_columnIds :: Lens' QueryTableRowsResponse (NonEmpty Text)
-- | The list of rows in the table that match the query filter.
queryTableRowsResponse_rows :: Lens' QueryTableRowsResponse [TableRow]
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
queryTableRowsResponse_workbookCursor :: Lens' QueryTableRowsResponse Integer
instance GHC.Generics.Generic Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance GHC.Show.Show Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance GHC.Classes.Eq Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance GHC.Generics.Generic Amazonka.HoneyCode.QueryTableRows.QueryTableRowsResponse
instance GHC.Show.Show Amazonka.HoneyCode.QueryTableRows.QueryTableRowsResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.QueryTableRows.QueryTableRowsResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.QueryTableRows.QueryTableRowsResponse
instance Amazonka.Pager.AWSPager Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.QueryTableRows.QueryTableRows
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.QueryTableRows.QueryTableRows
-- | The ListTagsForResource API allows you to return a resource's tags.
module Amazonka.HoneyCode.ListTagsForResource
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Text -> ListTagsForResource
-- | The resource's Amazon Resource Name (ARN).
[$sel:resourceArn:ListTagsForResource'] :: ListTagsForResource -> Text
-- | Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource',
-- listTagsForResource_resourceArn - The resource's Amazon
-- Resource Name (ARN).
newListTagsForResource :: Text -> ListTagsForResource
-- | The resource's Amazon Resource Name (ARN).
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Maybe (HashMap Text Text) -> Int -> ListTagsForResourceResponse
-- | The resource's tags.
[$sel:tags:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Maybe (HashMap Text Text)
-- | The response's http status code.
[$sel:httpStatus:ListTagsForResourceResponse'] :: ListTagsForResourceResponse -> Int
-- | Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse',
-- listTagsForResourceResponse_tags - The resource's tags.
--
-- $sel:httpStatus:ListTagsForResourceResponse',
-- listTagsForResourceResponse_httpStatus - The response's http
-- status code.
newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
-- | The resource's tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance GHC.Show.Show Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance GHC.Read.Read Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Show.Show Amazonka.HoneyCode.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Read.Read Amazonka.HoneyCode.ListTagsForResource.ListTagsForResourceResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTagsForResource.ListTagsForResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTagsForResource.ListTagsForResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.ListTagsForResource.ListTagsForResource
-- | The ListTables API allows you to retrieve a list of all the tables in
-- a workbook.
--
-- This operation returns paginated results.
module Amazonka.HoneyCode.ListTables
-- | See: newListTables smart constructor.
data ListTables
ListTables' :: Maybe Natural -> Maybe Text -> Text -> ListTables
-- | The maximum number of tables to return in each page of the results.
[$sel:maxResults:ListTables'] :: ListTables -> Maybe Natural
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
[$sel:nextToken:ListTables'] :: ListTables -> Maybe Text
-- | The ID of the workbook whose tables are being retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId: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:maxResults:ListTables', listTables_maxResults - The
-- maximum number of tables to return in each page of the results.
--
-- ListTables, listTables_nextToken - This parameter is
-- optional. If a nextToken is not specified, the API returns the first
-- page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:workbookId:ListTables', listTables_workbookId - The
-- ID of the workbook whose tables are being retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
newListTables :: Text -> ListTables
-- | The maximum number of tables to return in each page of the results.
listTables_maxResults :: Lens' ListTables (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
listTables_nextToken :: Lens' ListTables (Maybe Text)
-- | The ID of the workbook whose tables are being retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
listTables_workbookId :: Lens' ListTables Text
-- | See: newListTablesResponse smart constructor.
data ListTablesResponse
ListTablesResponse' :: Maybe Text -> Maybe Integer -> Int -> [Table] -> ListTablesResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
[$sel:nextToken:ListTablesResponse'] :: ListTablesResponse -> Maybe Text
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
[$sel:workbookCursor:ListTablesResponse'] :: ListTablesResponse -> Maybe Integer
-- | The response's http status code.
[$sel:httpStatus:ListTablesResponse'] :: ListTablesResponse -> Int
-- | The list of tables in the workbook.
[$sel:tables:ListTablesResponse'] :: ListTablesResponse -> [Table]
-- | 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 - Provides the
-- pagination token to load the next page if there are more results
-- matching the request. If a pagination token is not present in the
-- response, it means that all data matching the request has been loaded.
--
-- $sel:workbookCursor:ListTablesResponse',
-- listTablesResponse_workbookCursor - Indicates the cursor of the
-- workbook at which the data returned by this request is read. Workbook
-- cursor keeps increasing with every update and the increments are not
-- sequential.
--
-- $sel:httpStatus:ListTablesResponse',
-- listTablesResponse_httpStatus - The response's http status
-- code.
--
-- $sel:tables:ListTablesResponse',
-- listTablesResponse_tables - The list of tables in the workbook.
newListTablesResponse :: Int -> ListTablesResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
listTablesResponse_workbookCursor :: Lens' ListTablesResponse (Maybe Integer)
-- | The response's http status code.
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
-- | The list of tables in the workbook.
listTablesResponse_tables :: Lens' ListTablesResponse [Table]
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTables.ListTables
instance GHC.Show.Show Amazonka.HoneyCode.ListTables.ListTables
instance GHC.Read.Read Amazonka.HoneyCode.ListTables.ListTables
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTables.ListTables
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTables.ListTablesResponse
instance GHC.Show.Show Amazonka.HoneyCode.ListTables.ListTablesResponse
instance GHC.Read.Read Amazonka.HoneyCode.ListTables.ListTablesResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTables.ListTablesResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.ListTables.ListTables
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTables.ListTablesResponse
instance Amazonka.Pager.AWSPager Amazonka.HoneyCode.ListTables.ListTables
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.ListTables.ListTables
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTables.ListTables
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.ListTables.ListTables
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.ListTables.ListTables
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.ListTables.ListTables
-- | The ListTableRows API allows you to retrieve a list of all the rows in
-- a table in a workbook.
--
-- This operation returns paginated results.
module Amazonka.HoneyCode.ListTableRows
-- | See: newListTableRows smart constructor.
data ListTableRows
ListTableRows' :: Maybe Natural -> Maybe Text -> Maybe (NonEmpty Text) -> Text -> Text -> ListTableRows
-- | The maximum number of rows to return in each page of the results.
[$sel:maxResults:ListTableRows'] :: ListTableRows -> Maybe Natural
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
[$sel:nextToken:ListTableRows'] :: ListTableRows -> Maybe Text
-- | This parameter is optional. If one or more row ids are specified in
-- this list, then only the specified row ids are returned in the result.
-- If no row ids are specified here, then all the rows in the table are
-- returned.
[$sel:rowIds:ListTableRows'] :: ListTableRows -> Maybe (NonEmpty Text)
-- | The ID of the workbook that contains the table whose rows are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:ListTableRows'] :: ListTableRows -> Text
-- | The ID of the table whose rows are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:ListTableRows'] :: ListTableRows -> Text
-- | Create a value of ListTableRows 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:ListTableRows', listTableRows_maxResults
-- - The maximum number of rows to return in each page of the results.
--
-- ListTableRows, listTableRows_nextToken - This parameter
-- is optional. If a nextToken is not specified, the API returns the
-- first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- ListTableRows, listTableRows_rowIds - This parameter is
-- optional. If one or more row ids are specified in this list, then only
-- the specified row ids are returned in the result. If no row ids are
-- specified here, then all the rows in the table are returned.
--
-- $sel:workbookId:ListTableRows', listTableRows_workbookId
-- - The ID of the workbook that contains the table whose rows are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- ListTableRows, listTableRows_tableId - The ID of the
-- table whose rows are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
newListTableRows :: Text -> Text -> ListTableRows
-- | The maximum number of rows to return in each page of the results.
listTableRows_maxResults :: Lens' ListTableRows (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
listTableRows_nextToken :: Lens' ListTableRows (Maybe Text)
-- | This parameter is optional. If one or more row ids are specified in
-- this list, then only the specified row ids are returned in the result.
-- If no row ids are specified here, then all the rows in the table are
-- returned.
listTableRows_rowIds :: Lens' ListTableRows (Maybe (NonEmpty Text))
-- | The ID of the workbook that contains the table whose rows are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
listTableRows_workbookId :: Lens' ListTableRows Text
-- | The ID of the table whose rows are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
listTableRows_tableId :: Lens' ListTableRows Text
-- | See: newListTableRowsResponse smart constructor.
data ListTableRowsResponse
ListTableRowsResponse' :: Maybe Text -> Maybe (NonEmpty Text) -> Int -> NonEmpty Text -> [TableRow] -> Integer -> ListTableRowsResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
[$sel:nextToken:ListTableRowsResponse'] :: ListTableRowsResponse -> Maybe Text
-- | The list of row ids included in the request that were not found in the
-- table.
[$sel:rowIdsNotFound:ListTableRowsResponse'] :: ListTableRowsResponse -> Maybe (NonEmpty Text)
-- | The response's http status code.
[$sel:httpStatus:ListTableRowsResponse'] :: ListTableRowsResponse -> Int
-- | The list of columns in the table whose row data is returned in the
-- result.
[$sel:columnIds:ListTableRowsResponse'] :: ListTableRowsResponse -> NonEmpty Text
-- | The list of rows in the table. Note that this result is paginated, so
-- this list contains a maximum of 100 rows.
[$sel:rows:ListTableRowsResponse'] :: ListTableRowsResponse -> [TableRow]
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
[$sel:workbookCursor:ListTableRowsResponse'] :: ListTableRowsResponse -> Integer
-- | Create a value of ListTableRowsResponse 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:
--
-- ListTableRows, listTableRowsResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
--
-- $sel:rowIdsNotFound:ListTableRowsResponse',
-- listTableRowsResponse_rowIdsNotFound - The list of row ids
-- included in the request that were not found in the table.
--
-- $sel:httpStatus:ListTableRowsResponse',
-- listTableRowsResponse_httpStatus - The response's http status
-- code.
--
-- $sel:columnIds:ListTableRowsResponse',
-- listTableRowsResponse_columnIds - The list of columns in the
-- table whose row data is returned in the result.
--
-- ListTableRowsResponse, listTableRowsResponse_rows - The
-- list of rows in the table. Note that this result is paginated, so this
-- list contains a maximum of 100 rows.
--
-- $sel:workbookCursor:ListTableRowsResponse',
-- listTableRowsResponse_workbookCursor - Indicates the cursor of
-- the workbook at which the data returned by this request is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
newListTableRowsResponse :: Int -> NonEmpty Text -> Integer -> ListTableRowsResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
listTableRowsResponse_nextToken :: Lens' ListTableRowsResponse (Maybe Text)
-- | The list of row ids included in the request that were not found in the
-- table.
listTableRowsResponse_rowIdsNotFound :: Lens' ListTableRowsResponse (Maybe (NonEmpty Text))
-- | The response's http status code.
listTableRowsResponse_httpStatus :: Lens' ListTableRowsResponse Int
-- | The list of columns in the table whose row data is returned in the
-- result.
listTableRowsResponse_columnIds :: Lens' ListTableRowsResponse (NonEmpty Text)
-- | The list of rows in the table. Note that this result is paginated, so
-- this list contains a maximum of 100 rows.
listTableRowsResponse_rows :: Lens' ListTableRowsResponse [TableRow]
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
listTableRowsResponse_workbookCursor :: Lens' ListTableRowsResponse Integer
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTableRows.ListTableRows
instance GHC.Show.Show Amazonka.HoneyCode.ListTableRows.ListTableRows
instance GHC.Read.Read Amazonka.HoneyCode.ListTableRows.ListTableRows
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTableRows.ListTableRows
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTableRows.ListTableRowsResponse
instance GHC.Show.Show Amazonka.HoneyCode.ListTableRows.ListTableRowsResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTableRows.ListTableRowsResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.ListTableRows.ListTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTableRows.ListTableRowsResponse
instance Amazonka.Pager.AWSPager Amazonka.HoneyCode.ListTableRows.ListTableRows
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.ListTableRows.ListTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTableRows.ListTableRows
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.ListTableRows.ListTableRows
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.ListTableRows.ListTableRows
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.ListTableRows.ListTableRows
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.ListTableRows.ListTableRows
-- | The ListTableColumns API allows you to retrieve a list of all the
-- columns in a table in a workbook.
--
-- This operation returns paginated results.
module Amazonka.HoneyCode.ListTableColumns
-- | See: newListTableColumns smart constructor.
data ListTableColumns
ListTableColumns' :: Maybe Text -> Text -> Text -> ListTableColumns
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
[$sel:nextToken:ListTableColumns'] :: ListTableColumns -> Maybe Text
-- | The ID of the workbook that contains the table whose columns are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:ListTableColumns'] :: ListTableColumns -> Text
-- | The ID of the table whose columns are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:ListTableColumns'] :: ListTableColumns -> Text
-- | Create a value of ListTableColumns 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:
--
-- ListTableColumns, listTableColumns_nextToken - This
-- parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:workbookId:ListTableColumns',
-- listTableColumns_workbookId - The ID of the workbook that
-- contains the table whose columns are being retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- ListTableColumns, listTableColumns_tableId - The ID of
-- the table whose columns are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
newListTableColumns :: Text -> Text -> ListTableColumns
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
listTableColumns_nextToken :: Lens' ListTableColumns (Maybe Text)
-- | The ID of the workbook that contains the table whose columns are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
listTableColumns_workbookId :: Lens' ListTableColumns Text
-- | The ID of the table whose columns are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
listTableColumns_tableId :: Lens' ListTableColumns Text
-- | See: newListTableColumnsResponse smart constructor.
data ListTableColumnsResponse
ListTableColumnsResponse' :: Maybe Text -> Maybe Integer -> Int -> [TableColumn] -> ListTableColumnsResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
[$sel:nextToken:ListTableColumnsResponse'] :: ListTableColumnsResponse -> Maybe Text
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
[$sel:workbookCursor:ListTableColumnsResponse'] :: ListTableColumnsResponse -> Maybe Integer
-- | The response's http status code.
[$sel:httpStatus:ListTableColumnsResponse'] :: ListTableColumnsResponse -> Int
-- | The list of columns in the table.
[$sel:tableColumns:ListTableColumnsResponse'] :: ListTableColumnsResponse -> [TableColumn]
-- | Create a value of ListTableColumnsResponse 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:
--
-- ListTableColumns, listTableColumnsResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
--
-- $sel:workbookCursor:ListTableColumnsResponse',
-- listTableColumnsResponse_workbookCursor - Indicates the cursor
-- of the workbook at which the data returned by this request is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
--
-- $sel:httpStatus:ListTableColumnsResponse',
-- listTableColumnsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:tableColumns:ListTableColumnsResponse',
-- listTableColumnsResponse_tableColumns - The list of columns in
-- the table.
newListTableColumnsResponse :: Int -> ListTableColumnsResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
listTableColumnsResponse_nextToken :: Lens' ListTableColumnsResponse (Maybe Text)
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
listTableColumnsResponse_workbookCursor :: Lens' ListTableColumnsResponse (Maybe Integer)
-- | The response's http status code.
listTableColumnsResponse_httpStatus :: Lens' ListTableColumnsResponse Int
-- | The list of columns in the table.
listTableColumnsResponse_tableColumns :: Lens' ListTableColumnsResponse [TableColumn]
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance GHC.Show.Show Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance GHC.Read.Read Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance GHC.Generics.Generic Amazonka.HoneyCode.ListTableColumns.ListTableColumnsResponse
instance GHC.Show.Show Amazonka.HoneyCode.ListTableColumns.ListTableColumnsResponse
instance GHC.Read.Read Amazonka.HoneyCode.ListTableColumns.ListTableColumnsResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.ListTableColumns.ListTableColumnsResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTableColumns.ListTableColumnsResponse
instance Amazonka.Pager.AWSPager Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance Control.DeepSeq.NFData Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.ListTableColumns.ListTableColumns
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.ListTableColumns.ListTableColumns
-- | The InvokeScreenAutomation API allows invoking an action defined in a
-- screen in a Honeycode app. The API allows setting local variables,
-- which can then be used in the automation being invoked. This allows
-- automating the Honeycode app interactions to write, update or delete
-- data in the workbook.
module Amazonka.HoneyCode.InvokeScreenAutomation
-- | See: newInvokeScreenAutomation smart constructor.
data InvokeScreenAutomation
InvokeScreenAutomation' :: Maybe Text -> Maybe Text -> Maybe (Sensitive (HashMap Text (Sensitive VariableValue))) -> Text -> Text -> Text -> Text -> InvokeScreenAutomation
-- | The request token for performing the automation action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will return the response of the previous call rather than
-- performing the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
[$sel:clientRequestToken:InvokeScreenAutomation'] :: InvokeScreenAutomation -> Maybe Text
-- | The row ID for the automation if the automation is defined inside a
-- block with source or list.
[$sel:rowId:InvokeScreenAutomation'] :: InvokeScreenAutomation -> Maybe Text
-- | Variables are specified as a map where the key is the name of the
-- variable as defined on the screen. The value is an object which
-- currently has only one property, rawValue, which holds the value of
-- the variable to be passed to the screen. Any variables defined in a
-- screen are required to be passed in the call.
[$sel:variables:InvokeScreenAutomation'] :: InvokeScreenAutomation -> Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))
-- | The ID of the workbook that contains the screen automation.
[$sel:workbookId:InvokeScreenAutomation'] :: InvokeScreenAutomation -> Text
-- | The ID of the app that contains the screen automation.
[$sel:appId:InvokeScreenAutomation'] :: InvokeScreenAutomation -> Text
-- | The ID of the screen that contains the screen automation.
[$sel:screenId:InvokeScreenAutomation'] :: InvokeScreenAutomation -> Text
-- | The ID of the automation action to be performed.
[$sel:screenAutomationId:InvokeScreenAutomation'] :: InvokeScreenAutomation -> Text
-- | Create a value of InvokeScreenAutomation 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:clientRequestToken:InvokeScreenAutomation',
-- invokeScreenAutomation_clientRequestToken - The request token
-- for performing the automation action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will return the response of the previous call rather than performing
-- the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- InvokeScreenAutomation, invokeScreenAutomation_rowId -
-- The row ID for the automation if the automation is defined inside a
-- block with source or list.
--
-- $sel:variables:InvokeScreenAutomation',
-- invokeScreenAutomation_variables - Variables are specified as a
-- map where the key is the name of the variable as defined on the
-- screen. The value is an object which currently has only one property,
-- rawValue, which holds the value of the variable to be passed to the
-- screen. Any variables defined in a screen are required to be passed in
-- the call.
--
-- $sel:workbookId:InvokeScreenAutomation',
-- invokeScreenAutomation_workbookId - The ID of the workbook that
-- contains the screen automation.
--
-- $sel:appId:InvokeScreenAutomation',
-- invokeScreenAutomation_appId - The ID of the app that contains
-- the screen automation.
--
-- $sel:screenId:InvokeScreenAutomation',
-- invokeScreenAutomation_screenId - The ID of the screen that
-- contains the screen automation.
--
-- $sel:screenAutomationId:InvokeScreenAutomation',
-- invokeScreenAutomation_screenAutomationId - The ID of the
-- automation action to be performed.
newInvokeScreenAutomation :: Text -> Text -> Text -> Text -> InvokeScreenAutomation
-- | The request token for performing the automation action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will return the response of the previous call rather than
-- performing the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
invokeScreenAutomation_clientRequestToken :: Lens' InvokeScreenAutomation (Maybe Text)
-- | The row ID for the automation if the automation is defined inside a
-- block with source or list.
invokeScreenAutomation_rowId :: Lens' InvokeScreenAutomation (Maybe Text)
-- | Variables are specified as a map where the key is the name of the
-- variable as defined on the screen. The value is an object which
-- currently has only one property, rawValue, which holds the value of
-- the variable to be passed to the screen. Any variables defined in a
-- screen are required to be passed in the call.
invokeScreenAutomation_variables :: Lens' InvokeScreenAutomation (Maybe (HashMap Text VariableValue))
-- | The ID of the workbook that contains the screen automation.
invokeScreenAutomation_workbookId :: Lens' InvokeScreenAutomation Text
-- | The ID of the app that contains the screen automation.
invokeScreenAutomation_appId :: Lens' InvokeScreenAutomation Text
-- | The ID of the screen that contains the screen automation.
invokeScreenAutomation_screenId :: Lens' InvokeScreenAutomation Text
-- | The ID of the automation action to be performed.
invokeScreenAutomation_screenAutomationId :: Lens' InvokeScreenAutomation Text
-- | See: newInvokeScreenAutomationResponse smart
-- constructor.
data InvokeScreenAutomationResponse
InvokeScreenAutomationResponse' :: Int -> Integer -> InvokeScreenAutomationResponse
-- | The response's http status code.
[$sel:httpStatus:InvokeScreenAutomationResponse'] :: InvokeScreenAutomationResponse -> Int
-- | The updated workbook cursor after performing the automation action.
[$sel:workbookCursor:InvokeScreenAutomationResponse'] :: InvokeScreenAutomationResponse -> Integer
-- | Create a value of InvokeScreenAutomationResponse 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:httpStatus:InvokeScreenAutomationResponse',
-- invokeScreenAutomationResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:InvokeScreenAutomationResponse',
-- invokeScreenAutomationResponse_workbookCursor - The updated
-- workbook cursor after performing the automation action.
newInvokeScreenAutomationResponse :: Int -> Integer -> InvokeScreenAutomationResponse
-- | The response's http status code.
invokeScreenAutomationResponse_httpStatus :: Lens' InvokeScreenAutomationResponse Int
-- | The updated workbook cursor after performing the automation action.
invokeScreenAutomationResponse_workbookCursor :: Lens' InvokeScreenAutomationResponse Integer
instance GHC.Generics.Generic Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance GHC.Show.Show Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance GHC.Classes.Eq Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance GHC.Generics.Generic Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomationResponse
instance GHC.Show.Show Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomationResponse
instance GHC.Read.Read Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomationResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomationResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance Control.DeepSeq.NFData Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomationResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance Control.DeepSeq.NFData Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.InvokeScreenAutomation.InvokeScreenAutomation
-- | The GetScreenData API allows retrieval of data from a screen in a
-- Honeycode app. The API allows setting local variables in the screen to
-- filter, sort or otherwise affect what will be displayed on the screen.
module Amazonka.HoneyCode.GetScreenData
-- | See: newGetScreenData smart constructor.
data GetScreenData
GetScreenData' :: Maybe Natural -> Maybe Text -> Maybe (Sensitive (HashMap Text (Sensitive VariableValue))) -> Text -> Text -> Text -> GetScreenData
-- | The number of results to be returned on a single page. Specify a
-- number between 1 and 100. The maximum value is 100.
--
-- This parameter is optional. If you don't specify this parameter, the
-- default page size is 100.
[$sel:maxResults:GetScreenData'] :: GetScreenData -> Maybe Natural
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
[$sel:nextToken:GetScreenData'] :: GetScreenData -> Maybe Text
-- | Variables are optional and are needed only if the screen requires them
-- to render correctly. Variables are specified as a map where the key is
-- the name of the variable as defined on the screen. The value is an
-- object which currently has only one property, rawValue, which holds
-- the value of the variable to be passed to the screen.
[$sel:variables:GetScreenData'] :: GetScreenData -> Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))
-- | The ID of the workbook that contains the screen.
[$sel:workbookId:GetScreenData'] :: GetScreenData -> Text
-- | The ID of the app that contains the screen.
[$sel:appId:GetScreenData'] :: GetScreenData -> Text
-- | The ID of the screen.
[$sel:screenId:GetScreenData'] :: GetScreenData -> Text
-- | Create a value of GetScreenData 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:GetScreenData', getScreenData_maxResults
-- - The number of results to be returned on a single page. Specify a
-- number between 1 and 100. The maximum value is 100.
--
-- This parameter is optional. If you don't specify this parameter, the
-- default page size is 100.
--
-- GetScreenData, getScreenData_nextToken - This parameter
-- is optional. If a nextToken is not specified, the API returns the
-- first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:variables:GetScreenData', getScreenData_variables -
-- Variables are optional and are needed only if the screen requires them
-- to render correctly. Variables are specified as a map where the key is
-- the name of the variable as defined on the screen. The value is an
-- object which currently has only one property, rawValue, which holds
-- the value of the variable to be passed to the screen.
--
-- $sel:workbookId:GetScreenData', getScreenData_workbookId
-- - The ID of the workbook that contains the screen.
--
-- $sel:appId:GetScreenData', getScreenData_appId - The ID
-- of the app that contains the screen.
--
-- $sel:screenId:GetScreenData', getScreenData_screenId -
-- The ID of the screen.
newGetScreenData :: Text -> Text -> Text -> GetScreenData
-- | The number of results to be returned on a single page. Specify a
-- number between 1 and 100. The maximum value is 100.
--
-- This parameter is optional. If you don't specify this parameter, the
-- default page size is 100.
getScreenData_maxResults :: Lens' GetScreenData (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
getScreenData_nextToken :: Lens' GetScreenData (Maybe Text)
-- | Variables are optional and are needed only if the screen requires them
-- to render correctly. Variables are specified as a map where the key is
-- the name of the variable as defined on the screen. The value is an
-- object which currently has only one property, rawValue, which holds
-- the value of the variable to be passed to the screen.
getScreenData_variables :: Lens' GetScreenData (Maybe (HashMap Text VariableValue))
-- | The ID of the workbook that contains the screen.
getScreenData_workbookId :: Lens' GetScreenData Text
-- | The ID of the app that contains the screen.
getScreenData_appId :: Lens' GetScreenData Text
-- | The ID of the screen.
getScreenData_screenId :: Lens' GetScreenData Text
-- | See: newGetScreenDataResponse smart constructor.
data GetScreenDataResponse
GetScreenDataResponse' :: Maybe Text -> Int -> HashMap Text ResultSet -> Integer -> GetScreenDataResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the query has been
-- loaded.
[$sel:nextToken:GetScreenDataResponse'] :: GetScreenDataResponse -> Maybe Text
-- | The response's http status code.
[$sel:httpStatus:GetScreenDataResponse'] :: GetScreenDataResponse -> Int
-- | A map of all the rows on the screen keyed by block name.
[$sel:results:GetScreenDataResponse'] :: GetScreenDataResponse -> HashMap Text ResultSet
-- | Indicates the cursor of the workbook at which the data returned by
-- this workbook is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
[$sel:workbookCursor:GetScreenDataResponse'] :: GetScreenDataResponse -> Integer
-- | Create a value of GetScreenDataResponse 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:
--
-- GetScreenData, getScreenDataResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the query has been
-- loaded.
--
-- $sel:httpStatus:GetScreenDataResponse',
-- getScreenDataResponse_httpStatus - The response's http status
-- code.
--
-- $sel:results:GetScreenDataResponse',
-- getScreenDataResponse_results - A map of all the rows on the
-- screen keyed by block name.
--
-- $sel:workbookCursor:GetScreenDataResponse',
-- getScreenDataResponse_workbookCursor - Indicates the cursor of
-- the workbook at which the data returned by this workbook is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
newGetScreenDataResponse :: Int -> Integer -> GetScreenDataResponse
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the query has been
-- loaded.
getScreenDataResponse_nextToken :: Lens' GetScreenDataResponse (Maybe Text)
-- | The response's http status code.
getScreenDataResponse_httpStatus :: Lens' GetScreenDataResponse Int
-- | A map of all the rows on the screen keyed by block name.
getScreenDataResponse_results :: Lens' GetScreenDataResponse (HashMap Text ResultSet)
-- | Indicates the cursor of the workbook at which the data returned by
-- this workbook is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
getScreenDataResponse_workbookCursor :: Lens' GetScreenDataResponse Integer
instance GHC.Generics.Generic Amazonka.HoneyCode.GetScreenData.GetScreenData
instance GHC.Show.Show Amazonka.HoneyCode.GetScreenData.GetScreenData
instance GHC.Classes.Eq Amazonka.HoneyCode.GetScreenData.GetScreenData
instance GHC.Generics.Generic Amazonka.HoneyCode.GetScreenData.GetScreenDataResponse
instance GHC.Show.Show Amazonka.HoneyCode.GetScreenData.GetScreenDataResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.GetScreenData.GetScreenDataResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.GetScreenData.GetScreenData
instance Control.DeepSeq.NFData Amazonka.HoneyCode.GetScreenData.GetScreenDataResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.GetScreenData.GetScreenData
instance Control.DeepSeq.NFData Amazonka.HoneyCode.GetScreenData.GetScreenData
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.GetScreenData.GetScreenData
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.GetScreenData.GetScreenData
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.GetScreenData.GetScreenData
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.GetScreenData.GetScreenData
-- | The DescribeTableDataImportJob API allows you to retrieve the status
-- and details of a table data import job.
module Amazonka.HoneyCode.DescribeTableDataImportJob
-- | See: newDescribeTableDataImportJob smart constructor.
data DescribeTableDataImportJob
DescribeTableDataImportJob' :: Text -> Text -> Text -> DescribeTableDataImportJob
-- | The ID of the workbook into which data was imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:DescribeTableDataImportJob'] :: DescribeTableDataImportJob -> Text
-- | The ID of the table into which data was imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:DescribeTableDataImportJob'] :: DescribeTableDataImportJob -> Text
-- | The ID of the job that was returned by the StartTableDataImportJob
-- request.
--
-- If a job with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:jobId:DescribeTableDataImportJob'] :: DescribeTableDataImportJob -> Text
-- | Create a value of DescribeTableDataImportJob 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:workbookId:DescribeTableDataImportJob',
-- describeTableDataImportJob_workbookId - The ID of the workbook
-- into which data was imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- DescribeTableDataImportJob,
-- describeTableDataImportJob_tableId - The ID of the table into
-- which data was imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:jobId:DescribeTableDataImportJob',
-- describeTableDataImportJob_jobId - The ID of the job that was
-- returned by the StartTableDataImportJob request.
--
-- If a job with the specified id could not be found, this API throws
-- ResourceNotFoundException.
newDescribeTableDataImportJob :: Text -> Text -> Text -> DescribeTableDataImportJob
-- | The ID of the workbook into which data was imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
describeTableDataImportJob_workbookId :: Lens' DescribeTableDataImportJob Text
-- | The ID of the table into which data was imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
describeTableDataImportJob_tableId :: Lens' DescribeTableDataImportJob Text
-- | The ID of the job that was returned by the StartTableDataImportJob
-- request.
--
-- If a job with the specified id could not be found, this API throws
-- ResourceNotFoundException.
describeTableDataImportJob_jobId :: Lens' DescribeTableDataImportJob Text
-- | See: newDescribeTableDataImportJobResponse smart
-- constructor.
data DescribeTableDataImportJobResponse
DescribeTableDataImportJobResponse' :: Maybe ErrorCode -> Int -> TableDataImportJobStatus -> Text -> TableDataImportJobMetadata -> DescribeTableDataImportJobResponse
-- | If job status is failed, error code to understand reason for the
-- failure.
[$sel:errorCode:DescribeTableDataImportJobResponse'] :: DescribeTableDataImportJobResponse -> Maybe ErrorCode
-- | The response's http status code.
[$sel:httpStatus:DescribeTableDataImportJobResponse'] :: DescribeTableDataImportJobResponse -> Int
-- | The current status of the import job.
[$sel:jobStatus:DescribeTableDataImportJobResponse'] :: DescribeTableDataImportJobResponse -> TableDataImportJobStatus
-- | A message providing more details about the current status of the
-- import job.
[$sel:message:DescribeTableDataImportJobResponse'] :: DescribeTableDataImportJobResponse -> Text
-- | The metadata about the job that was submitted for import.
[$sel:jobMetadata:DescribeTableDataImportJobResponse'] :: DescribeTableDataImportJobResponse -> TableDataImportJobMetadata
-- | Create a value of DescribeTableDataImportJobResponse 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:errorCode:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_errorCode - If job status is
-- failed, error code to understand reason for the failure.
--
-- $sel:httpStatus:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_httpStatus - The response's
-- http status code.
--
-- $sel:jobStatus:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_jobStatus - The current
-- status of the import job.
--
-- $sel:message:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_message - A message
-- providing more details about the current status of the import job.
--
-- $sel:jobMetadata:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_jobMetadata - The metadata
-- about the job that was submitted for import.
newDescribeTableDataImportJobResponse :: Int -> TableDataImportJobStatus -> Text -> TableDataImportJobMetadata -> DescribeTableDataImportJobResponse
-- | If job status is failed, error code to understand reason for the
-- failure.
describeTableDataImportJobResponse_errorCode :: Lens' DescribeTableDataImportJobResponse (Maybe ErrorCode)
-- | The response's http status code.
describeTableDataImportJobResponse_httpStatus :: Lens' DescribeTableDataImportJobResponse Int
-- | The current status of the import job.
describeTableDataImportJobResponse_jobStatus :: Lens' DescribeTableDataImportJobResponse TableDataImportJobStatus
-- | A message providing more details about the current status of the
-- import job.
describeTableDataImportJobResponse_message :: Lens' DescribeTableDataImportJobResponse Text
-- | The metadata about the job that was submitted for import.
describeTableDataImportJobResponse_jobMetadata :: Lens' DescribeTableDataImportJobResponse TableDataImportJobMetadata
instance GHC.Generics.Generic Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance GHC.Show.Show Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance GHC.Read.Read Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance GHC.Classes.Eq Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance GHC.Generics.Generic Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJobResponse
instance GHC.Show.Show Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJobResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJobResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance Control.DeepSeq.NFData Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJobResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance Control.DeepSeq.NFData Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.DescribeTableDataImportJob.DescribeTableDataImportJob
-- | The BatchUpsertTableRows API allows you to upsert one or more rows in
-- a table. The upsert operation takes a filter expression as input and
-- evaluates it to find matching rows on the destination table. If
-- matching rows are found, it will update the cells in the matching rows
-- to new values specified in the request. If no matching rows are found,
-- a new row is added at the end of the table and the cells in that row
-- are set to the new values specified in the request.
--
-- You can specify the values to set in some or all of the columns in the
-- table for the matching or newly appended rows. If a column is not
-- explicitly specified for a particular row, then that column will not
-- be updated for that row. To clear out the data in a specific cell, you
-- need to set the value as an empty string ("").
module Amazonka.HoneyCode.BatchUpsertTableRows
-- | See: newBatchUpsertTableRows smart constructor.
data BatchUpsertTableRows
BatchUpsertTableRows' :: Maybe Text -> Text -> Text -> [UpsertRowData] -> BatchUpsertTableRows
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
[$sel:clientRequestToken:BatchUpsertTableRows'] :: BatchUpsertTableRows -> Maybe Text
-- | The ID of the workbook where the rows are being upserted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:BatchUpsertTableRows'] :: BatchUpsertTableRows -> Text
-- | The ID of the table where the rows are being upserted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:BatchUpsertTableRows'] :: BatchUpsertTableRows -> Text
-- | The list of rows to upsert in the table. Each item in this list needs
-- to have a batch item id to uniquely identify the element in the
-- request, a filter expression to find the rows to update for that
-- element and the cell values to set for each column in the upserted
-- rows. You need to specify at least one item in this list.
--
-- Note that if one of the filter formulas in the request fails to
-- evaluate because of an error or one of the column ids in any of the
-- rows does not exist in the table, then the request fails and no
-- updates are made to the table.
[$sel:rowsToUpsert:BatchUpsertTableRows'] :: BatchUpsertTableRows -> [UpsertRowData]
-- | Create a value of BatchUpsertTableRows 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:clientRequestToken:BatchUpsertTableRows',
-- batchUpsertTableRows_clientRequestToken - The request token for
-- performing the update action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchUpsertTableRows',
-- batchUpsertTableRows_workbookId - The ID of the workbook where
-- the rows are being upserted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchUpsertTableRows, batchUpsertTableRows_tableId - The
-- ID of the table where the rows are being upserted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:rowsToUpsert:BatchUpsertTableRows',
-- batchUpsertTableRows_rowsToUpsert - The list of rows to upsert
-- in the table. Each item in this list needs to have a batch item id to
-- uniquely identify the element in the request, a filter expression to
-- find the rows to update for that element and the cell values to set
-- for each column in the upserted rows. You need to specify at least one
-- item in this list.
--
-- Note that if one of the filter formulas in the request fails to
-- evaluate because of an error or one of the column ids in any of the
-- rows does not exist in the table, then the request fails and no
-- updates are made to the table.
newBatchUpsertTableRows :: Text -> Text -> BatchUpsertTableRows
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchUpsertTableRows_clientRequestToken :: Lens' BatchUpsertTableRows (Maybe Text)
-- | The ID of the workbook where the rows are being upserted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
batchUpsertTableRows_workbookId :: Lens' BatchUpsertTableRows Text
-- | The ID of the table where the rows are being upserted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
batchUpsertTableRows_tableId :: Lens' BatchUpsertTableRows Text
-- | The list of rows to upsert in the table. Each item in this list needs
-- to have a batch item id to uniquely identify the element in the
-- request, a filter expression to find the rows to update for that
-- element and the cell values to set for each column in the upserted
-- rows. You need to specify at least one item in this list.
--
-- Note that if one of the filter formulas in the request fails to
-- evaluate because of an error or one of the column ids in any of the
-- rows does not exist in the table, then the request fails and no
-- updates are made to the table.
batchUpsertTableRows_rowsToUpsert :: Lens' BatchUpsertTableRows [UpsertRowData]
-- | See: newBatchUpsertTableRowsResponse smart constructor.
data BatchUpsertTableRowsResponse
BatchUpsertTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> HashMap Text UpsertRowsResult -> Integer -> BatchUpsertTableRowsResponse
-- | The list of batch items in the request that could not be updated or
-- appended in the table. Each element in this list contains one item
-- from the request that could not be updated in the table along with the
-- reason why that item could not be updated or appended.
[$sel:failedBatchItems:BatchUpsertTableRowsResponse'] :: BatchUpsertTableRowsResponse -> Maybe [FailedBatchItem]
-- | The response's http status code.
[$sel:httpStatus:BatchUpsertTableRowsResponse'] :: BatchUpsertTableRowsResponse -> Int
-- | A map with the batch item id as the key and the result of the upsert
-- operation as the value. The result of the upsert operation specifies
-- whether existing rows were updated or a new row was appended, along
-- with the list of row ids that were affected.
[$sel:rows:BatchUpsertTableRowsResponse'] :: BatchUpsertTableRowsResponse -> HashMap Text UpsertRowsResult
-- | The updated workbook cursor after updating or appending rows in the
-- table.
[$sel:workbookCursor:BatchUpsertTableRowsResponse'] :: BatchUpsertTableRowsResponse -> Integer
-- | Create a value of BatchUpsertTableRowsResponse 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:failedBatchItems:BatchUpsertTableRowsResponse',
-- batchUpsertTableRowsResponse_failedBatchItems - The list of
-- batch items in the request that could not be updated or appended in
-- the table. Each element in this list contains one item from the
-- request that could not be updated in the table along with the reason
-- why that item could not be updated or appended.
--
-- $sel:httpStatus:BatchUpsertTableRowsResponse',
-- batchUpsertTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- BatchUpsertTableRowsResponse,
-- batchUpsertTableRowsResponse_rows - A map with the batch item
-- id as the key and the result of the upsert operation as the value. The
-- result of the upsert operation specifies whether existing rows were
-- updated or a new row was appended, along with the list of row ids that
-- were affected.
--
-- $sel:workbookCursor:BatchUpsertTableRowsResponse',
-- batchUpsertTableRowsResponse_workbookCursor - The updated
-- workbook cursor after updating or appending rows in the table.
newBatchUpsertTableRowsResponse :: Int -> Integer -> BatchUpsertTableRowsResponse
-- | The list of batch items in the request that could not be updated or
-- appended in the table. Each element in this list contains one item
-- from the request that could not be updated in the table along with the
-- reason why that item could not be updated or appended.
batchUpsertTableRowsResponse_failedBatchItems :: Lens' BatchUpsertTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchUpsertTableRowsResponse_httpStatus :: Lens' BatchUpsertTableRowsResponse Int
-- | A map with the batch item id as the key and the result of the upsert
-- operation as the value. The result of the upsert operation specifies
-- whether existing rows were updated or a new row was appended, along
-- with the list of row ids that were affected.
batchUpsertTableRowsResponse_rows :: Lens' BatchUpsertTableRowsResponse (HashMap Text UpsertRowsResult)
-- | The updated workbook cursor after updating or appending rows in the
-- table.
batchUpsertTableRowsResponse_workbookCursor :: Lens' BatchUpsertTableRowsResponse Integer
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance GHC.Show.Show Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRowsResponse
instance GHC.Show.Show Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRowsResponse
instance GHC.Read.Read Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRowsResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRowsResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRowsResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.BatchUpsertTableRows.BatchUpsertTableRows
-- | The BatchUpdateTableRows API allows you to update one or more rows in
-- a table in a workbook.
--
-- You can specify the values to set in some or all of the columns in the
-- table for the specified rows. If a column is not explicitly specified
-- in a particular row, then that column will not be updated for that
-- row. To clear out the data in a specific cell, you need to set the
-- value as an empty string ("").
module Amazonka.HoneyCode.BatchUpdateTableRows
-- | See: newBatchUpdateTableRows smart constructor.
data BatchUpdateTableRows
BatchUpdateTableRows' :: Maybe Text -> Text -> Text -> NonEmpty UpdateRowData -> BatchUpdateTableRows
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
[$sel:clientRequestToken:BatchUpdateTableRows'] :: BatchUpdateTableRows -> Maybe Text
-- | The ID of the workbook where the rows are being updated.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:BatchUpdateTableRows'] :: BatchUpdateTableRows -> Text
-- | The ID of the table where the rows are being updated.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:BatchUpdateTableRows'] :: BatchUpdateTableRows -> Text
-- | The list of rows to update in the table. Each item in this list needs
-- to contain the row id to update along with the map of column id to
-- cell values for each column in that row that needs to be updated. You
-- need to specify at least one row in this list, and for each row, you
-- need to specify at least one column to update.
--
-- Note that if one of the row or column ids in the request does not
-- exist in the table, then the request fails and no updates are made to
-- the table.
[$sel:rowsToUpdate:BatchUpdateTableRows'] :: BatchUpdateTableRows -> NonEmpty UpdateRowData
-- | Create a value of BatchUpdateTableRows 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:clientRequestToken:BatchUpdateTableRows',
-- batchUpdateTableRows_clientRequestToken - The request token for
-- performing the update action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchUpdateTableRows',
-- batchUpdateTableRows_workbookId - The ID of the workbook where
-- the rows are being updated.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchUpdateTableRows, batchUpdateTableRows_tableId - The
-- ID of the table where the rows are being updated.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:rowsToUpdate:BatchUpdateTableRows',
-- batchUpdateTableRows_rowsToUpdate - The list of rows to update
-- in the table. Each item in this list needs to contain the row id to
-- update along with the map of column id to cell values for each column
-- in that row that needs to be updated. You need to specify at least one
-- row in this list, and for each row, you need to specify at least one
-- column to update.
--
-- Note that if one of the row or column ids in the request does not
-- exist in the table, then the request fails and no updates are made to
-- the table.
newBatchUpdateTableRows :: Text -> Text -> NonEmpty UpdateRowData -> BatchUpdateTableRows
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchUpdateTableRows_clientRequestToken :: Lens' BatchUpdateTableRows (Maybe Text)
-- | The ID of the workbook where the rows are being updated.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
batchUpdateTableRows_workbookId :: Lens' BatchUpdateTableRows Text
-- | The ID of the table where the rows are being updated.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
batchUpdateTableRows_tableId :: Lens' BatchUpdateTableRows Text
-- | The list of rows to update in the table. Each item in this list needs
-- to contain the row id to update along with the map of column id to
-- cell values for each column in that row that needs to be updated. You
-- need to specify at least one row in this list, and for each row, you
-- need to specify at least one column to update.
--
-- Note that if one of the row or column ids in the request does not
-- exist in the table, then the request fails and no updates are made to
-- the table.
batchUpdateTableRows_rowsToUpdate :: Lens' BatchUpdateTableRows (NonEmpty UpdateRowData)
-- | See: newBatchUpdateTableRowsResponse smart constructor.
data BatchUpdateTableRowsResponse
BatchUpdateTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> Integer -> BatchUpdateTableRowsResponse
-- | The list of batch items in the request that could not be updated in
-- the table. Each element in this list contains one item from the
-- request that could not be updated in the table along with the reason
-- why that item could not be updated.
[$sel:failedBatchItems:BatchUpdateTableRowsResponse'] :: BatchUpdateTableRowsResponse -> Maybe [FailedBatchItem]
-- | The response's http status code.
[$sel:httpStatus:BatchUpdateTableRowsResponse'] :: BatchUpdateTableRowsResponse -> Int
-- | The updated workbook cursor after adding the new rows at the end of
-- the table.
[$sel:workbookCursor:BatchUpdateTableRowsResponse'] :: BatchUpdateTableRowsResponse -> Integer
-- | Create a value of BatchUpdateTableRowsResponse 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:failedBatchItems:BatchUpdateTableRowsResponse',
-- batchUpdateTableRowsResponse_failedBatchItems - The list of
-- batch items in the request that could not be updated in the table.
-- Each element in this list contains one item from the request that
-- could not be updated in the table along with the reason why that item
-- could not be updated.
--
-- $sel:httpStatus:BatchUpdateTableRowsResponse',
-- batchUpdateTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:BatchUpdateTableRowsResponse',
-- batchUpdateTableRowsResponse_workbookCursor - The updated
-- workbook cursor after adding the new rows at the end of the table.
newBatchUpdateTableRowsResponse :: Int -> Integer -> BatchUpdateTableRowsResponse
-- | The list of batch items in the request that could not be updated in
-- the table. Each element in this list contains one item from the
-- request that could not be updated in the table along with the reason
-- why that item could not be updated.
batchUpdateTableRowsResponse_failedBatchItems :: Lens' BatchUpdateTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchUpdateTableRowsResponse_httpStatus :: Lens' BatchUpdateTableRowsResponse Int
-- | The updated workbook cursor after adding the new rows at the end of
-- the table.
batchUpdateTableRowsResponse_workbookCursor :: Lens' BatchUpdateTableRowsResponse Integer
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance GHC.Show.Show Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRowsResponse
instance GHC.Show.Show Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRowsResponse
instance GHC.Read.Read Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRowsResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRowsResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRowsResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.BatchUpdateTableRows.BatchUpdateTableRows
-- | The BatchDeleteTableRows API allows you to delete one or more rows
-- from a table in a workbook. You need to specify the ids of the rows
-- that you want to delete from the table.
module Amazonka.HoneyCode.BatchDeleteTableRows
-- | See: newBatchDeleteTableRows smart constructor.
data BatchDeleteTableRows
BatchDeleteTableRows' :: Maybe Text -> Text -> Text -> NonEmpty Text -> BatchDeleteTableRows
-- | The request token for performing the delete action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
[$sel:clientRequestToken:BatchDeleteTableRows'] :: BatchDeleteTableRows -> Maybe Text
-- | The ID of the workbook where the rows are being deleted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:BatchDeleteTableRows'] :: BatchDeleteTableRows -> Text
-- | The ID of the table where the rows are being deleted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:BatchDeleteTableRows'] :: BatchDeleteTableRows -> Text
-- | The list of row ids to delete from the table. You need to specify at
-- least one row id in this list.
--
-- Note that if one of the row ids provided in the request does not exist
-- in the table, then the request fails and no rows are deleted from the
-- table.
[$sel:rowIds:BatchDeleteTableRows'] :: BatchDeleteTableRows -> NonEmpty Text
-- | Create a value of BatchDeleteTableRows 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:clientRequestToken:BatchDeleteTableRows',
-- batchDeleteTableRows_clientRequestToken - The request token for
-- performing the delete action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchDeleteTableRows',
-- batchDeleteTableRows_workbookId - The ID of the workbook where
-- the rows are being deleted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchDeleteTableRows, batchDeleteTableRows_tableId - The
-- ID of the table where the rows are being deleted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- BatchDeleteTableRows, batchDeleteTableRows_rowIds - The
-- list of row ids to delete from the table. You need to specify at least
-- one row id in this list.
--
-- Note that if one of the row ids provided in the request does not exist
-- in the table, then the request fails and no rows are deleted from the
-- table.
newBatchDeleteTableRows :: Text -> Text -> NonEmpty Text -> BatchDeleteTableRows
-- | The request token for performing the delete action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchDeleteTableRows_clientRequestToken :: Lens' BatchDeleteTableRows (Maybe Text)
-- | The ID of the workbook where the rows are being deleted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
batchDeleteTableRows_workbookId :: Lens' BatchDeleteTableRows Text
-- | The ID of the table where the rows are being deleted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
batchDeleteTableRows_tableId :: Lens' BatchDeleteTableRows Text
-- | The list of row ids to delete from the table. You need to specify at
-- least one row id in this list.
--
-- Note that if one of the row ids provided in the request does not exist
-- in the table, then the request fails and no rows are deleted from the
-- table.
batchDeleteTableRows_rowIds :: Lens' BatchDeleteTableRows (NonEmpty Text)
-- | See: newBatchDeleteTableRowsResponse smart constructor.
data BatchDeleteTableRowsResponse
BatchDeleteTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> Integer -> BatchDeleteTableRowsResponse
-- | The list of row ids in the request that could not be deleted from the
-- table. Each element in this list contains one row id from the request
-- that could not be deleted along with the reason why that item could
-- not be deleted.
[$sel:failedBatchItems:BatchDeleteTableRowsResponse'] :: BatchDeleteTableRowsResponse -> Maybe [FailedBatchItem]
-- | The response's http status code.
[$sel:httpStatus:BatchDeleteTableRowsResponse'] :: BatchDeleteTableRowsResponse -> Int
-- | The updated workbook cursor after deleting the rows from the table.
[$sel:workbookCursor:BatchDeleteTableRowsResponse'] :: BatchDeleteTableRowsResponse -> Integer
-- | Create a value of BatchDeleteTableRowsResponse 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:failedBatchItems:BatchDeleteTableRowsResponse',
-- batchDeleteTableRowsResponse_failedBatchItems - The list of row
-- ids in the request that could not be deleted from the table. Each
-- element in this list contains one row id from the request that could
-- not be deleted along with the reason why that item could not be
-- deleted.
--
-- $sel:httpStatus:BatchDeleteTableRowsResponse',
-- batchDeleteTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:BatchDeleteTableRowsResponse',
-- batchDeleteTableRowsResponse_workbookCursor - The updated
-- workbook cursor after deleting the rows from the table.
newBatchDeleteTableRowsResponse :: Int -> Integer -> BatchDeleteTableRowsResponse
-- | The list of row ids in the request that could not be deleted from the
-- table. Each element in this list contains one row id from the request
-- that could not be deleted along with the reason why that item could
-- not be deleted.
batchDeleteTableRowsResponse_failedBatchItems :: Lens' BatchDeleteTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchDeleteTableRowsResponse_httpStatus :: Lens' BatchDeleteTableRowsResponse Int
-- | The updated workbook cursor after deleting the rows from the table.
batchDeleteTableRowsResponse_workbookCursor :: Lens' BatchDeleteTableRowsResponse Integer
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance GHC.Show.Show Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance GHC.Read.Read Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRowsResponse
instance GHC.Show.Show Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRowsResponse
instance GHC.Read.Read Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRowsResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRowsResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRowsResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.BatchDeleteTableRows.BatchDeleteTableRows
-- | The BatchCreateTableRows API allows you to create one or more rows at
-- the end of a table in a workbook. The API allows you to specify the
-- values to set in some or all of the columns in the new rows.
--
-- If a column is not explicitly set in a specific row, then the column
-- level formula specified in the table will be applied to the new row.
-- If there is no column level formula but the last row of the table has
-- a formula, then that formula will be copied down to the new row. If
-- there is no column level formula and no formula in the last row of the
-- table, then that column will be left blank for the new rows.
module Amazonka.HoneyCode.BatchCreateTableRows
-- | See: newBatchCreateTableRows smart constructor.
data BatchCreateTableRows
BatchCreateTableRows' :: Maybe Text -> Text -> Text -> NonEmpty CreateRowData -> BatchCreateTableRows
-- | The request token for performing the batch create operation. Request
-- tokens help to identify duplicate requests. If a call times out or
-- fails due to a transient error like a failed network connection, you
-- can retry the call with the same request token. The service ensures
-- that if the first call using that request token is successfully
-- performed, the second call will not perform the operation again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
[$sel:clientRequestToken:BatchCreateTableRows'] :: BatchCreateTableRows -> Maybe Text
-- | The ID of the workbook where the new rows are being added.
--
-- If a workbook with the specified ID could not be found, this API
-- throws ResourceNotFoundException.
[$sel:workbookId:BatchCreateTableRows'] :: BatchCreateTableRows -> Text
-- | The ID of the table where the new rows are being added.
--
-- If a table with the specified ID could not be found, this API throws
-- ResourceNotFoundException.
[$sel:tableId:BatchCreateTableRows'] :: BatchCreateTableRows -> Text
-- | The list of rows to create at the end of the table. Each item in this
-- list needs to have a batch item id to uniquely identify the element in
-- the request and the cells to create for that row. You need to specify
-- at least one item in this list.
--
-- Note that if one of the column ids in any of the rows in the request
-- does not exist in the table, then the request fails and no updates are
-- made to the table.
[$sel:rowsToCreate:BatchCreateTableRows'] :: BatchCreateTableRows -> NonEmpty CreateRowData
-- | Create a value of BatchCreateTableRows 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:clientRequestToken:BatchCreateTableRows',
-- batchCreateTableRows_clientRequestToken - The request token for
-- performing the batch create operation. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the operation again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchCreateTableRows',
-- batchCreateTableRows_workbookId - The ID of the workbook where
-- the new rows are being added.
--
-- If a workbook with the specified ID could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchCreateTableRows, batchCreateTableRows_tableId - The
-- ID of the table where the new rows are being added.
--
-- If a table with the specified ID could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:rowsToCreate:BatchCreateTableRows',
-- batchCreateTableRows_rowsToCreate - The list of rows to create
-- at the end of the table. Each item in this list needs to have a batch
-- item id to uniquely identify the element in the request and the cells
-- to create for that row. You need to specify at least one item in this
-- list.
--
-- Note that if one of the column ids in any of the rows in the request
-- does not exist in the table, then the request fails and no updates are
-- made to the table.
newBatchCreateTableRows :: Text -> Text -> NonEmpty CreateRowData -> BatchCreateTableRows
-- | The request token for performing the batch create operation. Request
-- tokens help to identify duplicate requests. If a call times out or
-- fails due to a transient error like a failed network connection, you
-- can retry the call with the same request token. The service ensures
-- that if the first call using that request token is successfully
-- performed, the second call will not perform the operation again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchCreateTableRows_clientRequestToken :: Lens' BatchCreateTableRows (Maybe Text)
-- | The ID of the workbook where the new rows are being added.
--
-- If a workbook with the specified ID could not be found, this API
-- throws ResourceNotFoundException.
batchCreateTableRows_workbookId :: Lens' BatchCreateTableRows Text
-- | The ID of the table where the new rows are being added.
--
-- If a table with the specified ID could not be found, this API throws
-- ResourceNotFoundException.
batchCreateTableRows_tableId :: Lens' BatchCreateTableRows Text
-- | The list of rows to create at the end of the table. Each item in this
-- list needs to have a batch item id to uniquely identify the element in
-- the request and the cells to create for that row. You need to specify
-- at least one item in this list.
--
-- Note that if one of the column ids in any of the rows in the request
-- does not exist in the table, then the request fails and no updates are
-- made to the table.
batchCreateTableRows_rowsToCreate :: Lens' BatchCreateTableRows (NonEmpty CreateRowData)
-- | See: newBatchCreateTableRowsResponse smart constructor.
data BatchCreateTableRowsResponse
BatchCreateTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> Integer -> HashMap Text Text -> BatchCreateTableRowsResponse
-- | The list of batch items in the request that could not be added to the
-- table. Each element in this list contains one item from the request
-- that could not be added to the table along with the reason why that
-- item could not be added.
[$sel:failedBatchItems:BatchCreateTableRowsResponse'] :: BatchCreateTableRowsResponse -> Maybe [FailedBatchItem]
-- | The response's http status code.
[$sel:httpStatus:BatchCreateTableRowsResponse'] :: BatchCreateTableRowsResponse -> Int
-- | The updated workbook cursor after adding the new rows at the end of
-- the table.
[$sel:workbookCursor:BatchCreateTableRowsResponse'] :: BatchCreateTableRowsResponse -> Integer
-- | The map of batch item id to the row id that was created for that item.
[$sel:createdRows:BatchCreateTableRowsResponse'] :: BatchCreateTableRowsResponse -> HashMap Text Text
-- | Create a value of BatchCreateTableRowsResponse 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:failedBatchItems:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_failedBatchItems - The list of
-- batch items in the request that could not be added to the table. Each
-- element in this list contains one item from the request that could not
-- be added to the table along with the reason why that item could not be
-- added.
--
-- $sel:httpStatus:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_workbookCursor - The updated
-- workbook cursor after adding the new rows at the end of the table.
--
-- $sel:createdRows:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_createdRows - The map of batch
-- item id to the row id that was created for that item.
newBatchCreateTableRowsResponse :: Int -> Integer -> BatchCreateTableRowsResponse
-- | The list of batch items in the request that could not be added to the
-- table. Each element in this list contains one item from the request
-- that could not be added to the table along with the reason why that
-- item could not be added.
batchCreateTableRowsResponse_failedBatchItems :: Lens' BatchCreateTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchCreateTableRowsResponse_httpStatus :: Lens' BatchCreateTableRowsResponse Int
-- | The updated workbook cursor after adding the new rows at the end of
-- the table.
batchCreateTableRowsResponse_workbookCursor :: Lens' BatchCreateTableRowsResponse Integer
-- | The map of batch item id to the row id that was created for that item.
batchCreateTableRowsResponse_createdRows :: Lens' BatchCreateTableRowsResponse (HashMap Text Text)
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance GHC.Show.Show Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance GHC.Generics.Generic Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRowsResponse
instance GHC.Show.Show Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRowsResponse
instance GHC.Read.Read Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRowsResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRowsResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRowsResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance Control.DeepSeq.NFData Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance Data.Aeson.Types.ToJSON.ToJSON Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.BatchCreateTableRows.BatchCreateTableRows
-- | The UntagResource API allows you to removes tags from an ARN-able
-- resource. Resource includes workbook, table, screen and
-- screen-automation.
module Amazonka.HoneyCode.UntagResource
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> [Text] -> UntagResource
-- | The resource's Amazon Resource Name (ARN).
[$sel:resourceArn:UntagResource'] :: UntagResource -> Text
-- | A list of tag keys to remove from the resource.
[$sel:tagKeys:UntagResource'] :: UntagResource -> [Text]
-- | Create a value of UntagResource 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:resourceArn:UntagResource',
-- untagResource_resourceArn - The resource's Amazon Resource Name
-- (ARN).
--
-- $sel:tagKeys:UntagResource', untagResource_tagKeys - A
-- list of tag keys to remove from the resource.
newUntagResource :: Text -> UntagResource
-- | The resource's Amazon Resource Name (ARN).
untagResource_resourceArn :: Lens' UntagResource Text
-- | A list of tag keys to remove from the resource.
untagResource_tagKeys :: Lens' UntagResource [Text]
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | The response's http status code.
[$sel:httpStatus:UntagResourceResponse'] :: UntagResourceResponse -> Int
-- | Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse',
-- untagResourceResponse_httpStatus - The response's http status
-- code.
newUntagResourceResponse :: Int -> UntagResourceResponse
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
instance GHC.Generics.Generic Amazonka.HoneyCode.UntagResource.UntagResource
instance GHC.Show.Show Amazonka.HoneyCode.UntagResource.UntagResource
instance GHC.Read.Read Amazonka.HoneyCode.UntagResource.UntagResource
instance GHC.Classes.Eq Amazonka.HoneyCode.UntagResource.UntagResource
instance GHC.Generics.Generic Amazonka.HoneyCode.UntagResource.UntagResourceResponse
instance GHC.Show.Show Amazonka.HoneyCode.UntagResource.UntagResourceResponse
instance GHC.Read.Read Amazonka.HoneyCode.UntagResource.UntagResourceResponse
instance GHC.Classes.Eq Amazonka.HoneyCode.UntagResource.UntagResourceResponse
instance Amazonka.Types.AWSRequest Amazonka.HoneyCode.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.HoneyCode.UntagResource.UntagResourceResponse
instance Data.Hashable.Class.Hashable Amazonka.HoneyCode.UntagResource.UntagResource
instance Control.DeepSeq.NFData Amazonka.HoneyCode.UntagResource.UntagResource
instance Amazonka.Data.Headers.ToHeaders Amazonka.HoneyCode.UntagResource.UntagResource
instance Amazonka.Data.Path.ToPath Amazonka.HoneyCode.UntagResource.UntagResource
instance Amazonka.Data.Query.ToQuery Amazonka.HoneyCode.UntagResource.UntagResource
module Amazonka.HoneyCode.Lens
-- | The request token for performing the batch create operation. Request
-- tokens help to identify duplicate requests. If a call times out or
-- fails due to a transient error like a failed network connection, you
-- can retry the call with the same request token. The service ensures
-- that if the first call using that request token is successfully
-- performed, the second call will not perform the operation again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchCreateTableRows_clientRequestToken :: Lens' BatchCreateTableRows (Maybe Text)
-- | The ID of the workbook where the new rows are being added.
--
-- If a workbook with the specified ID could not be found, this API
-- throws ResourceNotFoundException.
batchCreateTableRows_workbookId :: Lens' BatchCreateTableRows Text
-- | The ID of the table where the new rows are being added.
--
-- If a table with the specified ID could not be found, this API throws
-- ResourceNotFoundException.
batchCreateTableRows_tableId :: Lens' BatchCreateTableRows Text
-- | The list of rows to create at the end of the table. Each item in this
-- list needs to have a batch item id to uniquely identify the element in
-- the request and the cells to create for that row. You need to specify
-- at least one item in this list.
--
-- Note that if one of the column ids in any of the rows in the request
-- does not exist in the table, then the request fails and no updates are
-- made to the table.
batchCreateTableRows_rowsToCreate :: Lens' BatchCreateTableRows (NonEmpty CreateRowData)
-- | The list of batch items in the request that could not be added to the
-- table. Each element in this list contains one item from the request
-- that could not be added to the table along with the reason why that
-- item could not be added.
batchCreateTableRowsResponse_failedBatchItems :: Lens' BatchCreateTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchCreateTableRowsResponse_httpStatus :: Lens' BatchCreateTableRowsResponse Int
-- | The updated workbook cursor after adding the new rows at the end of
-- the table.
batchCreateTableRowsResponse_workbookCursor :: Lens' BatchCreateTableRowsResponse Integer
-- | The map of batch item id to the row id that was created for that item.
batchCreateTableRowsResponse_createdRows :: Lens' BatchCreateTableRowsResponse (HashMap Text Text)
-- | The request token for performing the delete action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchDeleteTableRows_clientRequestToken :: Lens' BatchDeleteTableRows (Maybe Text)
-- | The ID of the workbook where the rows are being deleted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
batchDeleteTableRows_workbookId :: Lens' BatchDeleteTableRows Text
-- | The ID of the table where the rows are being deleted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
batchDeleteTableRows_tableId :: Lens' BatchDeleteTableRows Text
-- | The list of row ids to delete from the table. You need to specify at
-- least one row id in this list.
--
-- Note that if one of the row ids provided in the request does not exist
-- in the table, then the request fails and no rows are deleted from the
-- table.
batchDeleteTableRows_rowIds :: Lens' BatchDeleteTableRows (NonEmpty Text)
-- | The list of row ids in the request that could not be deleted from the
-- table. Each element in this list contains one row id from the request
-- that could not be deleted along with the reason why that item could
-- not be deleted.
batchDeleteTableRowsResponse_failedBatchItems :: Lens' BatchDeleteTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchDeleteTableRowsResponse_httpStatus :: Lens' BatchDeleteTableRowsResponse Int
-- | The updated workbook cursor after deleting the rows from the table.
batchDeleteTableRowsResponse_workbookCursor :: Lens' BatchDeleteTableRowsResponse Integer
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchUpdateTableRows_clientRequestToken :: Lens' BatchUpdateTableRows (Maybe Text)
-- | The ID of the workbook where the rows are being updated.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
batchUpdateTableRows_workbookId :: Lens' BatchUpdateTableRows Text
-- | The ID of the table where the rows are being updated.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
batchUpdateTableRows_tableId :: Lens' BatchUpdateTableRows Text
-- | The list of rows to update in the table. Each item in this list needs
-- to contain the row id to update along with the map of column id to
-- cell values for each column in that row that needs to be updated. You
-- need to specify at least one row in this list, and for each row, you
-- need to specify at least one column to update.
--
-- Note that if one of the row or column ids in the request does not
-- exist in the table, then the request fails and no updates are made to
-- the table.
batchUpdateTableRows_rowsToUpdate :: Lens' BatchUpdateTableRows (NonEmpty UpdateRowData)
-- | The list of batch items in the request that could not be updated in
-- the table. Each element in this list contains one item from the
-- request that could not be updated in the table along with the reason
-- why that item could not be updated.
batchUpdateTableRowsResponse_failedBatchItems :: Lens' BatchUpdateTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchUpdateTableRowsResponse_httpStatus :: Lens' BatchUpdateTableRowsResponse Int
-- | The updated workbook cursor after adding the new rows at the end of
-- the table.
batchUpdateTableRowsResponse_workbookCursor :: Lens' BatchUpdateTableRowsResponse Integer
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
batchUpsertTableRows_clientRequestToken :: Lens' BatchUpsertTableRows (Maybe Text)
-- | The ID of the workbook where the rows are being upserted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
batchUpsertTableRows_workbookId :: Lens' BatchUpsertTableRows Text
-- | The ID of the table where the rows are being upserted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
batchUpsertTableRows_tableId :: Lens' BatchUpsertTableRows Text
-- | The list of rows to upsert in the table. Each item in this list needs
-- to have a batch item id to uniquely identify the element in the
-- request, a filter expression to find the rows to update for that
-- element and the cell values to set for each column in the upserted
-- rows. You need to specify at least one item in this list.
--
-- Note that if one of the filter formulas in the request fails to
-- evaluate because of an error or one of the column ids in any of the
-- rows does not exist in the table, then the request fails and no
-- updates are made to the table.
batchUpsertTableRows_rowsToUpsert :: Lens' BatchUpsertTableRows [UpsertRowData]
-- | The list of batch items in the request that could not be updated or
-- appended in the table. Each element in this list contains one item
-- from the request that could not be updated in the table along with the
-- reason why that item could not be updated or appended.
batchUpsertTableRowsResponse_failedBatchItems :: Lens' BatchUpsertTableRowsResponse (Maybe [FailedBatchItem])
-- | The response's http status code.
batchUpsertTableRowsResponse_httpStatus :: Lens' BatchUpsertTableRowsResponse Int
-- | A map with the batch item id as the key and the result of the upsert
-- operation as the value. The result of the upsert operation specifies
-- whether existing rows were updated or a new row was appended, along
-- with the list of row ids that were affected.
batchUpsertTableRowsResponse_rows :: Lens' BatchUpsertTableRowsResponse (HashMap Text UpsertRowsResult)
-- | The updated workbook cursor after updating or appending rows in the
-- table.
batchUpsertTableRowsResponse_workbookCursor :: Lens' BatchUpsertTableRowsResponse Integer
-- | The ID of the workbook into which data was imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
describeTableDataImportJob_workbookId :: Lens' DescribeTableDataImportJob Text
-- | The ID of the table into which data was imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
describeTableDataImportJob_tableId :: Lens' DescribeTableDataImportJob Text
-- | The ID of the job that was returned by the StartTableDataImportJob
-- request.
--
-- If a job with the specified id could not be found, this API throws
-- ResourceNotFoundException.
describeTableDataImportJob_jobId :: Lens' DescribeTableDataImportJob Text
-- | If job status is failed, error code to understand reason for the
-- failure.
describeTableDataImportJobResponse_errorCode :: Lens' DescribeTableDataImportJobResponse (Maybe ErrorCode)
-- | The response's http status code.
describeTableDataImportJobResponse_httpStatus :: Lens' DescribeTableDataImportJobResponse Int
-- | The current status of the import job.
describeTableDataImportJobResponse_jobStatus :: Lens' DescribeTableDataImportJobResponse TableDataImportJobStatus
-- | A message providing more details about the current status of the
-- import job.
describeTableDataImportJobResponse_message :: Lens' DescribeTableDataImportJobResponse Text
-- | The metadata about the job that was submitted for import.
describeTableDataImportJobResponse_jobMetadata :: Lens' DescribeTableDataImportJobResponse TableDataImportJobMetadata
-- | The number of results to be returned on a single page. Specify a
-- number between 1 and 100. The maximum value is 100.
--
-- This parameter is optional. If you don't specify this parameter, the
-- default page size is 100.
getScreenData_maxResults :: Lens' GetScreenData (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
getScreenData_nextToken :: Lens' GetScreenData (Maybe Text)
-- | Variables are optional and are needed only if the screen requires them
-- to render correctly. Variables are specified as a map where the key is
-- the name of the variable as defined on the screen. The value is an
-- object which currently has only one property, rawValue, which holds
-- the value of the variable to be passed to the screen.
getScreenData_variables :: Lens' GetScreenData (Maybe (HashMap Text VariableValue))
-- | The ID of the workbook that contains the screen.
getScreenData_workbookId :: Lens' GetScreenData Text
-- | The ID of the app that contains the screen.
getScreenData_appId :: Lens' GetScreenData Text
-- | The ID of the screen.
getScreenData_screenId :: Lens' GetScreenData Text
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the query has been
-- loaded.
getScreenDataResponse_nextToken :: Lens' GetScreenDataResponse (Maybe Text)
-- | The response's http status code.
getScreenDataResponse_httpStatus :: Lens' GetScreenDataResponse Int
-- | A map of all the rows on the screen keyed by block name.
getScreenDataResponse_results :: Lens' GetScreenDataResponse (HashMap Text ResultSet)
-- | Indicates the cursor of the workbook at which the data returned by
-- this workbook is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
getScreenDataResponse_workbookCursor :: Lens' GetScreenDataResponse Integer
-- | The request token for performing the automation action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will return the response of the previous call rather than
-- performing the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
invokeScreenAutomation_clientRequestToken :: Lens' InvokeScreenAutomation (Maybe Text)
-- | The row ID for the automation if the automation is defined inside a
-- block with source or list.
invokeScreenAutomation_rowId :: Lens' InvokeScreenAutomation (Maybe Text)
-- | Variables are specified as a map where the key is the name of the
-- variable as defined on the screen. The value is an object which
-- currently has only one property, rawValue, which holds the value of
-- the variable to be passed to the screen. Any variables defined in a
-- screen are required to be passed in the call.
invokeScreenAutomation_variables :: Lens' InvokeScreenAutomation (Maybe (HashMap Text VariableValue))
-- | The ID of the workbook that contains the screen automation.
invokeScreenAutomation_workbookId :: Lens' InvokeScreenAutomation Text
-- | The ID of the app that contains the screen automation.
invokeScreenAutomation_appId :: Lens' InvokeScreenAutomation Text
-- | The ID of the screen that contains the screen automation.
invokeScreenAutomation_screenId :: Lens' InvokeScreenAutomation Text
-- | The ID of the automation action to be performed.
invokeScreenAutomation_screenAutomationId :: Lens' InvokeScreenAutomation Text
-- | The response's http status code.
invokeScreenAutomationResponse_httpStatus :: Lens' InvokeScreenAutomationResponse Int
-- | The updated workbook cursor after performing the automation action.
invokeScreenAutomationResponse_workbookCursor :: Lens' InvokeScreenAutomationResponse Integer
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
listTableColumns_nextToken :: Lens' ListTableColumns (Maybe Text)
-- | The ID of the workbook that contains the table whose columns are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
listTableColumns_workbookId :: Lens' ListTableColumns Text
-- | The ID of the table whose columns are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
listTableColumns_tableId :: Lens' ListTableColumns Text
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
listTableColumnsResponse_nextToken :: Lens' ListTableColumnsResponse (Maybe Text)
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
listTableColumnsResponse_workbookCursor :: Lens' ListTableColumnsResponse (Maybe Integer)
-- | The response's http status code.
listTableColumnsResponse_httpStatus :: Lens' ListTableColumnsResponse Int
-- | The list of columns in the table.
listTableColumnsResponse_tableColumns :: Lens' ListTableColumnsResponse [TableColumn]
-- | The maximum number of rows to return in each page of the results.
listTableRows_maxResults :: Lens' ListTableRows (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
listTableRows_nextToken :: Lens' ListTableRows (Maybe Text)
-- | This parameter is optional. If one or more row ids are specified in
-- this list, then only the specified row ids are returned in the result.
-- If no row ids are specified here, then all the rows in the table are
-- returned.
listTableRows_rowIds :: Lens' ListTableRows (Maybe (NonEmpty Text))
-- | The ID of the workbook that contains the table whose rows are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
listTableRows_workbookId :: Lens' ListTableRows Text
-- | The ID of the table whose rows are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
listTableRows_tableId :: Lens' ListTableRows Text
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
listTableRowsResponse_nextToken :: Lens' ListTableRowsResponse (Maybe Text)
-- | The list of row ids included in the request that were not found in the
-- table.
listTableRowsResponse_rowIdsNotFound :: Lens' ListTableRowsResponse (Maybe (NonEmpty Text))
-- | The response's http status code.
listTableRowsResponse_httpStatus :: Lens' ListTableRowsResponse Int
-- | The list of columns in the table whose row data is returned in the
-- result.
listTableRowsResponse_columnIds :: Lens' ListTableRowsResponse (NonEmpty Text)
-- | The list of rows in the table. Note that this result is paginated, so
-- this list contains a maximum of 100 rows.
listTableRowsResponse_rows :: Lens' ListTableRowsResponse [TableRow]
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
listTableRowsResponse_workbookCursor :: Lens' ListTableRowsResponse Integer
-- | The maximum number of tables to return in each page of the results.
listTables_maxResults :: Lens' ListTables (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
listTables_nextToken :: Lens' ListTables (Maybe Text)
-- | The ID of the workbook whose tables are being retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
listTables_workbookId :: Lens' ListTables Text
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
listTablesResponse_nextToken :: Lens' ListTablesResponse (Maybe Text)
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
listTablesResponse_workbookCursor :: Lens' ListTablesResponse (Maybe Integer)
-- | The response's http status code.
listTablesResponse_httpStatus :: Lens' ListTablesResponse Int
-- | The list of tables in the workbook.
listTablesResponse_tables :: Lens' ListTablesResponse [Table]
-- | The resource's Amazon Resource Name (ARN).
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
-- | The resource's tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
-- | The response's http status code.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
-- | The maximum number of rows to return in each page of the results.
queryTableRows_maxResults :: Lens' QueryTableRows (Maybe Natural)
-- | This parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
queryTableRows_nextToken :: Lens' QueryTableRows (Maybe Text)
-- | The ID of the workbook whose table rows are being queried.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
queryTableRows_workbookId :: Lens' QueryTableRows Text
-- | The ID of the table whose rows are being queried.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
queryTableRows_tableId :: Lens' QueryTableRows Text
-- | An object that represents a filter formula along with the id of the
-- context row under which the filter function needs to evaluate.
queryTableRows_filterFormula :: Lens' QueryTableRows Filter
-- | Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
queryTableRowsResponse_nextToken :: Lens' QueryTableRowsResponse (Maybe Text)
-- | The response's http status code.
queryTableRowsResponse_httpStatus :: Lens' QueryTableRowsResponse Int
-- | The list of columns in the table whose row data is returned in the
-- result.
queryTableRowsResponse_columnIds :: Lens' QueryTableRowsResponse (NonEmpty Text)
-- | The list of rows in the table that match the query filter.
queryTableRowsResponse_rows :: Lens' QueryTableRowsResponse [TableRow]
-- | Indicates the cursor of the workbook at which the data returned by
-- this request is read. Workbook cursor keeps increasing with every
-- update and the increments are not sequential.
queryTableRowsResponse_workbookCursor :: Lens' QueryTableRowsResponse Integer
-- | The ID of the workbook where the rows are being imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
startTableDataImportJob_workbookId :: Lens' StartTableDataImportJob Text
-- | The source of the data that is being imported. The size of source must
-- be no larger than 100 MB. Source must have no more than 100,000 cells
-- and no more than 1,000 rows.
startTableDataImportJob_dataSource :: Lens' StartTableDataImportJob ImportDataSource
-- | The format of the data that is being imported. Currently the only
-- option supported is "DELIMITED_TEXT".
startTableDataImportJob_dataFormat :: Lens' StartTableDataImportJob ImportSourceDataFormat
-- | The ID of the table where the rows are being imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
startTableDataImportJob_destinationTableId :: Lens' StartTableDataImportJob Text
-- | The options for customizing this import request.
startTableDataImportJob_importOptions :: Lens' StartTableDataImportJob ImportOptions
-- | The request token for performing the update action. Request tokens
-- help to identify duplicate requests. If a call times out or fails due
-- to a transient error like a failed network connection, you can retry
-- the call with the same request token. The service ensures that if the
-- first call using that request token is successfully performed, the
-- second call will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
startTableDataImportJob_clientRequestToken :: Lens' StartTableDataImportJob Text
-- | The response's http status code.
startTableDataImportJobResponse_httpStatus :: Lens' StartTableDataImportJobResponse Int
-- | The id that is assigned to this import job. Future requests to find
-- out the status of this import job need to send this id in the
-- appropriate parameter in the request.
startTableDataImportJobResponse_jobId :: Lens' StartTableDataImportJobResponse Text
-- | The status of the import job immediately after submitting the request.
startTableDataImportJobResponse_jobStatus :: Lens' StartTableDataImportJobResponse TableDataImportJobStatus
-- | The resource's Amazon Resource Name (ARN).
tagResource_resourceArn :: Lens' TagResource Text
-- | A list of tags to apply to the resource.
tagResource_tags :: Lens' TagResource (HashMap Text Text)
-- | The response's http status code.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
-- | The resource's Amazon Resource Name (ARN).
untagResource_resourceArn :: Lens' UntagResource Text
-- | A list of tag keys to remove from the resource.
untagResource_tagKeys :: Lens' UntagResource [Text]
-- | The response's http status code.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
-- | The format of the cell. If this field is empty, then the format is
-- either not specified in the workbook or the format is set to AUTO.
cell_format :: Lens' Cell (Maybe Format)
-- | The formatted value of the cell. This is the value that you see
-- displayed in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
cell_formattedValue :: Lens' Cell (Maybe Text)
-- | A list of formatted values of the cell. This field is only returned
-- when the cell is ROWSET format (aka multi-select or multi-record
-- picklist). Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
cell_formattedValues :: Lens' Cell (Maybe [Text])
-- | The formula contained in the cell. This field is empty if a cell does
-- not have a formula.
cell_formula :: Lens' Cell (Maybe Text)
-- | The raw value of the data contained in the cell. The raw value depends
-- on the format of the data in the cell. However the attribute in the
-- API return value is always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
cell_rawValue :: Lens' Cell (Maybe Text)
-- | Fact represents the data that is entered into a cell. This data can be
-- free text or a formula. Formulas need to start with the equals (=)
-- sign.
cellInput_fact :: Lens' CellInput (Maybe Text)
-- | A list representing the values that are entered into a ROWSET cell.
-- Facts list can have either only values or rowIDs, and rowIDs should
-- from the same table.
cellInput_facts :: Lens' CellInput (Maybe [Text])
-- | The name of the column.
columnMetadata_name :: Lens' ColumnMetadata Text
-- | The format of the column.
columnMetadata_format :: Lens' ColumnMetadata Format
-- | An external identifier that represents the single row that is being
-- created as part of the BatchCreateTableRows request. This can be any
-- string that you can use to identify the row in the request. The
-- BatchCreateTableRows API puts the batch item id in the results to
-- allow you to link data in the request to data in the results.
createRowData_batchItemId :: Lens' CreateRowData Text
-- | A map representing the cells to create in the new row. The key is the
-- column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
createRowData_cellsToCreate :: Lens' CreateRowData (HashMap Text CellInput)
-- | The formatted value of the data. e.g. John Smith.
dataItem_formattedValue :: Lens' DataItem (Maybe Text)
-- | The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
dataItem_overrideFormat :: Lens' DataItem (Maybe Format)
-- | The raw value of the data. e.g. jsmith@example.com
dataItem_rawValue :: Lens' DataItem (Maybe Text)
-- | The encoding of the data in the input file.
delimitedTextImportOptions_dataCharacterEncoding :: Lens' DelimitedTextImportOptions (Maybe ImportDataCharacterEncoding)
-- | Indicates whether the input file has a header row at the top
-- containing the column names.
delimitedTextImportOptions_hasHeaderRow :: Lens' DelimitedTextImportOptions (Maybe Bool)
-- | A parameter to indicate whether empty rows should be ignored or be
-- included in the import.
delimitedTextImportOptions_ignoreEmptyRows :: Lens' DelimitedTextImportOptions (Maybe Bool)
-- | The delimiter to use for separating columns in a single row of the
-- input.
delimitedTextImportOptions_delimiter :: Lens' DelimitedTextImportOptions Text
-- | A map of the column id to the import properties for each column.
destinationOptions_columnMap :: Lens' DestinationOptions (Maybe (HashMap Text SourceDataColumnProperties))
-- | The id of the batch item that failed. This is the batch item id for
-- the BatchCreateTableRows and BatchUpsertTableRows operations and the
-- row id for the BatchUpdateTableRows and BatchDeleteTableRows
-- operations.
failedBatchItem_id :: Lens' FailedBatchItem Text
-- | The error message that indicates why the batch item failed.
failedBatchItem_errorMessage :: Lens' FailedBatchItem Text
-- | The optional contextRowId attribute can be used to specify the row id
-- of the context row if the filter formula contains unqualified
-- references to table columns and needs a context row to evaluate them
-- successfully.
filter_contextRowId :: Lens' Filter (Maybe Text)
-- | A formula representing a filter function that returns zero or more
-- matching rows from a table. Valid formulas in this field return a list
-- of rows from a table. The most common ways of writing a formula to
-- return a list of rows are to use the FindRow() or Filter() functions.
-- Any other formula that returns zero or more rows is also acceptable.
-- For example, you can use a formula that points to a cell that contains
-- a filter function.
filter_formula :: Lens' Filter Text
-- | The configuration parameters for the data source of the import
importDataSource_dataSourceConfig :: Lens' ImportDataSource ImportDataSourceConfig
-- | The URL from which source data will be downloaded for the import
-- request.
importDataSourceConfig_dataSourceUrl :: Lens' ImportDataSourceConfig (Maybe Text)
-- | The email id of the submitter of the import job, if available.
importJobSubmitter_email :: Lens' ImportJobSubmitter (Maybe Text)
-- | The AWS user ARN of the submitter of the import job, if available.
importJobSubmitter_userArn :: Lens' ImportJobSubmitter (Maybe Text)
-- | Options relating to parsing delimited text. Required if dataFormat is
-- DELIMITED_TEXT.
importOptions_delimitedTextOptions :: Lens' ImportOptions (Maybe DelimitedTextImportOptions)
-- | Options relating to the destination of the import request.
importOptions_destinationOptions :: Lens' ImportOptions (Maybe DestinationOptions)
-- | The ID for a particular row.
resultRow_rowId :: Lens' ResultRow (Maybe Text)
-- | List of all the data cells in a row.
resultRow_dataItems :: Lens' ResultRow [DataItem]
-- | List of headers for all the data cells in the block. The header
-- identifies the name and default format of the data cell. Data cells
-- appear in the same order in all rows as defined in the header. The
-- names and formats are not repeated in the rows. If a particular row
-- does not have a value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
resultSet_headers :: Lens' ResultSet [ColumnMetadata]
-- | List of rows returned by the request. Each row has a row Id and a list
-- of data cells in that row. The data cells will be present in the same
-- order as they are defined in the header.
resultSet_rows :: Lens' ResultSet [ResultRow]
-- | The index of the column in the input file.
sourceDataColumnProperties_columnIndex :: Lens' SourceDataColumnProperties (Maybe Natural)
-- | The id of the table.
table_tableId :: Lens' Table (Maybe Text)
-- | The name of the table.
table_tableName :: Lens' Table (Maybe Text)
-- | The column level format that is applied in the table. An empty value
-- in this field means that the column format is the default value
-- 'AUTO'.
tableColumn_format :: Lens' TableColumn (Maybe Format)
-- | The id of the column in the table.
tableColumn_tableColumnId :: Lens' TableColumn (Maybe Text)
-- | The name of the column in the table.
tableColumn_tableColumnName :: Lens' TableColumn (Maybe Text)
-- | Details about the submitter of the import request.
tableDataImportJobMetadata_submitter :: Lens' TableDataImportJobMetadata ImportJobSubmitter
-- | The timestamp when the job was submitted for import.
tableDataImportJobMetadata_submitTime :: Lens' TableDataImportJobMetadata UTCTime
-- | The options that was specified at the time of submitting the import
-- request.
tableDataImportJobMetadata_importOptions :: Lens' TableDataImportJobMetadata ImportOptions
-- | The source of the data that was submitted for import.
tableDataImportJobMetadata_dataSource :: Lens' TableDataImportJobMetadata ImportDataSource
-- | The id of the row in the table.
tableRow_rowId :: Lens' TableRow Text
-- | A list of cells in the table row. The cells appear in the same order
-- as the columns of the table.
tableRow_cells :: Lens' TableRow [Cell]
-- | The id of the row that needs to be updated.
updateRowData_rowId :: Lens' UpdateRowData Text
-- | A map representing the cells to update in the given row. The key is
-- the column id of the cell and the value is the CellInput object that
-- represents the data to set in that cell.
updateRowData_cellsToUpdate :: Lens' UpdateRowData (HashMap Text CellInput)
-- | An external identifier that represents a single item in the request
-- that is being upserted as part of the BatchUpsertTableRows request.
-- This can be any string that you can use to identify the item in the
-- request. The BatchUpsertTableRows API puts the batch item id in the
-- results to allow you to link data in the request to data in the
-- results.
upsertRowData_batchItemId :: Lens' UpsertRowData Text
-- | The filter formula to use to find existing matching rows to update.
-- The formula needs to return zero or more rows. If the formula returns
-- 0 rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
upsertRowData_filter :: Lens' UpsertRowData Filter
-- | A map representing the cells to update for the matching rows or an
-- appended row. The key is the column id of the cell and the value is
-- the CellInput object that represents the data to set in that cell.
upsertRowData_cellsToUpdate :: Lens' UpsertRowData (HashMap Text CellInput)
-- | The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
upsertRowsResult_rowIds :: Lens' UpsertRowsResult (NonEmpty Text)
-- | The result of the upsert action.
upsertRowsResult_upsertAction :: Lens' UpsertRowsResult UpsertAction
-- | Raw value of the variable.
variableValue_rawValue :: Lens' VariableValue Text
module Amazonka.HoneyCode.Waiters
-- | Derived from API version 2020-03-01 of the AWS service
-- descriptions, licensed under Apache 2.0.
--
-- Amazon Honeycode is a fully managed service that allows you to quickly
-- build mobile and web apps for teams—without programming. Build
-- Honeycode apps for managing almost anything, like projects, customers,
-- operations, approvals, resources, and even your team.
module Amazonka.HoneyCode
-- | API version 2020-03-01 of the Amazon Honeycode SDK
-- configuration.
defaultService :: Service
-- | You do not have sufficient access to perform this action. Check that
-- the workbook is owned by you and your IAM policy allows access to the
-- resource in the request.
_AccessDeniedException :: AsError a => Fold a ServiceError
-- | The automation execution did not end successfully.
_AutomationExecutionException :: AsError a => Fold a ServiceError
-- | The automation execution timed out.
_AutomationExecutionTimeoutException :: AsError a => Fold a ServiceError
-- | There were unexpected errors from the server.
_InternalServerException :: AsError a => Fold a ServiceError
-- | The request timed out.
_RequestTimeoutException :: AsError a => Fold a ServiceError
-- | A Workbook, Table, App, Screen or Screen Automation was not found with
-- the given ID.
_ResourceNotFoundException :: AsError a => Fold a ServiceError
-- | The request caused service quota to be breached.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError
-- | Remote service is unreachable.
_ServiceUnavailableException :: AsError a => Fold a ServiceError
-- | Tps(transactions per second) rate reached.
_ThrottlingException :: AsError a => Fold a ServiceError
-- | Request is invalid. The message in the response contains details on
-- why the request is invalid.
_ValidationException :: AsError a => Fold a ServiceError
-- | See: newBatchCreateTableRows smart constructor.
data BatchCreateTableRows
BatchCreateTableRows' :: Maybe Text -> Text -> Text -> NonEmpty CreateRowData -> BatchCreateTableRows
-- | Create a value of BatchCreateTableRows 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:clientRequestToken:BatchCreateTableRows',
-- batchCreateTableRows_clientRequestToken - The request token for
-- performing the batch create operation. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the operation again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchCreateTableRows',
-- batchCreateTableRows_workbookId - The ID of the workbook where
-- the new rows are being added.
--
-- If a workbook with the specified ID could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchCreateTableRows, batchCreateTableRows_tableId - The
-- ID of the table where the new rows are being added.
--
-- If a table with the specified ID could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:rowsToCreate:BatchCreateTableRows',
-- batchCreateTableRows_rowsToCreate - The list of rows to create
-- at the end of the table. Each item in this list needs to have a batch
-- item id to uniquely identify the element in the request and the cells
-- to create for that row. You need to specify at least one item in this
-- list.
--
-- Note that if one of the column ids in any of the rows in the request
-- does not exist in the table, then the request fails and no updates are
-- made to the table.
newBatchCreateTableRows :: Text -> Text -> NonEmpty CreateRowData -> BatchCreateTableRows
-- | See: newBatchCreateTableRowsResponse smart constructor.
data BatchCreateTableRowsResponse
BatchCreateTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> Integer -> HashMap Text Text -> BatchCreateTableRowsResponse
-- | Create a value of BatchCreateTableRowsResponse 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:failedBatchItems:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_failedBatchItems - The list of
-- batch items in the request that could not be added to the table. Each
-- element in this list contains one item from the request that could not
-- be added to the table along with the reason why that item could not be
-- added.
--
-- $sel:httpStatus:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_workbookCursor - The updated
-- workbook cursor after adding the new rows at the end of the table.
--
-- $sel:createdRows:BatchCreateTableRowsResponse',
-- batchCreateTableRowsResponse_createdRows - The map of batch
-- item id to the row id that was created for that item.
newBatchCreateTableRowsResponse :: Int -> Integer -> BatchCreateTableRowsResponse
-- | See: newBatchDeleteTableRows smart constructor.
data BatchDeleteTableRows
BatchDeleteTableRows' :: Maybe Text -> Text -> Text -> NonEmpty Text -> BatchDeleteTableRows
-- | Create a value of BatchDeleteTableRows 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:clientRequestToken:BatchDeleteTableRows',
-- batchDeleteTableRows_clientRequestToken - The request token for
-- performing the delete action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchDeleteTableRows',
-- batchDeleteTableRows_workbookId - The ID of the workbook where
-- the rows are being deleted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchDeleteTableRows, batchDeleteTableRows_tableId - The
-- ID of the table where the rows are being deleted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- BatchDeleteTableRows, batchDeleteTableRows_rowIds - The
-- list of row ids to delete from the table. You need to specify at least
-- one row id in this list.
--
-- Note that if one of the row ids provided in the request does not exist
-- in the table, then the request fails and no rows are deleted from the
-- table.
newBatchDeleteTableRows :: Text -> Text -> NonEmpty Text -> BatchDeleteTableRows
-- | See: newBatchDeleteTableRowsResponse smart constructor.
data BatchDeleteTableRowsResponse
BatchDeleteTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> Integer -> BatchDeleteTableRowsResponse
-- | Create a value of BatchDeleteTableRowsResponse 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:failedBatchItems:BatchDeleteTableRowsResponse',
-- batchDeleteTableRowsResponse_failedBatchItems - The list of row
-- ids in the request that could not be deleted from the table. Each
-- element in this list contains one row id from the request that could
-- not be deleted along with the reason why that item could not be
-- deleted.
--
-- $sel:httpStatus:BatchDeleteTableRowsResponse',
-- batchDeleteTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:BatchDeleteTableRowsResponse',
-- batchDeleteTableRowsResponse_workbookCursor - The updated
-- workbook cursor after deleting the rows from the table.
newBatchDeleteTableRowsResponse :: Int -> Integer -> BatchDeleteTableRowsResponse
-- | See: newBatchUpdateTableRows smart constructor.
data BatchUpdateTableRows
BatchUpdateTableRows' :: Maybe Text -> Text -> Text -> NonEmpty UpdateRowData -> BatchUpdateTableRows
-- | Create a value of BatchUpdateTableRows 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:clientRequestToken:BatchUpdateTableRows',
-- batchUpdateTableRows_clientRequestToken - The request token for
-- performing the update action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchUpdateTableRows',
-- batchUpdateTableRows_workbookId - The ID of the workbook where
-- the rows are being updated.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchUpdateTableRows, batchUpdateTableRows_tableId - The
-- ID of the table where the rows are being updated.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:rowsToUpdate:BatchUpdateTableRows',
-- batchUpdateTableRows_rowsToUpdate - The list of rows to update
-- in the table. Each item in this list needs to contain the row id to
-- update along with the map of column id to cell values for each column
-- in that row that needs to be updated. You need to specify at least one
-- row in this list, and for each row, you need to specify at least one
-- column to update.
--
-- Note that if one of the row or column ids in the request does not
-- exist in the table, then the request fails and no updates are made to
-- the table.
newBatchUpdateTableRows :: Text -> Text -> NonEmpty UpdateRowData -> BatchUpdateTableRows
-- | See: newBatchUpdateTableRowsResponse smart constructor.
data BatchUpdateTableRowsResponse
BatchUpdateTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> Integer -> BatchUpdateTableRowsResponse
-- | Create a value of BatchUpdateTableRowsResponse 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:failedBatchItems:BatchUpdateTableRowsResponse',
-- batchUpdateTableRowsResponse_failedBatchItems - The list of
-- batch items in the request that could not be updated in the table.
-- Each element in this list contains one item from the request that
-- could not be updated in the table along with the reason why that item
-- could not be updated.
--
-- $sel:httpStatus:BatchUpdateTableRowsResponse',
-- batchUpdateTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:BatchUpdateTableRowsResponse',
-- batchUpdateTableRowsResponse_workbookCursor - The updated
-- workbook cursor after adding the new rows at the end of the table.
newBatchUpdateTableRowsResponse :: Int -> Integer -> BatchUpdateTableRowsResponse
-- | See: newBatchUpsertTableRows smart constructor.
data BatchUpsertTableRows
BatchUpsertTableRows' :: Maybe Text -> Text -> Text -> [UpsertRowData] -> BatchUpsertTableRows
-- | Create a value of BatchUpsertTableRows 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:clientRequestToken:BatchUpsertTableRows',
-- batchUpsertTableRows_clientRequestToken - The request token for
-- performing the update action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- $sel:workbookId:BatchUpsertTableRows',
-- batchUpsertTableRows_workbookId - The ID of the workbook where
-- the rows are being upserted.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- BatchUpsertTableRows, batchUpsertTableRows_tableId - The
-- ID of the table where the rows are being upserted.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:rowsToUpsert:BatchUpsertTableRows',
-- batchUpsertTableRows_rowsToUpsert - The list of rows to upsert
-- in the table. Each item in this list needs to have a batch item id to
-- uniquely identify the element in the request, a filter expression to
-- find the rows to update for that element and the cell values to set
-- for each column in the upserted rows. You need to specify at least one
-- item in this list.
--
-- Note that if one of the filter formulas in the request fails to
-- evaluate because of an error or one of the column ids in any of the
-- rows does not exist in the table, then the request fails and no
-- updates are made to the table.
newBatchUpsertTableRows :: Text -> Text -> BatchUpsertTableRows
-- | See: newBatchUpsertTableRowsResponse smart constructor.
data BatchUpsertTableRowsResponse
BatchUpsertTableRowsResponse' :: Maybe [FailedBatchItem] -> Int -> HashMap Text UpsertRowsResult -> Integer -> BatchUpsertTableRowsResponse
-- | Create a value of BatchUpsertTableRowsResponse 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:failedBatchItems:BatchUpsertTableRowsResponse',
-- batchUpsertTableRowsResponse_failedBatchItems - The list of
-- batch items in the request that could not be updated or appended in
-- the table. Each element in this list contains one item from the
-- request that could not be updated in the table along with the reason
-- why that item could not be updated or appended.
--
-- $sel:httpStatus:BatchUpsertTableRowsResponse',
-- batchUpsertTableRowsResponse_httpStatus - The response's http
-- status code.
--
-- BatchUpsertTableRowsResponse,
-- batchUpsertTableRowsResponse_rows - A map with the batch item
-- id as the key and the result of the upsert operation as the value. The
-- result of the upsert operation specifies whether existing rows were
-- updated or a new row was appended, along with the list of row ids that
-- were affected.
--
-- $sel:workbookCursor:BatchUpsertTableRowsResponse',
-- batchUpsertTableRowsResponse_workbookCursor - The updated
-- workbook cursor after updating or appending rows in the table.
newBatchUpsertTableRowsResponse :: Int -> Integer -> BatchUpsertTableRowsResponse
-- | See: newDescribeTableDataImportJob smart constructor.
data DescribeTableDataImportJob
DescribeTableDataImportJob' :: Text -> Text -> Text -> DescribeTableDataImportJob
-- | Create a value of DescribeTableDataImportJob 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:workbookId:DescribeTableDataImportJob',
-- describeTableDataImportJob_workbookId - The ID of the workbook
-- into which data was imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- DescribeTableDataImportJob,
-- describeTableDataImportJob_tableId - The ID of the table into
-- which data was imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:jobId:DescribeTableDataImportJob',
-- describeTableDataImportJob_jobId - The ID of the job that was
-- returned by the StartTableDataImportJob request.
--
-- If a job with the specified id could not be found, this API throws
-- ResourceNotFoundException.
newDescribeTableDataImportJob :: Text -> Text -> Text -> DescribeTableDataImportJob
-- | See: newDescribeTableDataImportJobResponse smart
-- constructor.
data DescribeTableDataImportJobResponse
DescribeTableDataImportJobResponse' :: Maybe ErrorCode -> Int -> TableDataImportJobStatus -> Text -> TableDataImportJobMetadata -> DescribeTableDataImportJobResponse
-- | Create a value of DescribeTableDataImportJobResponse 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:errorCode:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_errorCode - If job status is
-- failed, error code to understand reason for the failure.
--
-- $sel:httpStatus:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_httpStatus - The response's
-- http status code.
--
-- $sel:jobStatus:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_jobStatus - The current
-- status of the import job.
--
-- $sel:message:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_message - A message
-- providing more details about the current status of the import job.
--
-- $sel:jobMetadata:DescribeTableDataImportJobResponse',
-- describeTableDataImportJobResponse_jobMetadata - The metadata
-- about the job that was submitted for import.
newDescribeTableDataImportJobResponse :: Int -> TableDataImportJobStatus -> Text -> TableDataImportJobMetadata -> DescribeTableDataImportJobResponse
-- | See: newGetScreenData smart constructor.
data GetScreenData
GetScreenData' :: Maybe Natural -> Maybe Text -> Maybe (Sensitive (HashMap Text (Sensitive VariableValue))) -> Text -> Text -> Text -> GetScreenData
-- | Create a value of GetScreenData 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:GetScreenData', getScreenData_maxResults
-- - The number of results to be returned on a single page. Specify a
-- number between 1 and 100. The maximum value is 100.
--
-- This parameter is optional. If you don't specify this parameter, the
-- default page size is 100.
--
-- GetScreenData, getScreenData_nextToken - This parameter
-- is optional. If a nextToken is not specified, the API returns the
-- first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:variables:GetScreenData', getScreenData_variables -
-- Variables are optional and are needed only if the screen requires them
-- to render correctly. Variables are specified as a map where the key is
-- the name of the variable as defined on the screen. The value is an
-- object which currently has only one property, rawValue, which holds
-- the value of the variable to be passed to the screen.
--
-- $sel:workbookId:GetScreenData', getScreenData_workbookId
-- - The ID of the workbook that contains the screen.
--
-- $sel:appId:GetScreenData', getScreenData_appId - The ID
-- of the app that contains the screen.
--
-- $sel:screenId:GetScreenData', getScreenData_screenId -
-- The ID of the screen.
newGetScreenData :: Text -> Text -> Text -> GetScreenData
-- | See: newGetScreenDataResponse smart constructor.
data GetScreenDataResponse
GetScreenDataResponse' :: Maybe Text -> Int -> HashMap Text ResultSet -> Integer -> GetScreenDataResponse
-- | Create a value of GetScreenDataResponse 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:
--
-- GetScreenData, getScreenDataResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the query has been
-- loaded.
--
-- $sel:httpStatus:GetScreenDataResponse',
-- getScreenDataResponse_httpStatus - The response's http status
-- code.
--
-- $sel:results:GetScreenDataResponse',
-- getScreenDataResponse_results - A map of all the rows on the
-- screen keyed by block name.
--
-- $sel:workbookCursor:GetScreenDataResponse',
-- getScreenDataResponse_workbookCursor - Indicates the cursor of
-- the workbook at which the data returned by this workbook is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
newGetScreenDataResponse :: Int -> Integer -> GetScreenDataResponse
-- | See: newInvokeScreenAutomation smart constructor.
data InvokeScreenAutomation
InvokeScreenAutomation' :: Maybe Text -> Maybe Text -> Maybe (Sensitive (HashMap Text (Sensitive VariableValue))) -> Text -> Text -> Text -> Text -> InvokeScreenAutomation
-- | Create a value of InvokeScreenAutomation 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:clientRequestToken:InvokeScreenAutomation',
-- invokeScreenAutomation_clientRequestToken - The request token
-- for performing the automation action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will return the response of the previous call rather than performing
-- the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
--
-- InvokeScreenAutomation, invokeScreenAutomation_rowId -
-- The row ID for the automation if the automation is defined inside a
-- block with source or list.
--
-- $sel:variables:InvokeScreenAutomation',
-- invokeScreenAutomation_variables - Variables are specified as a
-- map where the key is the name of the variable as defined on the
-- screen. The value is an object which currently has only one property,
-- rawValue, which holds the value of the variable to be passed to the
-- screen. Any variables defined in a screen are required to be passed in
-- the call.
--
-- $sel:workbookId:InvokeScreenAutomation',
-- invokeScreenAutomation_workbookId - The ID of the workbook that
-- contains the screen automation.
--
-- $sel:appId:InvokeScreenAutomation',
-- invokeScreenAutomation_appId - The ID of the app that contains
-- the screen automation.
--
-- $sel:screenId:InvokeScreenAutomation',
-- invokeScreenAutomation_screenId - The ID of the screen that
-- contains the screen automation.
--
-- $sel:screenAutomationId:InvokeScreenAutomation',
-- invokeScreenAutomation_screenAutomationId - The ID of the
-- automation action to be performed.
newInvokeScreenAutomation :: Text -> Text -> Text -> Text -> InvokeScreenAutomation
-- | See: newInvokeScreenAutomationResponse smart
-- constructor.
data InvokeScreenAutomationResponse
InvokeScreenAutomationResponse' :: Int -> Integer -> InvokeScreenAutomationResponse
-- | Create a value of InvokeScreenAutomationResponse 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:httpStatus:InvokeScreenAutomationResponse',
-- invokeScreenAutomationResponse_httpStatus - The response's http
-- status code.
--
-- $sel:workbookCursor:InvokeScreenAutomationResponse',
-- invokeScreenAutomationResponse_workbookCursor - The updated
-- workbook cursor after performing the automation action.
newInvokeScreenAutomationResponse :: Int -> Integer -> InvokeScreenAutomationResponse
-- | See: newListTableColumns smart constructor.
data ListTableColumns
ListTableColumns' :: Maybe Text -> Text -> Text -> ListTableColumns
-- | Create a value of ListTableColumns 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:
--
-- ListTableColumns, listTableColumns_nextToken - This
-- parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:workbookId:ListTableColumns',
-- listTableColumns_workbookId - The ID of the workbook that
-- contains the table whose columns are being retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- ListTableColumns, listTableColumns_tableId - The ID of
-- the table whose columns are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
newListTableColumns :: Text -> Text -> ListTableColumns
-- | See: newListTableColumnsResponse smart constructor.
data ListTableColumnsResponse
ListTableColumnsResponse' :: Maybe Text -> Maybe Integer -> Int -> [TableColumn] -> ListTableColumnsResponse
-- | Create a value of ListTableColumnsResponse 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:
--
-- ListTableColumns, listTableColumnsResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
--
-- $sel:workbookCursor:ListTableColumnsResponse',
-- listTableColumnsResponse_workbookCursor - Indicates the cursor
-- of the workbook at which the data returned by this request is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
--
-- $sel:httpStatus:ListTableColumnsResponse',
-- listTableColumnsResponse_httpStatus - The response's http
-- status code.
--
-- $sel:tableColumns:ListTableColumnsResponse',
-- listTableColumnsResponse_tableColumns - The list of columns in
-- the table.
newListTableColumnsResponse :: Int -> ListTableColumnsResponse
-- | See: newListTableRows smart constructor.
data ListTableRows
ListTableRows' :: Maybe Natural -> Maybe Text -> Maybe (NonEmpty Text) -> Text -> Text -> ListTableRows
-- | Create a value of ListTableRows 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:ListTableRows', listTableRows_maxResults
-- - The maximum number of rows to return in each page of the results.
--
-- ListTableRows, listTableRows_nextToken - This parameter
-- is optional. If a nextToken is not specified, the API returns the
-- first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- ListTableRows, listTableRows_rowIds - This parameter is
-- optional. If one or more row ids are specified in this list, then only
-- the specified row ids are returned in the result. If no row ids are
-- specified here, then all the rows in the table are returned.
--
-- $sel:workbookId:ListTableRows', listTableRows_workbookId
-- - The ID of the workbook that contains the table whose rows are being
-- retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- ListTableRows, listTableRows_tableId - The ID of the
-- table whose rows are being retrieved.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
newListTableRows :: Text -> Text -> ListTableRows
-- | See: newListTableRowsResponse smart constructor.
data ListTableRowsResponse
ListTableRowsResponse' :: Maybe Text -> Maybe (NonEmpty Text) -> Int -> NonEmpty Text -> [TableRow] -> Integer -> ListTableRowsResponse
-- | Create a value of ListTableRowsResponse 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:
--
-- ListTableRows, listTableRowsResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
--
-- $sel:rowIdsNotFound:ListTableRowsResponse',
-- listTableRowsResponse_rowIdsNotFound - The list of row ids
-- included in the request that were not found in the table.
--
-- $sel:httpStatus:ListTableRowsResponse',
-- listTableRowsResponse_httpStatus - The response's http status
-- code.
--
-- $sel:columnIds:ListTableRowsResponse',
-- listTableRowsResponse_columnIds - The list of columns in the
-- table whose row data is returned in the result.
--
-- ListTableRowsResponse, listTableRowsResponse_rows - The
-- list of rows in the table. Note that this result is paginated, so this
-- list contains a maximum of 100 rows.
--
-- $sel:workbookCursor:ListTableRowsResponse',
-- listTableRowsResponse_workbookCursor - Indicates the cursor of
-- the workbook at which the data returned by this request is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
newListTableRowsResponse :: Int -> NonEmpty Text -> Integer -> ListTableRowsResponse
-- | See: newListTables smart constructor.
data ListTables
ListTables' :: Maybe Natural -> 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:maxResults:ListTables', listTables_maxResults - The
-- maximum number of tables to return in each page of the results.
--
-- ListTables, listTables_nextToken - This parameter is
-- optional. If a nextToken is not specified, the API returns the first
-- page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:workbookId:ListTables', listTables_workbookId - The
-- ID of the workbook whose tables are being retrieved.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
newListTables :: Text -> ListTables
-- | See: newListTablesResponse smart constructor.
data ListTablesResponse
ListTablesResponse' :: Maybe Text -> Maybe Integer -> Int -> [Table] -> 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 - Provides the
-- pagination token to load the next page if there are more results
-- matching the request. If a pagination token is not present in the
-- response, it means that all data matching the request has been loaded.
--
-- $sel:workbookCursor:ListTablesResponse',
-- listTablesResponse_workbookCursor - Indicates the cursor of the
-- workbook at which the data returned by this request is read. Workbook
-- cursor keeps increasing with every update and the increments are not
-- sequential.
--
-- $sel:httpStatus:ListTablesResponse',
-- listTablesResponse_httpStatus - The response's http status
-- code.
--
-- $sel:tables:ListTablesResponse',
-- listTablesResponse_tables - The list of tables in the workbook.
newListTablesResponse :: Int -> ListTablesResponse
-- | See: newListTagsForResource smart constructor.
data ListTagsForResource
ListTagsForResource' :: Text -> ListTagsForResource
-- | Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource',
-- listTagsForResource_resourceArn - The resource's Amazon
-- Resource Name (ARN).
newListTagsForResource :: Text -> ListTagsForResource
-- | See: newListTagsForResourceResponse smart constructor.
data ListTagsForResourceResponse
ListTagsForResourceResponse' :: Maybe (HashMap Text Text) -> Int -> ListTagsForResourceResponse
-- | Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse',
-- listTagsForResourceResponse_tags - The resource's tags.
--
-- $sel:httpStatus:ListTagsForResourceResponse',
-- listTagsForResourceResponse_httpStatus - The response's http
-- status code.
newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
-- | See: newQueryTableRows smart constructor.
data QueryTableRows
QueryTableRows' :: Maybe Natural -> Maybe Text -> Text -> Text -> Filter -> QueryTableRows
-- | Create a value of QueryTableRows 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:QueryTableRows',
-- queryTableRows_maxResults - The maximum number of rows to
-- return in each page of the results.
--
-- QueryTableRows, queryTableRows_nextToken - This
-- parameter is optional. If a nextToken is not specified, the API
-- returns the first page of data.
--
-- Pagination tokens expire after 1 hour. If you use a token that was
-- returned more than an hour back, the API will throw
-- ValidationException.
--
-- $sel:workbookId:QueryTableRows',
-- queryTableRows_workbookId - The ID of the workbook whose table
-- rows are being queried.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- QueryTableRows, queryTableRows_tableId - The ID of the
-- table whose rows are being queried.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- $sel:filterFormula:QueryTableRows',
-- queryTableRows_filterFormula - An object that represents a
-- filter formula along with the id of the context row under which the
-- filter function needs to evaluate.
newQueryTableRows :: Text -> Text -> Filter -> QueryTableRows
-- | See: newQueryTableRowsResponse smart constructor.
data QueryTableRowsResponse
QueryTableRowsResponse' :: Maybe Text -> Int -> NonEmpty Text -> [TableRow] -> Integer -> QueryTableRowsResponse
-- | Create a value of QueryTableRowsResponse 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:
--
-- QueryTableRows, queryTableRowsResponse_nextToken -
-- Provides the pagination token to load the next page if there are more
-- results matching the request. If a pagination token is not present in
-- the response, it means that all data matching the request has been
-- loaded.
--
-- $sel:httpStatus:QueryTableRowsResponse',
-- queryTableRowsResponse_httpStatus - The response's http status
-- code.
--
-- $sel:columnIds:QueryTableRowsResponse',
-- queryTableRowsResponse_columnIds - The list of columns in the
-- table whose row data is returned in the result.
--
-- QueryTableRowsResponse, queryTableRowsResponse_rows -
-- The list of rows in the table that match the query filter.
--
-- $sel:workbookCursor:QueryTableRowsResponse',
-- queryTableRowsResponse_workbookCursor - Indicates the cursor of
-- the workbook at which the data returned by this request is read.
-- Workbook cursor keeps increasing with every update and the increments
-- are not sequential.
newQueryTableRowsResponse :: Int -> NonEmpty Text -> Integer -> QueryTableRowsResponse
-- | See: newStartTableDataImportJob smart constructor.
data StartTableDataImportJob
StartTableDataImportJob' :: Text -> ImportDataSource -> ImportSourceDataFormat -> Text -> ImportOptions -> Text -> StartTableDataImportJob
-- | Create a value of StartTableDataImportJob 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:workbookId:StartTableDataImportJob',
-- startTableDataImportJob_workbookId - The ID of the workbook
-- where the rows are being imported.
--
-- If a workbook with the specified id could not be found, this API
-- throws ResourceNotFoundException.
--
-- StartTableDataImportJob,
-- startTableDataImportJob_dataSource - The source of the data
-- that is being imported. The size of source must be no larger than 100
-- MB. Source must have no more than 100,000 cells and no more than 1,000
-- rows.
--
-- $sel:dataFormat:StartTableDataImportJob',
-- startTableDataImportJob_dataFormat - The format of the data
-- that is being imported. Currently the only option supported is
-- "DELIMITED_TEXT".
--
-- $sel:destinationTableId:StartTableDataImportJob',
-- startTableDataImportJob_destinationTableId - The ID of the
-- table where the rows are being imported.
--
-- If a table with the specified id could not be found, this API throws
-- ResourceNotFoundException.
--
-- StartTableDataImportJob,
-- startTableDataImportJob_importOptions - The options for
-- customizing this import request.
--
-- $sel:clientRequestToken:StartTableDataImportJob',
-- startTableDataImportJob_clientRequestToken - The request token
-- for performing the update action. Request tokens help to identify
-- duplicate requests. If a call times out or fails due to a transient
-- error like a failed network connection, you can retry the call with
-- the same request token. The service ensures that if the first call
-- using that request token is successfully performed, the second call
-- will not perform the action again.
--
-- Note that request tokens are valid only for a few minutes. You cannot
-- use request tokens to dedupe requests spanning hours or days.
newStartTableDataImportJob :: Text -> ImportDataSource -> ImportSourceDataFormat -> Text -> ImportOptions -> Text -> StartTableDataImportJob
-- | See: newStartTableDataImportJobResponse smart
-- constructor.
data StartTableDataImportJobResponse
StartTableDataImportJobResponse' :: Int -> Text -> TableDataImportJobStatus -> StartTableDataImportJobResponse
-- | Create a value of StartTableDataImportJobResponse 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:httpStatus:StartTableDataImportJobResponse',
-- startTableDataImportJobResponse_httpStatus - The response's
-- http status code.
--
-- $sel:jobId:StartTableDataImportJobResponse',
-- startTableDataImportJobResponse_jobId - The id that is assigned
-- to this import job. Future requests to find out the status of this
-- import job need to send this id in the appropriate parameter in the
-- request.
--
-- $sel:jobStatus:StartTableDataImportJobResponse',
-- startTableDataImportJobResponse_jobStatus - The status of the
-- import job immediately after submitting the request.
newStartTableDataImportJobResponse :: Int -> Text -> TableDataImportJobStatus -> StartTableDataImportJobResponse
-- | See: newTagResource smart constructor.
data TagResource
TagResource' :: Text -> HashMap Text Text -> TagResource
-- | Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn -
-- The resource's Amazon Resource Name (ARN).
--
-- $sel:tags:TagResource', tagResource_tags - A list of
-- tags to apply to the resource.
newTagResource :: Text -> TagResource
-- | See: newTagResourceResponse smart constructor.
data TagResourceResponse
TagResourceResponse' :: Int -> TagResourceResponse
-- | Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse',
-- tagResourceResponse_httpStatus - The response's http status
-- code.
newTagResourceResponse :: Int -> TagResourceResponse
-- | See: newUntagResource smart constructor.
data UntagResource
UntagResource' :: Text -> [Text] -> UntagResource
-- | Create a value of UntagResource 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:resourceArn:UntagResource',
-- untagResource_resourceArn - The resource's Amazon Resource Name
-- (ARN).
--
-- $sel:tagKeys:UntagResource', untagResource_tagKeys - A
-- list of tag keys to remove from the resource.
newUntagResource :: Text -> UntagResource
-- | See: newUntagResourceResponse smart constructor.
data UntagResourceResponse
UntagResourceResponse' :: Int -> UntagResourceResponse
-- | Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse',
-- untagResourceResponse_httpStatus - The response's http status
-- code.
newUntagResourceResponse :: Int -> UntagResourceResponse
newtype ErrorCode
ErrorCode' :: Text -> ErrorCode
[fromErrorCode] :: ErrorCode -> Text
pattern ErrorCode_ACCESS_DENIED :: ErrorCode
pattern ErrorCode_FILE_EMPTY_ERROR :: ErrorCode
pattern ErrorCode_FILE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_FILE_PARSING_ERROR :: ErrorCode
pattern ErrorCode_FILE_SIZE_LIMIT_ERROR :: ErrorCode
pattern ErrorCode_INVALID_FILE_TYPE_ERROR :: ErrorCode
pattern ErrorCode_INVALID_IMPORT_OPTIONS_ERROR :: ErrorCode
pattern ErrorCode_INVALID_TABLE_COLUMN_ID_ERROR :: ErrorCode
pattern ErrorCode_INVALID_TABLE_ID_ERROR :: ErrorCode
pattern ErrorCode_INVALID_URL_ERROR :: ErrorCode
pattern ErrorCode_RESOURCE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_SYSTEM_LIMIT_ERROR :: ErrorCode
pattern ErrorCode_TABLE_NOT_FOUND_ERROR :: ErrorCode
pattern ErrorCode_UNKNOWN_ERROR :: ErrorCode
newtype Format
Format' :: Text -> Format
[fromFormat] :: Format -> Text
pattern Format_ACCOUNTING :: Format
pattern Format_AUTO :: Format
pattern Format_CONTACT :: Format
pattern Format_CURRENCY :: Format
pattern Format_DATE :: Format
pattern Format_DATE_TIME :: Format
pattern Format_NUMBER :: Format
pattern Format_PERCENTAGE :: Format
pattern Format_ROWLINK :: Format
pattern Format_ROWSET :: Format
pattern Format_TEXT :: Format
pattern Format_TIME :: Format
newtype ImportDataCharacterEncoding
ImportDataCharacterEncoding' :: Text -> ImportDataCharacterEncoding
[fromImportDataCharacterEncoding] :: ImportDataCharacterEncoding -> Text
pattern ImportDataCharacterEncoding_ISO_8859_1 :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_US_ASCII :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16 :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16BE :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_16LE :: ImportDataCharacterEncoding
pattern ImportDataCharacterEncoding_UTF_8 :: ImportDataCharacterEncoding
newtype ImportSourceDataFormat
ImportSourceDataFormat' :: Text -> ImportSourceDataFormat
[fromImportSourceDataFormat] :: ImportSourceDataFormat -> Text
pattern ImportSourceDataFormat_DELIMITED_TEXT :: ImportSourceDataFormat
newtype TableDataImportJobStatus
TableDataImportJobStatus' :: Text -> TableDataImportJobStatus
[fromTableDataImportJobStatus] :: TableDataImportJobStatus -> Text
pattern TableDataImportJobStatus_COMPLETED :: TableDataImportJobStatus
pattern TableDataImportJobStatus_FAILED :: TableDataImportJobStatus
pattern TableDataImportJobStatus_IN_PROGRESS :: TableDataImportJobStatus
pattern TableDataImportJobStatus_SUBMITTED :: TableDataImportJobStatus
newtype UpsertAction
UpsertAction' :: Text -> UpsertAction
[fromUpsertAction] :: UpsertAction -> Text
pattern UpsertAction_APPENDED :: UpsertAction
pattern UpsertAction_UPDATED :: UpsertAction
-- | An object that represents a single cell in a table.
--
-- See: newCell smart constructor.
data Cell
Cell' :: Maybe Format -> Maybe Text -> Maybe [Text] -> Maybe (Sensitive Text) -> Maybe Text -> Cell
-- | Create a value of Cell 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:format:Cell', cell_format - The format of the cell.
-- If this field is empty, then the format is either not specified in the
-- workbook or the format is set to AUTO.
--
-- $sel:formattedValue:Cell', cell_formattedValue - The
-- formatted value of the cell. This is the value that you see displayed
-- in the cell in the UI.
--
-- Note that the formatted value of a cell is always represented as a
-- string irrespective of the data that is stored in the cell. For
-- example, if a cell contains a date, the formatted value of the cell is
-- the string representation of the formatted date being shown in the
-- cell in the UI. See details in the rawValue field below for how cells
-- of different formats will have different raw and formatted values.
--
-- $sel:formattedValues:Cell', cell_formattedValues - A
-- list of formatted values of the cell. This field is only returned when
-- the cell is ROWSET format (aka multi-select or multi-record picklist).
-- Values in the list are always represented as strings. The
-- formattedValue field will be empty if this field is returned.
--
-- $sel:formula:Cell', cell_formula - The formula contained
-- in the cell. This field is empty if a cell does not have a formula.
--
-- $sel:rawValue:Cell', cell_rawValue - The raw value of
-- the data contained in the cell. The raw value depends on the format of
-- the data in the cell. However the attribute in the API return value is
-- always a string containing the raw value.
--
-- Cells with format DATE, DATE_TIME or TIME have the raw value as a
-- floating point number where the whole number represents the number of
-- days since 1/1/1900 and the fractional part represents the fraction of
-- the day since midnight. For example, a cell with date 11/3/2020 has
-- the raw value "44138". A cell with the time 9:00 AM has the raw value
-- "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the
-- raw value "44138.375". Notice that even though the raw value is a
-- number in all three cases, it is still represented as a string.
--
-- Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the
-- raw value of the data as the number representing the data being
-- displayed. For example, the number 1.325 with two decimal places in
-- the format will have it's raw value as "1.325" and formatted value as
-- "1.33". A currency value for $10 will have the raw value as "10" and
-- formatted value as "$10.00". A value representing 20% with two decimal
-- places in the format will have its raw value as "0.2" and the
-- formatted value as "20.00%". An accounting value of -$25 will have
-- "-25" as the raw value and "$ (25.00)" as the formatted value.
--
-- Cells with format TEXT will have the raw text as the raw value. For
-- example, a cell with text "John Smith" will have "John Smith" as both
-- the raw value and the formatted value.
--
-- Cells with format CONTACT will have the name of the contact as a
-- formatted value and the email address of the contact as the raw value.
-- For example, a contact for John Smith will have "John Smith" as the
-- formatted value and "john.smith@example.com" as the raw value.
--
-- Cells with format ROWLINK (aka picklist) will have the first column of
-- the linked row as the formatted value and the row id of the linked row
-- as the raw value. For example, a cell containing a picklist to a table
-- that displays task status might have "Completed" as the formatted
-- value and
-- "row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03"
-- as the raw value.
--
-- Cells with format ROWSET (aka multi-select or multi-record picklist)
-- will by default have the first column of each of the linked rows as
-- the formatted value in the list, and the rowset id of the linked rows
-- as the raw value. For example, a cell containing a multi-select
-- picklist to a table that contains items might have "Item A", "Item B"
-- in the formatted value list and
-- "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/
-- [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]"
-- as the raw value.
--
-- Cells with format ATTACHMENT will have the name of the attachment as
-- the formatted value and the attachment id as the raw value. For
-- example, a cell containing an attachment named "image.jpeg" will have
-- "image.jpeg" as the formatted value and
-- "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
--
-- Cells with format AUTO or cells without any format that are
-- auto-detected as one of the formats above will contain the raw and
-- formatted values as mentioned above, based on the auto-detected
-- formats. If there is no auto-detected format, the raw and formatted
-- values will be the same as the data in the cell.
newCell :: Cell
-- | CellInput object contains the data needed to create or update cells in
-- a table.
--
-- CellInput object has only a facts field or a fact field, but not both.
-- A 400 bad request will be thrown if both fact and facts field are
-- present.
--
-- See: newCellInput smart constructor.
data CellInput
CellInput' :: Maybe (Sensitive Text) -> Maybe [Sensitive Text] -> CellInput
-- | Create a value of CellInput 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:fact:CellInput', cellInput_fact - Fact represents
-- the data that is entered into a cell. This data can be free text or a
-- formula. Formulas need to start with the equals (=) sign.
--
-- $sel:facts:CellInput', cellInput_facts - A list
-- representing the values that are entered into a ROWSET cell. Facts
-- list can have either only values or rowIDs, and rowIDs should from the
-- same table.
newCellInput :: CellInput
-- | Metadata for column in the table.
--
-- See: newColumnMetadata smart constructor.
data ColumnMetadata
ColumnMetadata' :: Sensitive Text -> Format -> 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:name:ColumnMetadata', columnMetadata_name - The
-- name of the column.
--
-- $sel:format:ColumnMetadata', columnMetadata_format - The
-- format of the column.
newColumnMetadata :: Text -> Format -> ColumnMetadata
-- | Data needed to create a single row in a table as part of the
-- BatchCreateTableRows request.
--
-- See: newCreateRowData smart constructor.
data CreateRowData
CreateRowData' :: Text -> HashMap Text CellInput -> CreateRowData
-- | Create a value of CreateRowData 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:batchItemId:CreateRowData',
-- createRowData_batchItemId - An external identifier that
-- represents the single row that is being created as part of the
-- BatchCreateTableRows request. This can be any string that you can use
-- to identify the row in the request. The BatchCreateTableRows API puts
-- the batch item id in the results to allow you to link data in the
-- request to data in the results.
--
-- $sel:cellsToCreate:CreateRowData',
-- createRowData_cellsToCreate - A map representing the cells to
-- create in the new row. The key is the column id of the cell and the
-- value is the CellInput object that represents the data to set in that
-- cell.
newCreateRowData :: Text -> CreateRowData
-- | The data in a particular data cell defined on the screen.
--
-- See: newDataItem smart constructor.
data DataItem
DataItem' :: Maybe Text -> Maybe Format -> Maybe Text -> DataItem
-- | Create a value of DataItem 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:formattedValue:DataItem', dataItem_formattedValue -
-- The formatted value of the data. e.g. John Smith.
--
-- $sel:overrideFormat:DataItem', dataItem_overrideFormat -
-- The overrideFormat is optional and is specified only if a particular
-- row of data has a different format for the data than the default
-- format defined on the screen or the table.
--
-- $sel:rawValue:DataItem', dataItem_rawValue - The raw
-- value of the data. e.g. jsmith@example.com
newDataItem :: DataItem
-- | An object that contains the options relating to parsing delimited text
-- as part of an import request.
--
-- See: newDelimitedTextImportOptions smart constructor.
data DelimitedTextImportOptions
DelimitedTextImportOptions' :: Maybe ImportDataCharacterEncoding -> Maybe Bool -> Maybe Bool -> Text -> DelimitedTextImportOptions
-- | Create a value of DelimitedTextImportOptions 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:dataCharacterEncoding:DelimitedTextImportOptions',
-- delimitedTextImportOptions_dataCharacterEncoding - The encoding
-- of the data in the input file.
--
-- $sel:hasHeaderRow:DelimitedTextImportOptions',
-- delimitedTextImportOptions_hasHeaderRow - Indicates whether the
-- input file has a header row at the top containing the column names.
--
-- $sel:ignoreEmptyRows:DelimitedTextImportOptions',
-- delimitedTextImportOptions_ignoreEmptyRows - A parameter to
-- indicate whether empty rows should be ignored or be included in the
-- import.
--
-- $sel:delimiter:DelimitedTextImportOptions',
-- delimitedTextImportOptions_delimiter - The delimiter to use for
-- separating columns in a single row of the input.
newDelimitedTextImportOptions :: Text -> DelimitedTextImportOptions
-- | An object that contains the options relating to the destination of the
-- import request.
--
-- See: newDestinationOptions smart constructor.
data DestinationOptions
DestinationOptions' :: Maybe (HashMap Text SourceDataColumnProperties) -> DestinationOptions
-- | Create a value of DestinationOptions 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:columnMap:DestinationOptions',
-- destinationOptions_columnMap - A map of the column id to the
-- import properties for each column.
newDestinationOptions :: DestinationOptions
-- | A single item in a batch that failed to perform the intended action
-- because of an error preventing it from succeeding.
--
-- See: newFailedBatchItem smart constructor.
data FailedBatchItem
FailedBatchItem' :: Text -> Text -> FailedBatchItem
-- | Create a value of FailedBatchItem 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:id:FailedBatchItem', failedBatchItem_id - The id of
-- the batch item that failed. This is the batch item id for the
-- BatchCreateTableRows and BatchUpsertTableRows operations and the row
-- id for the BatchUpdateTableRows and BatchDeleteTableRows operations.
--
-- $sel:errorMessage:FailedBatchItem',
-- failedBatchItem_errorMessage - The error message that indicates
-- why the batch item failed.
newFailedBatchItem :: Text -> Text -> FailedBatchItem
-- | An object that represents a filter formula along with the id of the
-- context row under which the filter function needs to evaluate.
--
-- See: newFilter smart constructor.
data Filter
Filter' :: Maybe Text -> Sensitive Text -> Filter
-- | Create a value of Filter 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:contextRowId:Filter', filter_contextRowId - The
-- optional contextRowId attribute can be used to specify the row id of
-- the context row if the filter formula contains unqualified references
-- to table columns and needs a context row to evaluate them
-- successfully.
--
-- $sel:formula:Filter', filter_formula - A formula
-- representing a filter function that returns zero or more matching rows
-- from a table. Valid formulas in this field return a list of rows from
-- a table. The most common ways of writing a formula to return a list of
-- rows are to use the FindRow() or Filter() functions. Any other formula
-- that returns zero or more rows is also acceptable. For example, you
-- can use a formula that points to a cell that contains a filter
-- function.
newFilter :: Text -> Filter
-- | An object that has details about the source of the data that was
-- submitted for import.
--
-- See: newImportDataSource smart constructor.
data ImportDataSource
ImportDataSource' :: ImportDataSourceConfig -> ImportDataSource
-- | Create a value of ImportDataSource 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:dataSourceConfig:ImportDataSource',
-- importDataSource_dataSourceConfig - The configuration
-- parameters for the data source of the import
newImportDataSource :: ImportDataSourceConfig -> ImportDataSource
-- | An object that contains the configuration parameters for the data
-- source of an import request.
--
-- See: newImportDataSourceConfig smart constructor.
data ImportDataSourceConfig
ImportDataSourceConfig' :: Maybe (Sensitive Text) -> ImportDataSourceConfig
-- | Create a value of ImportDataSourceConfig 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:dataSourceUrl:ImportDataSourceConfig',
-- importDataSourceConfig_dataSourceUrl - The URL from which
-- source data will be downloaded for the import request.
newImportDataSourceConfig :: ImportDataSourceConfig
-- | An object that contains the attributes of the submitter of the import
-- job.
--
-- See: newImportJobSubmitter smart constructor.
data ImportJobSubmitter
ImportJobSubmitter' :: Maybe (Sensitive Text) -> Maybe Text -> ImportJobSubmitter
-- | Create a value of ImportJobSubmitter 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:email:ImportJobSubmitter', importJobSubmitter_email
-- - The email id of the submitter of the import job, if available.
--
-- $sel:userArn:ImportJobSubmitter',
-- importJobSubmitter_userArn - The AWS user ARN of the submitter
-- of the import job, if available.
newImportJobSubmitter :: ImportJobSubmitter
-- | An object that contains the options specified by the sumitter of the
-- import request.
--
-- See: newImportOptions smart constructor.
data ImportOptions
ImportOptions' :: Maybe DelimitedTextImportOptions -> Maybe DestinationOptions -> ImportOptions
-- | Create a value of ImportOptions 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:delimitedTextOptions:ImportOptions',
-- importOptions_delimitedTextOptions - Options relating to
-- parsing delimited text. Required if dataFormat is DELIMITED_TEXT.
--
-- $sel:destinationOptions:ImportOptions',
-- importOptions_destinationOptions - Options relating to the
-- destination of the import request.
newImportOptions :: ImportOptions
-- | A single row in the ResultSet.
--
-- See: newResultRow smart constructor.
data ResultRow
ResultRow' :: Maybe Text -> [Sensitive DataItem] -> ResultRow
-- | Create a value of ResultRow 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:rowId:ResultRow', resultRow_rowId - The ID for a
-- particular row.
--
-- $sel:dataItems:ResultRow', resultRow_dataItems - List of
-- all the data cells in a row.
newResultRow :: ResultRow
-- | ResultSet contains the results of the request for a single block or
-- list defined on the screen.
--
-- See: newResultSet smart constructor.
data ResultSet
ResultSet' :: [ColumnMetadata] -> [ResultRow] -> ResultSet
-- | Create a value of ResultSet 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:headers:ResultSet', resultSet_headers - List of
-- headers for all the data cells in the block. The header identifies the
-- name and default format of the data cell. Data cells appear in the
-- same order in all rows as defined in the header. The names and formats
-- are not repeated in the rows. If a particular row does not have a
-- value for a data cell, a blank value is used.
--
-- For example, a task list that displays the task name, due date and
-- assigned person might have headers [ { "name": "Task Name"}, {"name":
-- "Due Date", "format": "DATE"}, {"name": "Assigned", "format":
-- "CONTACT"} ]. Every row in the result will have the task name as the
-- first item, due date as the second item and assigned person as the
-- third item. If a particular task does not have a due date, that row
-- will still have a blank value in the second element and the assigned
-- person will still be in the third element.
--
-- $sel:rows:ResultSet', resultSet_rows - List of rows
-- returned by the request. Each row has a row Id and a list of data
-- cells in that row. The data cells will be present in the same order as
-- they are defined in the header.
newResultSet :: ResultSet
-- | An object that contains the properties for importing data to a
-- specific column in a table.
--
-- See: newSourceDataColumnProperties smart constructor.
data SourceDataColumnProperties
SourceDataColumnProperties' :: Maybe Natural -> SourceDataColumnProperties
-- | Create a value of SourceDataColumnProperties 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:columnIndex:SourceDataColumnProperties',
-- sourceDataColumnProperties_columnIndex - The index of the
-- column in the input file.
newSourceDataColumnProperties :: SourceDataColumnProperties
-- | An object representing the properties of a table in a workbook.
--
-- See: newTable smart constructor.
data Table
Table' :: Maybe Text -> Maybe Text -> Table
-- | Create a value of Table 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:tableId:Table', table_tableId - The id of the
-- table.
--
-- $sel:tableName:Table', table_tableName - The name of the
-- table.
newTable :: Table
-- | An object that contains attributes about a single column in a table
--
-- See: newTableColumn smart constructor.
data TableColumn
TableColumn' :: Maybe Format -> Maybe Text -> Maybe Text -> TableColumn
-- | Create a value of TableColumn 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:format:TableColumn', tableColumn_format - The
-- column level format that is applied in the table. An empty value in
-- this field means that the column format is the default value 'AUTO'.
--
-- $sel:tableColumnId:TableColumn',
-- tableColumn_tableColumnId - The id of the column in the table.
--
-- $sel:tableColumnName:TableColumn',
-- tableColumn_tableColumnName - The name of the column in the
-- table.
newTableColumn :: TableColumn
-- | The metadata associated with the table data import job that was
-- submitted.
--
-- See: newTableDataImportJobMetadata smart constructor.
data TableDataImportJobMetadata
TableDataImportJobMetadata' :: ImportJobSubmitter -> POSIX -> ImportOptions -> ImportDataSource -> TableDataImportJobMetadata
-- | Create a value of TableDataImportJobMetadata 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:submitter:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_submitter - Details about the
-- submitter of the import request.
--
-- $sel:submitTime:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_submitTime - The timestamp when the
-- job was submitted for import.
--
-- $sel:importOptions:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_importOptions - The options that was
-- specified at the time of submitting the import request.
--
-- $sel:dataSource:TableDataImportJobMetadata',
-- tableDataImportJobMetadata_dataSource - The source of the data
-- that was submitted for import.
newTableDataImportJobMetadata :: ImportJobSubmitter -> UTCTime -> ImportOptions -> ImportDataSource -> TableDataImportJobMetadata
-- | An object that contains attributes about a single row in a table
--
-- See: newTableRow smart constructor.
data TableRow
TableRow' :: Text -> [Sensitive Cell] -> TableRow
-- | Create a value of TableRow 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:rowId:TableRow', tableRow_rowId - The id of the row
-- in the table.
--
-- $sel:cells:TableRow', tableRow_cells - A list of cells
-- in the table row. The cells appear in the same order as the columns of
-- the table.
newTableRow :: Text -> TableRow
-- | Data needed to create a single row in a table as part of the
-- BatchCreateTableRows request.
--
-- See: newUpdateRowData smart constructor.
data UpdateRowData
UpdateRowData' :: Text -> HashMap Text CellInput -> UpdateRowData
-- | Create a value of UpdateRowData 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:rowId:UpdateRowData', updateRowData_rowId - The id
-- of the row that needs to be updated.
--
-- $sel:cellsToUpdate:UpdateRowData',
-- updateRowData_cellsToUpdate - A map representing the cells to
-- update in the given row. The key is the column id of the cell and the
-- value is the CellInput object that represents the data to set in that
-- cell.
newUpdateRowData :: Text -> UpdateRowData
-- | Data needed to upsert rows in a table as part of a single item in the
-- BatchUpsertTableRows request.
--
-- See: newUpsertRowData smart constructor.
data UpsertRowData
UpsertRowData' :: Text -> Filter -> HashMap Text CellInput -> UpsertRowData
-- | Create a value of UpsertRowData 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:batchItemId:UpsertRowData',
-- upsertRowData_batchItemId - An external identifier that
-- represents a single item in the request that is being upserted as part
-- of the BatchUpsertTableRows request. This can be any string that you
-- can use to identify the item in the request. The BatchUpsertTableRows
-- API puts the batch item id in the results to allow you to link data in
-- the request to data in the results.
--
-- $sel:filter':UpsertRowData', upsertRowData_filter - The
-- filter formula to use to find existing matching rows to update. The
-- formula needs to return zero or more rows. If the formula returns 0
-- rows, then a new row will be appended in the target table. If the
-- formula returns one or more rows, then the returned rows will be
-- updated.
--
-- Note that the filter formula needs to return rows from the target
-- table for the upsert operation to succeed. If the filter formula has a
-- syntax error or it doesn't evaluate to zero or more rows in the target
-- table for any one item in the input list, then the entire
-- BatchUpsertTableRows request fails and no updates are made to the
-- table.
--
-- $sel:cellsToUpdate:UpsertRowData',
-- upsertRowData_cellsToUpdate - A map representing the cells to
-- update for the matching rows or an appended row. The key is the column
-- id of the cell and the value is the CellInput object that represents
-- the data to set in that cell.
newUpsertRowData :: Text -> Filter -> UpsertRowData
-- | An object that represents the result of a single upsert row request.
--
-- See: newUpsertRowsResult smart constructor.
data UpsertRowsResult
UpsertRowsResult' :: NonEmpty Text -> UpsertAction -> UpsertRowsResult
-- | Create a value of UpsertRowsResult 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:rowIds:UpsertRowsResult', upsertRowsResult_rowIds -
-- The list of row ids that were changed as part of an upsert row
-- operation. If the upsert resulted in an update, this list could
-- potentially contain multiple rows that matched the filter and hence
-- got updated. If the upsert resulted in an append, this list would only
-- have the single row that was appended.
--
-- $sel:upsertAction:UpsertRowsResult',
-- upsertRowsResult_upsertAction - The result of the upsert
-- action.
newUpsertRowsResult :: NonEmpty Text -> UpsertAction -> UpsertRowsResult
-- | The input variables to the app to be used by the
-- InvokeScreenAutomation action request.
--
-- See: newVariableValue smart constructor.
data VariableValue
VariableValue' :: Text -> VariableValue
-- | Create a value of VariableValue 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:rawValue:VariableValue', variableValue_rawValue -
-- Raw value of the variable.
newVariableValue :: Text -> VariableValue