| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.HoneyCode
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- Format
- ImportDataCharacterEncoding
- ImportSourceDataFormat
- TableDataImportJobStatus
- UpsertAction
- Cell
- CellInput
- ColumnMetadata
- CreateRowData
- DataItem
- DelimitedTextImportOptions
- DestinationOptions
- FailedBatchItem
- Filter
- ImportDataSource
- ImportDataSourceConfig
- ImportJobSubmitter
- ImportOptions
- ResultRow
- ResultSet
- SourceDataColumnProperties
- Table
- TableColumn
- TableDataImportJobMetadata
- TableRow
- UpdateRowData
- UpsertRowData
- UpsertRowsResult
- VariableValue
Description
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.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _AutomationExecutionTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _AutomationExecutionException :: AsError a => Getting (First ServiceError) a ServiceError
- _RequestTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data BatchDeleteTableRows = BatchDeleteTableRows' (Maybe Text) Text Text (NonEmpty Text)
- newBatchDeleteTableRows :: Text -> Text -> NonEmpty Text -> BatchDeleteTableRows
- data BatchDeleteTableRowsResponse = BatchDeleteTableRowsResponse' (Maybe [FailedBatchItem]) Int Integer
- newBatchDeleteTableRowsResponse :: Int -> Integer -> BatchDeleteTableRowsResponse
- data BatchUpdateTableRows = BatchUpdateTableRows' (Maybe Text) Text Text (NonEmpty UpdateRowData)
- newBatchUpdateTableRows :: Text -> Text -> NonEmpty UpdateRowData -> BatchUpdateTableRows
- data BatchUpdateTableRowsResponse = BatchUpdateTableRowsResponse' (Maybe [FailedBatchItem]) Int Integer
- newBatchUpdateTableRowsResponse :: Int -> Integer -> BatchUpdateTableRowsResponse
- data ListTableRows = ListTableRows' (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Natural) Text Text
- newListTableRows :: Text -> Text -> ListTableRows
- data ListTableRowsResponse = ListTableRowsResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int (NonEmpty Text) [TableRow] Integer
- newListTableRowsResponse :: Int -> NonEmpty Text -> Integer -> ListTableRowsResponse
- data InvokeScreenAutomation = InvokeScreenAutomation' (Maybe Text) (Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))) (Maybe Text) Text Text Text Text
- newInvokeScreenAutomation :: Text -> Text -> Text -> Text -> InvokeScreenAutomation
- data InvokeScreenAutomationResponse = InvokeScreenAutomationResponse' Int Integer
- newInvokeScreenAutomationResponse :: Int -> Integer -> InvokeScreenAutomationResponse
- data DescribeTableDataImportJob = DescribeTableDataImportJob' Text Text Text
- newDescribeTableDataImportJob :: Text -> Text -> Text -> DescribeTableDataImportJob
- data DescribeTableDataImportJobResponse = DescribeTableDataImportJobResponse' Int TableDataImportJobStatus Text TableDataImportJobMetadata
- newDescribeTableDataImportJobResponse :: Int -> TableDataImportJobStatus -> Text -> TableDataImportJobMetadata -> DescribeTableDataImportJobResponse
- data StartTableDataImportJob = StartTableDataImportJob' Text ImportDataSource ImportSourceDataFormat Text ImportOptions Text
- newStartTableDataImportJob :: Text -> ImportDataSource -> ImportSourceDataFormat -> Text -> ImportOptions -> Text -> StartTableDataImportJob
- data StartTableDataImportJobResponse = StartTableDataImportJobResponse' Int Text TableDataImportJobStatus
- newStartTableDataImportJobResponse :: Int -> Text -> TableDataImportJobStatus -> StartTableDataImportJobResponse
- data BatchCreateTableRows = BatchCreateTableRows' (Maybe Text) Text Text (NonEmpty CreateRowData)
- newBatchCreateTableRows :: Text -> Text -> NonEmpty CreateRowData -> BatchCreateTableRows
- data BatchCreateTableRowsResponse = BatchCreateTableRowsResponse' (Maybe [FailedBatchItem]) Int Integer (HashMap Text Text)
- newBatchCreateTableRowsResponse :: Int -> Integer -> BatchCreateTableRowsResponse
- data ListTables = ListTables' (Maybe Text) (Maybe Natural) Text
- newListTables :: Text -> ListTables
- data ListTablesResponse = ListTablesResponse' (Maybe Text) (Maybe Integer) Int [Table]
- newListTablesResponse :: Int -> ListTablesResponse
- data GetScreenData = GetScreenData' (Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))) (Maybe Text) (Maybe Natural) Text Text Text
- newGetScreenData :: Text -> Text -> Text -> GetScreenData
- data GetScreenDataResponse = GetScreenDataResponse' (Maybe Text) Int (HashMap Text ResultSet) Integer
- newGetScreenDataResponse :: Int -> Integer -> GetScreenDataResponse
- data QueryTableRows = QueryTableRows' (Maybe Text) (Maybe Natural) Text Text Filter
- newQueryTableRows :: Text -> Text -> Filter -> QueryTableRows
- data QueryTableRowsResponse = QueryTableRowsResponse' (Maybe Text) Int (NonEmpty Text) [TableRow] Integer
- newQueryTableRowsResponse :: Int -> NonEmpty Text -> Integer -> QueryTableRowsResponse
- data BatchUpsertTableRows = BatchUpsertTableRows' (Maybe Text) Text Text [UpsertRowData]
- newBatchUpsertTableRows :: Text -> Text -> BatchUpsertTableRows
- data BatchUpsertTableRowsResponse = BatchUpsertTableRowsResponse' (Maybe [FailedBatchItem]) Int (HashMap Text UpsertRowsResult) Integer
- newBatchUpsertTableRowsResponse :: Int -> Integer -> BatchUpsertTableRowsResponse
- data ListTableColumns = ListTableColumns' (Maybe Text) Text Text
- newListTableColumns :: Text -> Text -> ListTableColumns
- data ListTableColumnsResponse = ListTableColumnsResponse' (Maybe Text) (Maybe Integer) Int [TableColumn]
- newListTableColumnsResponse :: Int -> ListTableColumnsResponse
- newtype Format where
- Format' {
- fromFormat :: 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_TEXT :: Format
- pattern Format_TIME :: Format
- Format' {
- newtype ImportDataCharacterEncoding where
- ImportDataCharacterEncoding' { }
- 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 where
- newtype TableDataImportJobStatus where
- TableDataImportJobStatus' { }
- pattern TableDataImportJobStatus_COMPLETED :: TableDataImportJobStatus
- pattern TableDataImportJobStatus_FAILED :: TableDataImportJobStatus
- pattern TableDataImportJobStatus_IN_PROGRESS :: TableDataImportJobStatus
- pattern TableDataImportJobStatus_SUBMITTED :: TableDataImportJobStatus
- newtype UpsertAction where
- UpsertAction' { }
- pattern UpsertAction_APPENDED :: UpsertAction
- pattern UpsertAction_UPDATED :: UpsertAction
- data Cell = Cell' (Maybe Text) (Maybe Format) (Maybe (Sensitive Text)) (Maybe Text)
- newCell :: Cell
- data CellInput = CellInput' (Maybe (Sensitive Text))
- newCellInput :: CellInput
- data ColumnMetadata = ColumnMetadata' (Sensitive Text) Format
- newColumnMetadata :: Text -> Format -> ColumnMetadata
- data CreateRowData = CreateRowData' Text (HashMap Text CellInput)
- newCreateRowData :: Text -> CreateRowData
- data DataItem = DataItem' (Maybe Text) (Maybe Format) (Maybe Text)
- newDataItem :: DataItem
- data DelimitedTextImportOptions = DelimitedTextImportOptions' (Maybe Bool) (Maybe Bool) (Maybe ImportDataCharacterEncoding) Text
- newDelimitedTextImportOptions :: Text -> DelimitedTextImportOptions
- data DestinationOptions = DestinationOptions' (Maybe (HashMap Text SourceDataColumnProperties))
- newDestinationOptions :: DestinationOptions
- data FailedBatchItem = FailedBatchItem' Text Text
- newFailedBatchItem :: Text -> Text -> FailedBatchItem
- data Filter = Filter' (Maybe Text) (Sensitive Text)
- newFilter :: Text -> Filter
- data ImportDataSource = ImportDataSource' ImportDataSourceConfig
- newImportDataSource :: ImportDataSourceConfig -> ImportDataSource
- data ImportDataSourceConfig = ImportDataSourceConfig' (Maybe Text)
- newImportDataSourceConfig :: ImportDataSourceConfig
- data ImportJobSubmitter = ImportJobSubmitter' (Maybe (Sensitive Text)) (Maybe Text)
- newImportJobSubmitter :: ImportJobSubmitter
- data ImportOptions = ImportOptions' (Maybe DelimitedTextImportOptions) (Maybe DestinationOptions)
- newImportOptions :: ImportOptions
- data ResultRow = ResultRow' (Maybe Text) [Sensitive DataItem]
- newResultRow :: ResultRow
- data ResultSet = ResultSet' [ColumnMetadata] [ResultRow]
- newResultSet :: ResultSet
- data SourceDataColumnProperties = SourceDataColumnProperties' (Maybe Natural)
- newSourceDataColumnProperties :: SourceDataColumnProperties
- data Table = Table' (Maybe Text) (Maybe Text)
- newTable :: Table
- data TableColumn = TableColumn' (Maybe Format) (Maybe Text) (Maybe Text)
- newTableColumn :: TableColumn
- data TableDataImportJobMetadata = TableDataImportJobMetadata' ImportJobSubmitter POSIX ImportOptions ImportDataSource
- newTableDataImportJobMetadata :: ImportJobSubmitter -> UTCTime -> ImportOptions -> ImportDataSource -> TableDataImportJobMetadata
- data TableRow = TableRow' Text [Sensitive Cell]
- newTableRow :: Text -> TableRow
- data UpdateRowData = UpdateRowData' Text (HashMap Text CellInput)
- newUpdateRowData :: Text -> UpdateRowData
- data UpsertRowData = UpsertRowData' Text Filter (HashMap Text CellInput)
- newUpsertRowData :: Text -> Filter -> UpsertRowData
- data UpsertRowsResult = UpsertRowsResult' (NonEmpty Text) UpsertAction
- newUpsertRowsResult :: NonEmpty Text -> UpsertAction -> UpsertRowsResult
- data VariableValue = VariableValue' Text
- newVariableValue :: Text -> VariableValue
Service Configuration
defaultService :: Service Source #
API version 2020-03-01 of the Amazon Honeycode SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by HoneyCode.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Request is invalid. The message in the response contains details on why the request is invalid.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
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.
AutomationExecutionTimeoutException
_AutomationExecutionTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The automation execution timed out.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request caused service quota to be breached.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Tps(transactions per second) rate reached.
AutomationExecutionException
_AutomationExecutionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The automation execution did not end successfully.
RequestTimeoutException
_RequestTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request timed out.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There were unexpected errors from the server.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Remote service is unreachable.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchDeleteTableRows
data BatchDeleteTableRows Source #
See: newBatchDeleteTableRows smart constructor.
Instances
newBatchDeleteTableRows Source #
Arguments
| :: 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.
$sel:tableId: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.
$sel:rowIds: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.
data BatchDeleteTableRowsResponse Source #
See: newBatchDeleteTableRowsResponse smart constructor.
Constructors
| BatchDeleteTableRowsResponse' (Maybe [FailedBatchItem]) Int Integer |
Instances
newBatchDeleteTableRowsResponse Source #
Arguments
| :: 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.
BatchUpdateTableRows
data BatchUpdateTableRows Source #
See: newBatchUpdateTableRows smart constructor.
Constructors
| BatchUpdateTableRows' (Maybe Text) Text Text (NonEmpty UpdateRowData) |
Instances
newBatchUpdateTableRows Source #
Arguments
| :: 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.
$sel:tableId: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.
data BatchUpdateTableRowsResponse Source #
See: newBatchUpdateTableRowsResponse smart constructor.
Constructors
| BatchUpdateTableRowsResponse' (Maybe [FailedBatchItem]) Int Integer |
Instances
newBatchUpdateTableRowsResponse Source #
Arguments
| :: 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.
ListTableRows (Paginated)
data ListTableRows Source #
See: newListTableRows smart constructor.
Instances
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:rowIds: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:nextToken: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.
$sel:maxResults:ListTableRows', listTableRows_maxResults - The maximum number of rows to return in each page of the results.
$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.
$sel:tableId: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.
data ListTableRowsResponse Source #
See: newListTableRowsResponse smart constructor.
Constructors
| ListTableRowsResponse' (Maybe (NonEmpty Text)) (Maybe Text) Int (NonEmpty Text) [TableRow] Integer |
Instances
newListTableRowsResponse Source #
Arguments
| :: Int | |
| -> NonEmpty Text | |
| -> 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:
$sel:rowIdsNotFound:ListTableRowsResponse', listTableRowsResponse_rowIdsNotFound - The list of row ids included in the request that were not found in the
table.
$sel:nextToken: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: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.
$sel:rows: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.
InvokeScreenAutomation
data InvokeScreenAutomation Source #
See: newInvokeScreenAutomation smart constructor.
Constructors
| InvokeScreenAutomation' (Maybe Text) (Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))) (Maybe Text) Text Text Text Text |
Instances
newInvokeScreenAutomation Source #
Arguments
| :: 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:rowId: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: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.
$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.
data InvokeScreenAutomationResponse Source #
See: newInvokeScreenAutomationResponse smart constructor.
Constructors
| InvokeScreenAutomationResponse' Int Integer |
Instances
newInvokeScreenAutomationResponse Source #
Arguments
| :: 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.
DescribeTableDataImportJob
data DescribeTableDataImportJob Source #
See: newDescribeTableDataImportJob smart constructor.
Constructors
| DescribeTableDataImportJob' Text Text Text |
Instances
newDescribeTableDataImportJob Source #
Arguments
| :: 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.
$sel:tableId: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.
data DescribeTableDataImportJobResponse Source #
See: newDescribeTableDataImportJobResponse smart constructor.
Constructors
| DescribeTableDataImportJobResponse' Int TableDataImportJobStatus Text TableDataImportJobMetadata |
Instances
newDescribeTableDataImportJobResponse Source #
Arguments
| :: 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: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.
StartTableDataImportJob
data StartTableDataImportJob Source #
See: newStartTableDataImportJob smart constructor.
Constructors
| StartTableDataImportJob' Text ImportDataSource ImportSourceDataFormat Text ImportOptions Text |
Instances
newStartTableDataImportJob Source #
Arguments
| :: 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.
$sel:dataSource: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.
$sel:importOptions: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.
data StartTableDataImportJobResponse Source #
See: newStartTableDataImportJobResponse smart constructor.
Instances
newStartTableDataImportJobResponse Source #
Arguments
| :: 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.
BatchCreateTableRows
data BatchCreateTableRows Source #
See: newBatchCreateTableRows smart constructor.
Constructors
| BatchCreateTableRows' (Maybe Text) Text Text (NonEmpty CreateRowData) |
Instances
newBatchCreateTableRows Source #
Arguments
| :: 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.
$sel:tableId: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.
data BatchCreateTableRowsResponse Source #
See: newBatchCreateTableRowsResponse smart constructor.
Constructors
| BatchCreateTableRowsResponse' (Maybe [FailedBatchItem]) Int Integer (HashMap Text Text) |
Instances
newBatchCreateTableRowsResponse Source #
Arguments
| :: Int | |
| -> Integer | |
| -> 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.
ListTables (Paginated)
data ListTables Source #
See: newListTables smart constructor.
Instances
Arguments
| :: Text | |
| -> ListTables |
Create a value of ListTables with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken: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:maxResults:ListTables', listTables_maxResults - The maximum number of tables to return in each page of the results.
$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.
data ListTablesResponse Source #
See: newListTablesResponse smart constructor.
Instances
newListTablesResponse Source #
Arguments
| :: Int | |
| -> ListTablesResponse |
Create a value of ListTablesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken: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.
GetScreenData
data GetScreenData Source #
See: newGetScreenData smart constructor.
Constructors
| GetScreenData' (Maybe (Sensitive (HashMap Text (Sensitive VariableValue)))) (Maybe Text) (Maybe Natural) Text Text Text |
Instances
Arguments
| :: 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: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:nextToken: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: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.
$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 screem.
$sel:screenId:GetScreenData', getScreenData_screenId - The ID of the screen.
data GetScreenDataResponse Source #
See: newGetScreenDataResponse smart constructor.
Instances
newGetScreenDataResponse Source #
Arguments
| :: Int | |
| -> 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:
$sel:nextToken: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.
QueryTableRows (Paginated)
data QueryTableRows Source #
See: newQueryTableRows smart constructor.
Instances
Arguments
| :: 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:nextToken: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:maxResults:QueryTableRows', queryTableRows_maxResults - The maximum number of rows to return in each page of the results.
$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.
$sel:tableId: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.
data QueryTableRowsResponse Source #
See: newQueryTableRowsResponse smart constructor.
Instances
newQueryTableRowsResponse Source #
Arguments
| :: Int | |
| -> NonEmpty Text | |
| -> 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:
$sel:nextToken: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.
$sel:rows: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.
BatchUpsertTableRows
data BatchUpsertTableRows Source #
See: newBatchUpsertTableRows smart constructor.
Constructors
| BatchUpsertTableRows' (Maybe Text) Text Text [UpsertRowData] |
Instances
newBatchUpsertTableRows Source #
Arguments
| :: Text | |
| -> Text | |
| -> 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.
$sel:tableId: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.
data BatchUpsertTableRowsResponse Source #
See: newBatchUpsertTableRowsResponse smart constructor.
Constructors
| BatchUpsertTableRowsResponse' (Maybe [FailedBatchItem]) Int (HashMap Text UpsertRowsResult) Integer |
Instances
newBatchUpsertTableRowsResponse Source #
Arguments
| :: Int | |
| -> 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.
$sel:rows: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.
ListTableColumns (Paginated)
data ListTableColumns Source #
See: newListTableColumns smart constructor.
Constructors
| ListTableColumns' (Maybe Text) Text Text |
Instances
Arguments
| :: 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:
$sel:nextToken: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.
$sel:tableId: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.
data ListTableColumnsResponse Source #
See: newListTableColumnsResponse smart constructor.
Constructors
| ListTableColumnsResponse' (Maybe Text) (Maybe Integer) Int [TableColumn] |
Instances
newListTableColumnsResponse Source #
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:
$sel:nextToken: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.
Types
Format
Constructors
| Format' | |
Fields
| |
Bundled Patterns
| 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_TEXT :: Format | |
| pattern Format_TIME :: Format |
Instances
ImportDataCharacterEncoding
newtype ImportDataCharacterEncoding Source #
Constructors
| ImportDataCharacterEncoding' | |
Fields | |
Bundled Patterns
Instances
ImportSourceDataFormat
newtype ImportSourceDataFormat Source #
Constructors
| ImportSourceDataFormat' | |
Fields | |
Bundled Patterns
| pattern ImportSourceDataFormat_DELIMITED_TEXT :: ImportSourceDataFormat |
Instances
TableDataImportJobStatus
newtype TableDataImportJobStatus Source #
Constructors
| TableDataImportJobStatus' | |
Fields | |
Bundled Patterns
Instances
UpsertAction
newtype UpsertAction Source #
Constructors
| UpsertAction' | |
Fields | |
Bundled Patterns
| pattern UpsertAction_APPENDED :: UpsertAction | |
| pattern UpsertAction_UPDATED :: UpsertAction |
Instances
Cell
An object that represents a single cell in a table.
See: newCell smart constructor.
Instances
| Eq Cell Source # | |
| Show Cell Source # | |
| Generic Cell Source # | |
| NFData Cell Source # | |
Defined in Amazonka.HoneyCode.Types.Cell | |
| Hashable Cell Source # | |
Defined in Amazonka.HoneyCode.Types.Cell | |
| FromJSON Cell Source # | |
| type Rep Cell Source # | |
Defined in Amazonka.HoneyCode.Types.Cell type Rep Cell = D1 ('MetaData "Cell" "Amazonka.HoneyCode.Types.Cell" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "Cell'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rawValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Format))) :*: (S1 ('MetaSel ('Just "formula") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "formattedValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (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: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 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: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:formula:Cell', cell_formula - The formula contained in the cell. This field is empty if a cell does
not have a formula.
$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.
CellInput
CellInput object contains the data needed to create or update cells in a table.
See: newCellInput smart constructor.
Constructors
| CellInput' (Maybe (Sensitive Text)) |
Instances
| Eq CellInput Source # | |
| Show CellInput Source # | |
| Generic CellInput Source # | |
| NFData CellInput Source # | |
Defined in Amazonka.HoneyCode.Types.CellInput | |
| Hashable CellInput Source # | |
Defined in Amazonka.HoneyCode.Types.CellInput | |
| ToJSON CellInput Source # | |
Defined in Amazonka.HoneyCode.Types.CellInput | |
| type Rep CellInput Source # | |
Defined in Amazonka.HoneyCode.Types.CellInput type Rep CellInput = D1 ('MetaData "CellInput" "Amazonka.HoneyCode.Types.CellInput" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "CellInput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) | |
newCellInput :: CellInput Source #
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.
ColumnMetadata
data ColumnMetadata Source #
Metadata for column in the table.
See: newColumnMetadata smart constructor.
Constructors
| ColumnMetadata' (Sensitive Text) Format |
Instances
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.
CreateRowData
data CreateRowData Source #
Data needed to create a single row in a table as part of the BatchCreateTableRows request.
See: newCreateRowData smart constructor.
Constructors
| CreateRowData' Text (HashMap Text CellInput) |
Instances
Arguments
| :: Text | |
| -> 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.
DataItem
The data in a particular data cell defined on the screen.
See: newDataItem smart constructor.
Instances
| Eq DataItem Source # | |
| Show DataItem Source # | |
| Generic DataItem Source # | |
| NFData DataItem Source # | |
Defined in Amazonka.HoneyCode.Types.DataItem | |
| Hashable DataItem Source # | |
Defined in Amazonka.HoneyCode.Types.DataItem | |
| FromJSON DataItem Source # | |
| type Rep DataItem Source # | |
Defined in Amazonka.HoneyCode.Types.DataItem type Rep DataItem = D1 ('MetaData "DataItem" "Amazonka.HoneyCode.Types.DataItem" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "DataItem'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rawValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "overrideFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Format)) :*: S1 ('MetaSel ('Just "formattedValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newDataItem :: DataItem Source #
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:rawValue:DataItem', dataItem_rawValue - The raw value of the data. e.g. jsmith@example.com
$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:formattedValue:DataItem', dataItem_formattedValue - The formatted value of the data. e.g. John Smith.
DelimitedTextImportOptions
data DelimitedTextImportOptions Source #
An object that contains the options relating to parsing delimited text as part of an import request.
See: newDelimitedTextImportOptions smart constructor.
Constructors
| DelimitedTextImportOptions' (Maybe Bool) (Maybe Bool) (Maybe ImportDataCharacterEncoding) Text |
Instances
newDelimitedTextImportOptions Source #
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:ignoreEmptyRows:DelimitedTextImportOptions', delimitedTextImportOptions_ignoreEmptyRows - A parameter to indicate whether empty rows should be ignored or be
included in the import.
$sel:hasHeaderRow:DelimitedTextImportOptions', delimitedTextImportOptions_hasHeaderRow - Indicates whether the input file has a header row at the top containing
the column names.
$sel:dataCharacterEncoding:DelimitedTextImportOptions', delimitedTextImportOptions_dataCharacterEncoding - The encoding of the data in the input file.
$sel:delimiter:DelimitedTextImportOptions', delimitedTextImportOptions_delimiter - The delimiter to use for separating columns in a single row of the
input.
DestinationOptions
data DestinationOptions Source #
An object that contains the options relating to the destination of the import request.
See: newDestinationOptions smart constructor.
Constructors
| DestinationOptions' (Maybe (HashMap Text SourceDataColumnProperties)) |
Instances
newDestinationOptions :: DestinationOptions Source #
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.
FailedBatchItem
data FailedBatchItem Source #
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.
Constructors
| FailedBatchItem' Text Text |
Instances
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.
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.
Instances
| Eq Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.HoneyCode.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.HoneyCode.Types.Filter | |
| ToJSON Filter Source # | |
Defined in Amazonka.HoneyCode.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.HoneyCode.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.HoneyCode.Types.Filter" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "contextRowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "formula") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (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.
ImportDataSource
data ImportDataSource Source #
An object that has details about the source of the data that was submitted for import.
See: newImportDataSource smart constructor.
Constructors
| ImportDataSource' ImportDataSourceConfig |
Instances
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
ImportDataSourceConfig
data ImportDataSourceConfig Source #
An object that contains the configuration parameters for the data source of an import request.
See: newImportDataSourceConfig smart constructor.
Constructors
| ImportDataSourceConfig' (Maybe Text) |
Instances
newImportDataSourceConfig :: ImportDataSourceConfig Source #
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.
ImportJobSubmitter
data ImportJobSubmitter Source #
An object that contains the attributes of the submitter of the import job.
See: newImportJobSubmitter smart constructor.
Instances
newImportJobSubmitter :: ImportJobSubmitter Source #
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.
ImportOptions
data ImportOptions Source #
An object that contains the options specified by the sumitter of the import request.
See: newImportOptions smart constructor.
Constructors
| ImportOptions' (Maybe DelimitedTextImportOptions) (Maybe DestinationOptions) |
Instances
newImportOptions :: ImportOptions Source #
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.
ResultRow
A single row in the ResultSet.
See: newResultRow smart constructor.
Constructors
| ResultRow' (Maybe Text) [Sensitive DataItem] |
Instances
| Eq ResultRow Source # | |
| Show ResultRow Source # | |
| Generic ResultRow Source # | |
| NFData ResultRow Source # | |
Defined in Amazonka.HoneyCode.Types.ResultRow | |
| Hashable ResultRow Source # | |
Defined in Amazonka.HoneyCode.Types.ResultRow | |
| FromJSON ResultRow Source # | |
| type Rep ResultRow Source # | |
Defined in Amazonka.HoneyCode.Types.ResultRow type Rep ResultRow = D1 ('MetaData "ResultRow" "Amazonka.HoneyCode.Types.ResultRow" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "ResultRow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Sensitive DataItem]))) | |
newResultRow :: ResultRow Source #
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.
ResultSet
ResultSet contains the results of the request for a single block or list defined on the screen.
See: newResultSet smart constructor.
Constructors
| ResultSet' [ColumnMetadata] [ResultRow] |
Instances
| Eq ResultSet Source # | |
| Show ResultSet Source # | |
| Generic ResultSet Source # | |
| NFData ResultSet Source # | |
Defined in Amazonka.HoneyCode.Types.ResultSet | |
| Hashable ResultSet Source # | |
Defined in Amazonka.HoneyCode.Types.ResultSet | |
| FromJSON ResultSet Source # | |
| type Rep ResultSet Source # | |
Defined in Amazonka.HoneyCode.Types.ResultSet type Rep ResultSet = D1 ('MetaData "ResultSet" "Amazonka.HoneyCode.Types.ResultSet" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "ResultSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ColumnMetadata]) :*: S1 ('MetaSel ('Just "rows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ResultRow]))) | |
newResultSet :: ResultSet Source #
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.
SourceDataColumnProperties
data SourceDataColumnProperties Source #
An object that contains the properties for importing data to a specific column in a table.
See: newSourceDataColumnProperties smart constructor.
Constructors
| SourceDataColumnProperties' (Maybe Natural) |
Instances
newSourceDataColumnProperties :: SourceDataColumnProperties Source #
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.
Table
An object representing the properties of a table in a workbook.
See: newTable smart constructor.
Instances
| Eq Table Source # | |
| Read Table Source # | |
| Show Table Source # | |
| Generic Table Source # | |
| NFData Table Source # | |
Defined in Amazonka.HoneyCode.Types.Table | |
| Hashable Table Source # | |
Defined in Amazonka.HoneyCode.Types.Table | |
| FromJSON Table Source # | |
| type Rep Table Source # | |
Defined in Amazonka.HoneyCode.Types.Table type Rep Table = D1 ('MetaData "Table" "Amazonka.HoneyCode.Types.Table" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "Table'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (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.
TableColumn
data TableColumn Source #
An object that contains attributes about a single column in a table
See: newTableColumn smart constructor.
Instances
newTableColumn :: TableColumn Source #
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:tableColumnName:TableColumn', tableColumn_tableColumnName - The name of the column in the table.
$sel:tableColumnId:TableColumn', tableColumn_tableColumnId - The id of the column in the table.
TableDataImportJobMetadata
data TableDataImportJobMetadata Source #
The metadata associated with the table data import job that was submitted.
See: newTableDataImportJobMetadata smart constructor.
Instances
newTableDataImportJobMetadata Source #
Arguments
| :: ImportJobSubmitter | |
| -> UTCTime | |
| -> 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.
TableRow
An object that contains attributes about a single row in a table
See: newTableRow smart constructor.
Instances
| Eq TableRow Source # | |
| Show TableRow Source # | |
| Generic TableRow Source # | |
| NFData TableRow Source # | |
Defined in Amazonka.HoneyCode.Types.TableRow | |
| Hashable TableRow Source # | |
Defined in Amazonka.HoneyCode.Types.TableRow | |
| FromJSON TableRow Source # | |
| type Rep TableRow Source # | |
Defined in Amazonka.HoneyCode.Types.TableRow type Rep TableRow = D1 ('MetaData "TableRow" "Amazonka.HoneyCode.Types.TableRow" "libZSservicesZSamazonka-honeycodeZSamazonka-honeycode" 'False) (C1 ('MetaCons "TableRow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "rowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cells") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [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.
UpdateRowData
data UpdateRowData Source #
Data needed to create a single row in a table as part of the BatchCreateTableRows request.
See: newUpdateRowData smart constructor.
Constructors
| UpdateRowData' Text (HashMap Text CellInput) |
Instances
Arguments
| :: Text | |
| -> 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.
UpsertRowData
data UpsertRowData Source #
Data needed to upsert rows in a table as part of a single item in the BatchUpsertTableRows request.
See: newUpsertRowData smart constructor.
Instances
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.
UpsertRowsResult
data UpsertRowsResult Source #
An object that represents the result of a single upsert row request.
See: newUpsertRowsResult smart constructor.
Constructors
| UpsertRowsResult' (NonEmpty Text) UpsertAction |
Instances
Arguments
| :: 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.
VariableValue
data VariableValue Source #
The input variables to the app to be used by the InvokeScreenAutomation action request.
See: newVariableValue smart constructor.
Constructors
| VariableValue' Text |
Instances
Arguments
| :: 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.