AthenaStartQueryExecutionProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
AthenaStartQueryExecutionProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, query_string, client_request_token=None, query_execution_context=None, result_configuration=None, work_group=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
(experimental) Properties for starting a Query Execution.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_path (
Optional
[str
]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: - The entire task input (JSON path ‘$’)integration_pattern (
Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: IntegrationPattern.REQUEST_RESPONSEoutput_path (
Optional
[str
]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)result_path (
Optional
[str
]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output. Default: - Replaces the entire input with the result (JSON path ‘$’)timeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Nonequery_string (
str
) – (experimental) Query that will be started.client_request_token (
Optional
[str
]) – (experimental) Unique string string to ensure idempotence. Default: - No client request tokenquery_execution_context (
Optional
[QueryExecutionContext
]) – (experimental) Database within which query executes. Default: - No query execution contextresult_configuration (
Optional
[ResultConfiguration
]) – (experimental) Configuration on how and where to save query. Default: - No result configurationwork_group (
Optional
[str
]) – (experimental) Configuration on how and where to save query. Default: - No work group
- Stability
experimental
Attributes
-
client_request_token
¶ (experimental) Unique string string to ensure idempotence.
- Default
No client request token
- Stability
experimental
- Return type
Optional
[str
]
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
input_path
¶ JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
- Default
The entire task input (JSON path ‘$’)
- Return type
Optional
[str
]
-
integration_pattern
¶ AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
- Default
IntegrationPattern.REQUEST_RESPONSE
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
- Return type
Optional
[IntegrationPattern
]
-
output_path
¶ JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
- Default
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- Return type
Optional
[str
]
-
query_execution_context
¶ (experimental) Database within which query executes.
- Default
No query execution context
- Stability
experimental
- Return type
Optional
[QueryExecutionContext
]
-
query_string
¶ (experimental) Query that will be started.
- Stability
experimental
- Return type
str
-
result_configuration
¶ (experimental) Configuration on how and where to save query.
- Default
No result configuration
- Stability
experimental
- Return type
Optional
[ResultConfiguration
]
-
result_path
¶ JSONPath expression to indicate where to inject the state’s output.
May also be the special value JsonPath.DISCARD, which will cause the state’s input to become its output.
- Default
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
work_group
¶ (experimental) Configuration on how and where to save query.
- Default
No work group
- Stability
experimental
- Return type
Optional
[str
]