# HttpInvokeJsonPathProps

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

Extends: HttpInvokeJsonPathProps
Extends: TaskStateJsonPathBaseProps

- Source: [`aws-stepfunctions-tasks/lib/http/invoke.ts`](https://github.com/aws/aws-cdk/blob/v2.273.0/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/http/invoke.ts#L124)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_events as events } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const connection: events.Connection;
declare const resultSelector: any;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const httpInvokeJsonPathProps: stepfunctions_tasks.HttpInvokeJsonPathProps = {
  apiEndpoint: taskInput,
  apiRoot: 'apiRoot',
  connection: connection,
  method: taskInput,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  body: taskInput,
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  headers: taskInput,
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  queryStringParameters: taskInput,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
  urlEncodingFormat: stepfunctions_tasks.URLEncodingFormat.BRACKETS,
};
```

## Properties

- `apiEndpoint`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) (required) — The API endpoint to call, relative to `apiRoot`.

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

- `apiRoot`: string (required) — Permissions are granted to call all resources under this path.

  ```ts
  'https://api.example.com'
  ```

- `assign`: { [key: string]: any } = Not assign variables — Workflow variables to store in this step.

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

- `body`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) = No body is sent with the request. — The body to send to the HTTP endpoint.

  **Default:** No body is sent with the request.

- `comment`: string = No comment — A comment describing this state.

- `connection`: [IConnection](/cdk/api/v2/docs/aws-cdk-lib.aws_events.IConnection.html) (required) — The EventBridge Connection to use for authentication.

- `credentials`: [Credentials](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Credentials.html) = None (Task is executed using the State Machine's execution role) — 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)

- `headers`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) = No additional headers are added to the request. — The headers to send to the HTTP endpoint.

  **Default:** No additional headers are added to the request.

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

- `heartbeat`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `heartbeatTimeout`

- `heartbeatTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the heartbeat.

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

- `inputPath`: string = $ — 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 {}.

- `integrationPattern`: [IntegrationPattern](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.IntegrationPattern.html) = `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`. — 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`.

- `method`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) (required) — The HTTP method to use.

  ```ts
  sfn.TaskInput.fromText('GET')
  ```

- `outputPath`: string = $ — JSONPath expression to select part of the state to be the output to this state.

  May also be the special value JsonPath.DISCARD, which will cause the effective
  output to be the empty object {}.

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = 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`: [TaskInput](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.TaskInput.html) = No query string parameters are sent in the request. — The query string parameters to send to the HTTP endpoint.

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

- `resultPath`: string = $ — 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.

- `resultSelector`: { [key: string]: any } = None — 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.

- `stateName`: string = The construct ID will be used as state name — Optional name for this state.

  **Default:** The construct ID will be used as state name

- `taskTimeout`: [Timeout](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.Timeout.html) = None — Timeout for the task.

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

- `timeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) = None — use `taskTimeout`

- `urlEncodingFormat`: [URLEncodingFormat](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions_tasks.URLEncodingFormat.html) = URLEncodingFormat.NONE — Determines whether to apply URL encoding to the request body, and which array encoding format to use.

  `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`.