CallAwsServiceProps

class aws_cdk.aws_stepfunctions_tasks.CallAwsServiceProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, action, iam_resources, service, iam_action=None, parameters=None)

Bases: TaskStateBaseProps

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

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

infused

Example:

# my_bucket: s3.Bucket

get_object = tasks.CallAwsService(self, "GetObject",
    service="s3",
    action="getObject",
    parameters={
        "Bucket": my_bucket.bucket_name,
        "Key": sfn.JsonPath.string_at("$.key")
    },
    iam_resources=[my_bucket.arn_for_objects("*")]
)

Attributes

action

The API action to call.

Use camelCase.

comment

An optional description for this state.

Default:

No comment

heartbeat

Timeout for the heartbeat.

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:

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

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

parameters

Parameters for the API action call.

Use PascalCase for the parameter names.

Default:

no parameters

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

service

The AWS service to call.

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

timeout

Timeout for the state machine.

Default:

None