aws-cdk-lib.aws_stepfunctions_tasks.HttpInvokeJsonataProps

HttpInvokeJsonataProps Struct

Properties for calling an external HTTP endpoint with HttpInvoke using JSONata.

HttpInvokeJsonataProps

extends

• TaskStateJsonataBaseProps

Source

aws-stepfunctions-tasks/lib/http/invoke.ts

Type last changed

v2.178.0 · 6 Feb 2025

Example

import * as events from 'aws-cdk-lib/aws-events';
declare const connection: events.Connection;

const getIssue = tasks.HttpInvoke.jsonata(this, 'Get Issue', {
  connection,
  apiRoot: "{% 'https://' & $states.input.hostname %}",
  apiEndpoint: sfn.TaskInput.fromText("{% 'issues/' & $states.input.issue.id %}"),
  method: sfn.TaskInput.fromText('GET'),
  // Parse the API call result to object and set to the variables
  assign: {
    hostname: '{% $states.input.hostname %}',
    issue: '{% $parse($states.result.ResponseBody) %}',
  },
});

const updateLabels = tasks.HttpInvoke.jsonata(this, 'Update Issue Labels', {
  connection,
  apiRoot: "{% 'https://' & $states.input.hostname %}",
  apiEndpoint: sfn.TaskInput.fromText("{% 'issues/' & $states.input.issue.id & 'labels' %}"),
  method: sfn.TaskInput.fromText('POST'),
  body: sfn.TaskInput.fromObject({
    labels: '{% [$type, $component] %}',
  }),
});
const notMatchTitleTemplate = sfn.Pass.jsonata(this, 'Not Match Title Template');

const definition = getIssue
  .next(sfn.Choice.jsonata(this, 'Match Title Template?')
    // Look at the "title" field of issue in variables using Regex
    .when(sfn.Condition.jsonata('{% $contains($issue.title, /(feat)|(fix)|(chore)\(\w*\):.*/) %}'), updateLabels, {
      assign: {
        type: '{% $match($states.input.title, /(\w*)\((.*)\)/).groups[0] %}',
        component: '{% $match($states.input.title, /(\w*)\((.*)\)/).groups[1] %}',
      }
    })
    .otherwise(notMatchTitleTemplate));

new sfn.StateMachine(this, 'StateMachine', {
  definitionBody: sfn.DefinitionBody.fromChainable(definition),
  timeout: Duration.minutes(5),
  comment: 'automate issue labeling state machine',
});

Properties

apiEndpointTaskInputapi_endpointTaskInputapiEndpointTaskInputApiEndpointTaskInputApiEndpointTaskInputrequired#

The API endpoint to call, relative to `apiRoot`.

example

sfn.TaskInput.fromText('path/to/resource')

apiRootstringapi_rootstrapiRootStringApiRootstringApiRoot*stringrequired#

Permissions are granted to call all resources under this path.

example

'https://api.example.com'

assign?optional{ [key: string]: any }assign?optionaltyping.Mapping[str, Any]assign?optionalMap<String, Object>Assign?optionalIDictionary<string, object>Assign?optional*map[string]interface{}#

Workflow variables to store in this step.

Default: Not assign variables

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

body?optionalTaskInputbody?optionalTaskInputbody?optionalTaskInputBody?optionalTaskInputBody?optionalTaskInput#

The body to send to the HTTP endpoint.

Default: No body is sent with the request.

comment?optionalstringcomment?optionalstrcomment?optionalStringComment?optionalstringComment?optional*string#

A comment describing this state.

Default: No comment

connectionIConnectionconnectionIConnectionconnectionIConnectionConnectionIConnectionConnectionIConnectionrequired#

The EventBridge Connection to use for authentication.

credentials?optionalCredentialscredentials?optionalCredentialscredentials?optionalCredentialsCredentials?optionalCredentialsCredentials?optionalCredentials#

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

Default: None (Task is executed using the State Machine's execution role)

This enables cross-account resource invocations.

headers?optionalTaskInputheaders?optionalTaskInputheaders?optionalTaskInputHeaders?optionalTaskInputHeaders?optionalTaskInput#

The headers to send to the HTTP endpoint.

Default: No additional headers are added to the request.

example

sfn.TaskInput.fromObject({ 'Content-Type': 'application/json' })

heartbeat?optionalDurationheartbeat?optionalDurationheartbeat?optionalDurationHeartbeat?optionalDurationHeartbeat?optionalDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeout?optionalTimeoutheartbeat_timeout?optionalTimeoutheartbeatTimeout?optionalTimeoutHeartbeatTimeout?optionalTimeoutHeartbeatTimeout?optionalTimeout= None#

Timeout for the heartbeat.

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

integrationPattern?optionalIntegrationPatternintegration_pattern?optionalIntegrationPatternintegrationPattern?optionalIntegrationPatternIntegrationPattern?optionalIntegrationPatternIntegrationPattern?optionalIntegrationPattern#

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

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

You can control these AWS services using service integration patterns.

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

methodTaskInputmethodTaskInputmethodTaskInputMethodTaskInputMethodTaskInputrequired#

The HTTP method to use.

example

sfn.TaskInput.fromText('GET')

outputs?optionalanyoutputs?optionalAnyoutputs?optionalObjectOutputs?optionalobjectOutputs?optionalinterface{}#

Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

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.

queryLanguage?optionalQueryLanguagequery_language?optionalQueryLanguagequeryLanguage?optionalQueryLanguageQueryLanguage?optionalQueryLanguageQueryLanguage?optionalQueryLanguage= JSONPath#

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.

queryStringParameters?optionalTaskInputquery_string_parameters?optionalTaskInputqueryStringParameters?optionalTaskInputQueryStringParameters?optionalTaskInputQueryStringParameters?optionalTaskInput#

The query string parameters to send to the HTTP endpoint.

Default: No query string parameters are sent in the request.

stateName?optionalstringstate_name?optionalstrstateName?optionalStringStateName?optionalstringStateName?optional*string#

Optional name for this state.

Default: The construct ID will be used as state name

taskTimeout?optionalTimeouttask_timeout?optionalTimeouttaskTimeout?optionalTimeoutTaskTimeout?optionalTimeoutTaskTimeout?optionalTimeout= None#

Timeout for the task.

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

timeout?optionalDurationtimeout?optionalDurationtimeout?optionalDurationTimeout?optionalDurationTimeout?optionalDuration= Nonedeprecated#

use `taskTimeout`

urlEncodingFormat?optionalURLEncodingFormaturl_encoding_format?optionalURLEncodingFormaturlEncodingFormat?optionalURLEncodingFormatUrlEncodingFormat?optionalURLEncodingFormatUrlEncodingFormat?optionalURLEncodingFormat= URLEncodingFormat.NONE#

Determines whether to apply URL encoding to the request body, and which array encoding format to use.

notes

URLEncodingFormat.NONE passes the JSON-serialized RequestBody field as the HTTP request body. Otherwise, the HTTP request body is the URL-encoded form data of the RequestBody field using the specified array encoding format, and the Content-Type header is set to application/x-www-form-urlencoded.