CallAwsServiceJsonPathProps

class aws_cdk.aws_stepfunctions_tasks.CallAwsServiceJsonPathProps(*, 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, input_path=None, output_path=None, result_path=None, result_selector=None, action, iam_resources, service, additional_iam_statements=None, iam_action=None, parameters=None)

Bases: TaskStateJsonPathBaseProps

Properties for calling an AWS service’s API action using JSONPath from your state machine.

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
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: $
output_path (Optional[str]) – 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 {}. Default: $
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: $
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
action (str) – The API action to call. Use camelCase.
iam_resources (Sequence[str]) – The resources for the IAM statement that will be added to the state machine role’s policy to allow the state machine to make the API call. By default the action for this IAM statement will be service:action.
service (str) – The AWS service to call.
additional_iam_statements (Optional[Sequence[PolicyStatement]]) – Additional IAM statements that will be added to the state machine role’s policy. Use in the case where the call requires more than a single statement to be executed, e.g. rekognition:detectLabels requires also S3 permissions to read the object on which it must act. Default: - no additional statements are added
iam_action (Optional[str]) – The action for the IAM statement that will be added to the state machine role’s policy to allow the state machine to make the API call. Use in the case where the IAM action name does not match with the API service/action name, e.g. s3:ListBuckets requires s3:ListAllMyBuckets. Default: - service:action
parameters (Optional[Mapping[str, Any]]) – Parameters for the API action call. Use PascalCase for the parameter names. Default: - no parameters

See:

https://docs.aws.amazon.com/step-functions/latest/dg/supported-services-awssdk.html

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 as cdk
from aws_cdk import aws_iam as iam
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# assign: Any
# parameters: Any
# policy_statement: iam.PolicyStatement
# result_selector: Any
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

call_aws_service_json_path_props = stepfunctions_tasks.CallAwsServiceJsonPathProps(
    action="action",
    iam_resources=["iamResources"],
    service="service",

    # the properties below are optional
    additional_iam_statements=[policy_statement],
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    iam_action="iamAction",
    input_path="inputPath",
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    output_path="outputPath",
    parameters={
        "parameters_key": parameters
    },
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)

Attributes

action

The API action to call.

Use camelCase.

additional_iam_statements

Additional IAM statements that will be added to the state machine role’s policy.

Use in the case where the call requires more than a single statement to be executed, e.g. rekognition:detectLabels requires also S3 permissions to read the object on which it must act.

Default:

no additional statements are added

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

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

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

iam_action

The action for the IAM statement that will be added to the state machine role’s policy to allow the state machine to make the API call.

Use in the case where the IAM action name does not match with the API service/action name, e.g. s3:ListBuckets requires s3:ListAllMyBuckets.

Default:

service:action

iam_resources

The resources for the IAM statement that will be added to the state machine role’s policy to allow the state machine to make the API call.

By default the action for this IAM statement will be service:action.

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:: $

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

output_path

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 {}.

Default:: $

parameters

Parameters for the API action call.

Use PascalCase for the parameter names.

Default:

no parameters

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

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:: $

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

service

The AWS service to call.

See:: https://docs.aws.amazon.com/step-functions/latest/dg/supported-services-awssdk.html

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