Package software.amazon.awscdk.services.stepfunctions.tasks

Interface AthenaGetQueryResultsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

AthenaGetQueryResultsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:36.681Z")
@Stability(Stable)
public interface AthenaGetQueryResultsProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for getting a Query Results.

Example:

 AthenaGetQueryResults getQueryResultsJob = AthenaGetQueryResults.Builder.create(this, "Get Query Results")
         .queryExecutionId(JsonPath.stringAt("$.QueryExecutionId"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AthenaGetQueryResultsProps.Builder	A builder for AthenaGetQueryResultsProps
static final class	AthenaGetQueryResultsProps.Jsii$Proxy	An implementation for AthenaGetQueryResultsProps

Method Summary

Modifier and Type	Method	Description
static AthenaGetQueryResultsProps.Builder	builder()
default Number	getMaxResults()	Max number of results.
default String	getNextToken()	Pagination token.
String	getQueryExecutionId()	Query that will be retrieved.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getQueryExecutionId

@Stability(Stable)
@NotNull
String getQueryExecutionId()

Query that will be retrieved.

Example value: adfsaf-23trf23-f23rt23

getMaxResults

@Stability(Stable)
@Nullable
default Number getMaxResults()

Max number of results.

Default: 1000

getNextToken

@Stability(Stable)
@Nullable
default String getNextToken()

Pagination token.

Default: - No next token

builder

@Stability(Stable)
static AthenaGetQueryResultsProps.Builder builder()

Returns:

a AthenaGetQueryResultsProps.Builder of AthenaGetQueryResultsProps