CallApiGatewayRestApiEndpointJsonataProps

class aws_cdk.aws_stepfunctions_tasks.CallApiGatewayRestApiEndpointJsonataProps(*, comment=None, query_language=None, state_name=None, credentials=None, heartbeat=None, heartbeat_timeout=None, integration_pattern=None, task_timeout=None, timeout=None, assign=None, outputs=None, method, api_path=None, auth_type=None, headers=None, query_parameters=None, request_body=None, api, stage_name, region=None)

Bases: CallApiGatewayEndpointJsonataBaseProps, CallApiGatewayRestApiEndpointOptions

Properties for calling an REST API Endpoint using JSONata.

Parameters:

  • comment (Optional[str]) – A comment describing this state. Default: No comment

  • query_language (Optional[QueryLanguage]) – The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field. Default: - JSONPath

  • state_name (Optional[str]) – Optional name for this state. Default: - The construct ID will be used as state name

  • credentials (Union[Credentials, Dict[str, Any], None]) – Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations. Default: - None (Task is executed using the State Machine’s execution role)

  • heartbeat (Optional[Duration]) – (deprecated) Timeout for the heartbeat. Default: - None

  • heartbeat_timeout (Optional[Timeout]) – Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - None

  • 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. Depending on the AWS Service, the Service Integration Pattern availability will vary. Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

  • task_timeout (Optional[Timeout]) – Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - None

  • timeout (Optional[Duration]) – (deprecated) Timeout for the task. Default: - None

  • assign (Optional[Mapping[str, Any]]) – Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps. Default: - Not assign variables

  • outputs (Any) – Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly. Default: - $states.result or $states.errorOutput

  • 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

  • api (IRestApi) – API to call.

  • stage_name (str) – Name of the stage where the API is deployed to in API Gateway.

  • region (Optional[str]) – Specify a custom Region where the API is deployed, e.g. ‘us-east-1’. Default: - Uses the Region of the stack containing the api.

ExampleMetadata:

infused

Example:

import aws_cdk.aws_apigateway as apigateway
# api: apigateway.RestApi


tasks.CallApiGatewayRestApiEndpoint.jsonata(self, "Endpoint",
    api=api,
    stage_name="Stage",
    method=tasks.HttpMethod.PUT,
    integration_pattern=sfn.IntegrationPattern.WAIT_FOR_TASK_TOKEN,
    headers=sfn.TaskInput.from_object({
        "TaskToken": "{% States.Array($states.context.taskToken) %}"
    })
)

Attributes

api

API to call.

api_path

Path parameters appended after API endpoint.

Default:

  • No path

assign

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default:

  • Not assign variables

See:

https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

auth_type

Authentication methods.

Default:

AuthType.NO_AUTH

comment

A comment describing this state.

Default:

No comment

credentials

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

Default:

  • None (Task is executed using the State Machine’s execution role)

See:

https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html

headers

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

Default:

  • No headers

heartbeat

(deprecated) Timeout for the heartbeat.

Default:

  • None

Deprecated:

use heartbeatTimeout

Stability:

deprecated

heartbeat_timeout

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default:

  • None

integration_pattern

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

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-supported-services.html

method

Http method for the API.

outputs

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default:

  • $states.result or $states.errorOutput

See:

https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

query_language

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default:

  • JSONPath

query_parameters

Query strings attatched to end of request.

Default:

  • No query parameters

region

Specify a custom Region where the API is deployed, e.g. ‘us-east-1’.

Default:

  • Uses the Region of the stack containing the api.

request_body

HTTP Request body.

Default:

  • No request body

stage_name

Name of the stage where the API is deployed to in API Gateway.

state_name

Optional name for this state.

Default:

  • The construct ID will be used as state name

task_timeout

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Default:

  • None

timeout

(deprecated) Timeout for the task.

Default:

  • None

Deprecated:

use taskTimeout

Stability:

deprecated