DynamoGetItemJsonataProps

class aws_cdk.aws_stepfunctions_tasks.DynamoGetItemJsonataProps(*, 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, key, table, consistent_read=None, expression_attribute_names=None, projection_expression=None, return_consumed_capacity=None)

Bases: TaskStateJsonataBaseProps

Properties for DynamoGetItem Task 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

  • key (Mapping[str, DynamoAttributeValue]) – Primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • table (ITable) – The name of the table containing the requested item.

  • consistent_read (Optional[bool]) – Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads. Default: false

  • expression_attribute_names (Optional[Mapping[str, str]]) – One or more substitution tokens for attribute names in an expression. Default: - No expression attributes

  • projection_expression (Optional[Sequence[DynamoProjectionExpression]]) – An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. Default: - No projection expression

  • return_consumed_capacity (Optional[DynamoConsumedCapacity]) – Determines the level of detail about provisioned throughput consumption that is returned in the response. Default: DynamoConsumedCapacity.NONE

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_dynamodb as dynamodb
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# assign: Any
# dynamo_attribute_value: stepfunctions_tasks.DynamoAttributeValue
# dynamo_projection_expression: stepfunctions_tasks.DynamoProjectionExpression
# outputs: Any
# table: dynamodb.Table
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

dynamo_get_item_jsonata_props = stepfunctions_tasks.DynamoGetItemJsonataProps(
    key={
        "key_key": dynamo_attribute_value
    },
    table=table,

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    consistent_read=False,
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    expression_attribute_names={
        "expression_attribute_names_key": "expressionAttributeNames"
    },
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    outputs=outputs,
    projection_expression=[dynamo_projection_expression],
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    return_consumed_capacity=stepfunctions_tasks.DynamoConsumedCapacity.INDEXES,
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)

Attributes

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

consistent_read

If set to true, then the operation uses strongly consistent reads;

otherwise, the operation uses eventually consistent reads.

Default:

false

Type:

Determines the read consistency model

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

expression_attribute_names

One or more substitution tokens for attribute names in an expression.

Default:

  • No expression attributes

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ExpressionAttributeNames

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

key

Primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-Key

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

projection_expression

An array of DynamoProjectionExpression that identifies one or more attributes to retrieve from the table.

These attributes can include scalars, sets, or elements of a JSON document.

Default:

  • No projection expression

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ProjectionExpression

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

return_consumed_capacity

Determines the level of detail about provisioned throughput consumption that is returned in the response.

Default:

DynamoConsumedCapacity.NONE

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html#DDB-GetItem-request-ReturnConsumedCapacity

state_name

Optional name for this state.

Default:

  • The construct ID will be used as state name

table

The name of the table containing the requested item.

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