Skip to main content

Athena List Query Executions

Returns a list of available query execution IDs for the Amazon Athena queries in the specified workgroup.

component image

In-ports​

page-token String — a token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the value from the next-token port.

trigger <any> — triggers the action.

abort Boolean — aborts all pending actions.

config JSON (dynamic) — accepts a JSON object with configuration properties that can be set at runtime.

Out-ports​

list JSON — emits a list of available query execution IDs for the Athena queries in the current workgroup.

next-token String — emits a token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.

errors JSON — emits any errors that occur during the action.

Overview​

The Athena List Query Executions component allows you to retrieve the list of available query execution IDs for the Amazon Athena queries in the specified workgroup. This component is part of a group of components that are designed to perform advanced operations with Amazon Athena. Simpler version of Athena interface is available in the Athena Query component.

To use this component, follow these steps:

  • Connect it to your Amazon Athena account.
  • Pass anything (or null) to the page-token port to get the first page of query execution IDs. The default page size is 10, which can be changed in settings.
  • To retrieve subsequent pages, pass the next-token value that was emitted on the next-token port.
  • The component will return a list of available query execution IDs on the list port.

Use the Athena Get Query Execution component to retrieve query execution details or Athena Get Results component to retrieve the query results.

If the trigger input port is connected, the component will wait to execute the action until an event is sent on the trigger port. The component will execute the action every time an event is received on the trigger port. If any errors occur during the action execution, the corresponding error message will be emitted on the errors output port.

Configuration​

This component supports dynamic configuration. You can specify the required settings either in the Settings dialog or through a configuration object. To enable the config port for runtime configuration, turn on the Enable realtime config port setting.

Settings​

Authentication​

Configure authentication to the target service. Select one of the existing connections from the drop-down list, or configure a new connection.

Enable realtime config port​

If this setting is enabled, the component can be configured through the config port. This port accepts a configuration object as input and allows you to set dynamic properties at runtime. Note that using this port does not cause the component to reinitialize, but it may cause some previous state of the component to be lost.

Workgroup (workGroup)​

The workgroup name. Athena workgroups allow you to isolate the queries for you or your group of users from others in the same account, and to configure the location of query results and the encryption configuration.

Type: String
Required: Yes

Region (region)​

The name of AWS Region in which you are using Athena. Athena allows you to query Amazon S3 data in a different AWS Region than the one in which you are using Athena. Learn more about querying across AWS regions.

Type: String
Required: Yes

Results page size (maxResults)​

The maximum number of results (rows) to return in one page request.

Type: Number
Default: 10
Required: Yes

Keep always active​

Determines whether the component will remain active even if it is not connected to a visible widget or another active component.

Configuration Object​

Here is an example of a configuration object that you can use as a template:

{
  "workGroup": "my_workgroup",
  "region": "us-east-1",
  "maxResults": 10
}

See also​

For more information about Amazon Athena, see the following: