CallApiGatewayEndpointBaseProps

class aws_cdk.aws_stepfunctions_tasks.CallApiGatewayEndpointBaseProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, method, api_path=None, auth_type=None, headers=None, query_parameters=None, request_body=None)

Bases: TaskStateBaseProps

Base CallApiGatewayEdnpoint Task Props.

Parameters:

comment (Optional[str]) – An optional description for this state. Default: - No comment
heartbeat (Optional[Duration]) – Timeout for the heartbeat. Default: - None
input_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_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
output_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 ‘$’)
result_selector (Optional[Mapping[str, Any]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - None
timeout (Optional[Duration]) – Timeout for the state machine. Default: - None
method (HttpMethod) – Http method for the API.
api_path (Optional[str]) – Path parameters appended after API endpoint. Default: - No path
auth_type (Optional[AuthType]) – Authentication methods. Default: AuthType.NO_AUTH
headers (Optional[TaskInput]) – HTTP request information that does not relate to contents of the request. Default: - No headers
query_parameters (Optional[TaskInput]) – Query strings attatched to end of request. Default: - No query parameters
request_body (Optional[TaskInput]) – HTTP Request body. Default: - No request body

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_stepfunctions as stepfunctions
import aws_cdk.aws_stepfunctions_tasks as stepfunctions_tasks
import aws_cdk.core as cdk

# result_selector: Any
# task_input: stepfunctions.TaskInput

call_api_gateway_endpoint_base_props = stepfunctions_tasks.CallApiGatewayEndpointBaseProps(
    method=stepfunctions_tasks.HttpMethod.GET,

    # the properties below are optional
    api_path="apiPath",
    auth_type=stepfunctions_tasks.AuthType.NO_AUTH,
    comment="comment",
    headers=task_input,
    heartbeat=cdk.Duration.minutes(30),
    input_path="inputPath",
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    output_path="outputPath",
    query_parameters=task_input,
    request_body=task_input,
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    timeout=cdk.Duration.minutes(30)
)

Attributes

api_path

Path parameters appended after API endpoint.

Default:

No path

auth_type

Authentication methods.

Default:: AuthType.NO_AUTH

comment

An optional description for this state.

Default:

No comment

headers

HTTP request information that does not relate to contents of the request.

Default:

No headers

heartbeat

Timeout for the heartbeat.

Default:

None

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 ‘$’)

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 for most tasks.

IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

See:: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

method: Http method for the API.

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 ‘$’)

query_parameters

Query strings attatched to end of request.

Default:

No query parameters

request_body

HTTP Request body.

Default:

No request body

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 ‘$’)

result_selector

The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.

Default:

None

See:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

timeout

Timeout for the state machine.

Default:

None