Class: Aws::Honeycode::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb

Overview

An API client for Honeycode. To construct a client, you need to configure a :region and :credentials.

client = Aws::Honeycode::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Honeycode::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Honeycode::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



385
386
387
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 385

def initialize(*args)
  super
end

Instance Method Details

#batch_create_table_rows(params = {}) ⇒ Types::BatchCreateTableRowsResult

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.

Examples:

Request syntax with placeholder values


resp = client.batch_create_table_rows({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  rows_to_create: [ # required
    {
      batch_item_id: "BatchItemId", # required
      cells_to_create: { # required
        "ResourceId" => {
          fact: "Fact",
          facts: ["Fact"],
        },
      },
    },
  ],
  client_request_token: "ClientRequestToken",
})

Response structure


resp.workbook_cursor #=> Integer
resp.created_rows #=> Hash
resp.created_rows["BatchItemId"] #=> String
resp.failed_batch_items #=> Array
resp.failed_batch_items[0].id #=> String
resp.failed_batch_items[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :rows_to_create (required, Array<Types::CreateRowData>) —

    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.

  • :client_request_token (String) —

    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.

Returns:

See Also:



473
474
475
476
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 473

def batch_create_table_rows(params = {}, options = {})
  req = build_request(:batch_create_table_rows, params)
  req.send_request(options)
end

#batch_delete_table_rows(params = {}) ⇒ Types::BatchDeleteTableRowsResult

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.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_table_rows({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  row_ids: ["RowId"], # required
  client_request_token: "ClientRequestToken",
})

Response structure


resp.workbook_cursor #=> Integer
resp.failed_batch_items #=> Array
resp.failed_batch_items[0].id #=> String
resp.failed_batch_items[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :row_ids (required, Array<String>) —

    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.

  • :client_request_token (String) —

    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.

Returns:

See Also:



538
539
540
541
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 538

def batch_delete_table_rows(params = {}, options = {})
  req = build_request(:batch_delete_table_rows, params)
  req.send_request(options)
end

#batch_update_table_rows(params = {}) ⇒ Types::BatchUpdateTableRowsResult

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 ("").

Examples:

Request syntax with placeholder values


resp = client.batch_update_table_rows({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  rows_to_update: [ # required
    {
      row_id: "RowId", # required
      cells_to_update: { # required
        "ResourceId" => {
          fact: "Fact",
          facts: ["Fact"],
        },
      },
    },
  ],
  client_request_token: "ClientRequestToken",
})

Response structure


resp.workbook_cursor #=> Integer
resp.failed_batch_items #=> Array
resp.failed_batch_items[0].id #=> String
resp.failed_batch_items[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :rows_to_update (required, Array<Types::UpdateRowData>) —

    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.

  • :client_request_token (String) —

    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.

Returns:

See Also:



621
622
623
624
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 621

def batch_update_table_rows(params = {}, options = {})
  req = build_request(:batch_update_table_rows, params)
  req.send_request(options)
end

#batch_upsert_table_rows(params = {}) ⇒ Types::BatchUpsertTableRowsResult

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 ("").

Examples:

Request syntax with placeholder values


resp = client.batch_upsert_table_rows({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  rows_to_upsert: [ # required
    {
      batch_item_id: "BatchItemId", # required
      filter: { # required
        formula: "Formula", # required
        context_row_id: "RowId",
      },
      cells_to_update: { # required
        "ResourceId" => {
          fact: "Fact",
          facts: ["Fact"],
        },
      },
    },
  ],
  client_request_token: "ClientRequestToken",
})

Response structure


resp.rows #=> Hash
resp.rows["BatchItemId"].row_ids #=> Array
resp.rows["BatchItemId"].row_ids[0] #=> String
resp.rows["BatchItemId"].upsert_action #=> String, one of "UPDATED", "APPENDED"
resp.workbook_cursor #=> Integer
resp.failed_batch_items #=> Array
resp.failed_batch_items[0].id #=> String
resp.failed_batch_items[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :rows_to_upsert (required, Array<Types::UpsertRowData>) —

    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.

  • :client_request_token (String) —

    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.

Returns:

See Also:



719
720
721
722
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 719

def batch_upsert_table_rows(params = {}, options = {})
  req = build_request(:batch_upsert_table_rows, params)
  req.send_request(options)
end

#describe_table_data_import_job(params = {}) ⇒ Types::DescribeTableDataImportJobResult

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Examples:

Request syntax with placeholder values


resp = client.describe_table_data_import_job({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  job_id: "JobId", # required
})

Response structure


resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"
resp.message #=> String
resp.job_metadata.submitter.email #=> String
resp.job_metadata.submitter.user_arn #=> String
resp.job_metadata.submit_time #=> Time
resp.job_metadata.import_options.destination_options.column_map #=> Hash
resp.job_metadata.import_options.destination_options.column_map["ResourceId"].column_index #=> Integer
resp.job_metadata.import_options.delimited_text_options.delimiter #=> String
resp.job_metadata.import_options.delimited_text_options.has_header_row #=> Boolean
resp.job_metadata.import_options.delimited_text_options.ignore_empty_rows #=> Boolean
resp.job_metadata.import_options.delimited_text_options.data_character_encoding #=> String, one of "UTF-8", "US-ASCII", "ISO-8859-1", "UTF-16BE", "UTF-16LE", "UTF-16"
resp.job_metadata.data_source.data_source_config.data_source_url #=> String
resp.error_code #=> String, one of "ACCESS_DENIED", "INVALID_URL_ERROR", "INVALID_IMPORT_OPTIONS_ERROR", "INVALID_TABLE_ID_ERROR", "INVALID_TABLE_COLUMN_ID_ERROR", "TABLE_NOT_FOUND_ERROR", "FILE_EMPTY_ERROR", "INVALID_FILE_TYPE_ERROR", "FILE_PARSING_ERROR", "FILE_SIZE_LIMIT_ERROR", "FILE_NOT_FOUND_ERROR", "UNKNOWN_ERROR", "RESOURCE_NOT_FOUND_ERROR", "SYSTEM_LIMIT_ERROR"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :job_id (required, String) —

    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.

Returns:

See Also:



781
782
783
784
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 781

def describe_table_data_import_job(params = {}, options = {})
  req = build_request(:describe_table_data_import_job, params)
  req.send_request(options)
end

#get_screen_data(params = {}) ⇒ Types::GetScreenDataResult

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.

Examples:

Request syntax with placeholder values


resp = client.get_screen_data({
  workbook_id: "ResourceId", # required
  app_id: "ResourceId", # required
  screen_id: "ResourceId", # required
  variables: {
    "VariableName" => {
      raw_value: "RawValue", # required
    },
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.results #=> Hash
resp.results["Name"].headers #=> Array
resp.results["Name"].headers[0].name #=> String
resp.results["Name"].headers[0].format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK", "ROWSET"
resp.results["Name"].rows #=> Array
resp.results["Name"].rows[0].row_id #=> String
resp.results["Name"].rows[0].data_items #=> Array
resp.results["Name"].rows[0].data_items[0].override_format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK", "ROWSET"
resp.results["Name"].rows[0].data_items[0].raw_value #=> String
resp.results["Name"].rows[0].data_items[0].formatted_value #=> String
resp.workbook_cursor #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    The ID of the workbook that contains the screen.

  • :app_id (required, String) —

    The ID of the app that contains the screen.

  • :screen_id (required, String) —

    The ID of the screen.

  • :variables (Hash<String,Types::VariableValue>) —

    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.

  • :max_results (Integer) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



861
862
863
864
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 861

def get_screen_data(params = {}, options = {})
  req = build_request(:get_screen_data, params)
  req.send_request(options)
end

#invoke_screen_automation(params = {}) ⇒ Types::InvokeScreenAutomationResult

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.

Examples:

Request syntax with placeholder values


resp = client.invoke_screen_automation({
  workbook_id: "ResourceId", # required
  app_id: "ResourceId", # required
  screen_id: "ResourceId", # required
  screen_automation_id: "ResourceId", # required
  variables: {
    "VariableName" => {
      raw_value: "RawValue", # required
    },
  },
  row_id: "RowId",
  client_request_token: "ClientRequestToken",
})

Response structure


resp.workbook_cursor #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    The ID of the workbook that contains the screen automation.

  • :app_id (required, String) —

    The ID of the app that contains the screen automation.

  • :screen_id (required, String) —

    The ID of the screen that contains the screen automation.

  • :screen_automation_id (required, String) —

    The ID of the automation action to be performed.

  • :variables (Hash<String,Types::VariableValue>) —

    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.

  • :row_id (String) —

    The row ID for the automation if the automation is defined inside a block with source or list.

  • :client_request_token (String) —

    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.

Returns:

See Also:



935
936
937
938
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 935

def invoke_screen_automation(params = {}, options = {})
  req = build_request(:invoke_screen_automation, params)
  req.send_request(options)
end

#list_table_columns(params = {}) ⇒ Types::ListTableColumnsResult

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_table_columns({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  next_token: "PaginationToken",
})

Response structure


resp.table_columns #=> Array
resp.table_columns[0].table_column_id #=> String
resp.table_columns[0].table_column_name #=> String
resp.table_columns[0].format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK", "ROWSET"
resp.next_token #=> String
resp.workbook_cursor #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :next_token (String) —

    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.

Returns:

See Also:



993
994
995
996
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 993

def list_table_columns(params = {}, options = {})
  req = build_request(:list_table_columns, params)
  req.send_request(options)
end

#list_table_rows(params = {}) ⇒ Types::ListTableRowsResult

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_table_rows({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  row_ids: ["RowId"],
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.column_ids #=> Array
resp.column_ids[0] #=> String
resp.rows #=> Array
resp.rows[0].row_id #=> String
resp.rows[0].cells #=> Array
resp.rows[0].cells[0].formula #=> String
resp.rows[0].cells[0].format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK", "ROWSET"
resp.rows[0].cells[0].raw_value #=> String
resp.rows[0].cells[0].formatted_value #=> String
resp.rows[0].cells[0].formatted_values #=> Array
resp.rows[0].cells[0].formatted_values[0] #=> String
resp.row_ids_not_found #=> Array
resp.row_ids_not_found[0] #=> String
resp.next_token #=> String
resp.workbook_cursor #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :row_ids (Array<String>) —

    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.

  • :max_results (Integer) —

    The maximum number of rows to return in each page of the results.

  • :next_token (String) —

    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.

Returns:

See Also:



1073
1074
1075
1076
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1073

def list_table_rows(params = {}, options = {})
  req = build_request(:list_table_rows, params)
  req.send_request(options)
end

#list_tables(params = {}) ⇒ Types::ListTablesResult

The ListTables API allows you to retrieve a list of all the tables in a workbook.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tables({
  workbook_id: "ResourceId", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.tables #=> Array
resp.tables[0].table_id #=> String
resp.tables[0].table_name #=> String
resp.next_token #=> String
resp.workbook_cursor #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :max_results (Integer) —

    The maximum number of tables to return in each page of the results.

  • :next_token (String) —

    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.

Returns:

See Also:



1126
1127
1128
1129
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1126

def list_tables(params = {}, options = {})
  req = build_request(:list_tables, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult

The ListTagsForResource API allows you to return a resource's tags.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's Amazon Resource Name (ARN).

Returns:

See Also:



1155
1156
1157
1158
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1155

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#query_table_rows(params = {}) ⇒ Types::QueryTableRowsResult

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.query_table_rows({
  workbook_id: "ResourceId", # required
  table_id: "ResourceId", # required
  filter_formula: { # required
    formula: "Formula", # required
    context_row_id: "RowId",
  },
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.column_ids #=> Array
resp.column_ids[0] #=> String
resp.rows #=> Array
resp.rows[0].row_id #=> String
resp.rows[0].cells #=> Array
resp.rows[0].cells[0].formula #=> String
resp.rows[0].cells[0].format #=> String, one of "AUTO", "NUMBER", "CURRENCY", "DATE", "TIME", "DATE_TIME", "PERCENTAGE", "TEXT", "ACCOUNTING", "CONTACT", "ROWLINK", "ROWSET"
resp.rows[0].cells[0].raw_value #=> String
resp.rows[0].cells[0].formatted_value #=> String
resp.rows[0].cells[0].formatted_values #=> Array
resp.rows[0].cells[0].formatted_values[0] #=> String
resp.next_token #=> String
resp.workbook_cursor #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :table_id (required, String) —

    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.

  • :filter_formula (required, 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.

  • :max_results (Integer) —

    The maximum number of rows to return in each page of the results.

  • :next_token (String) —

    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.

Returns:

See Also:



1232
1233
1234
1235
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1232

def query_table_rows(params = {}, options = {})
  req = build_request(:query_table_rows, params)
  req.send_request(options)
end

#start_table_data_import_job(params = {}) ⇒ Types::StartTableDataImportJobResult

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.

Examples:

Request syntax with placeholder values


resp = client.start_table_data_import_job({
  workbook_id: "ResourceId", # required
  data_source: { # required
    data_source_config: { # required
      data_source_url: "SecureURL",
    },
  },
  data_format: "DELIMITED_TEXT", # required, accepts DELIMITED_TEXT
  destination_table_id: "ResourceId", # required
  import_options: { # required
    destination_options: {
      column_map: {
        "ResourceId" => {
          column_index: 1,
        },
      },
    },
    delimited_text_options: {
      delimiter: "DelimitedTextDelimiter", # required
      has_header_row: false,
      ignore_empty_rows: false,
      data_character_encoding: "UTF-8", # accepts UTF-8, US-ASCII, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-16
    },
  },
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.job_id #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workbook_id (required, String) —

    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.

  • :data_source (required, Types::ImportDataSource) —

    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.

  • :data_format (required, String) —

    The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".

  • :destination_table_id (required, String) —

    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.

  • :import_options (required, Types::ImportOptions) —

    The options for customizing this import request.

  • :client_request_token (required, String) —

    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.

Returns:

See Also:



1320
1321
1322
1323
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1320

def start_table_data_import_job(params = {}, options = {})
  req = build_request(:start_table_data_import_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's Amazon Resource Name (ARN).

  • :tags (required, Hash<String,String>) —

    A list of tags to apply to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1349
1350
1351
1352
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1349

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The resource's Amazon Resource Name (ARN).

  • :tag_keys (required, Array<String>) —

    A list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1377
1378
1379
1380
 
# File 'gems/aws-sdk-honeycode/lib/aws-sdk-honeycode/client.rb', line 1377

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end