DynamoPutItemProps

class aws_cdk.aws_stepfunctions_tasks.DynamoPutItemProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, item, table, condition_expression=None, expression_attribute_names=None, expression_attribute_values=None, return_consumed_capacity=None, return_item_collection_metrics=None, return_values=None)

Bases: TaskStateBaseProps

Properties for DynamoPutItem Task.

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

  • item (Mapping[str, DynamoAttributeValue]) – A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

  • table (ITable) – The name of the table where the item should be written .

  • condition_expression (Optional[str]) – A condition that must be satisfied in order for a conditional PutItem operation to succeed. Default: - No condition expression

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

  • expression_attribute_values (Optional[Mapping[str, DynamoAttributeValue]]) – One or more values that can be substituted in an expression. Default: - No expression attribute values

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

  • return_item_collection_metrics (Optional[DynamoItemCollectionMetrics]) – The item collection metrics to returned in the response. Default: DynamoItemCollectionMetrics.NONE

  • return_values (Optional[DynamoReturnValues]) – Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. Default: DynamoReturnValues.NONE

ExampleMetadata:

infused

Example:

# my_table: dynamodb.Table

tasks.DynamoPutItem(self, "PutItem",
    item={
        "MessageId": tasks.DynamoAttributeValue.from_string("message-id")
    },
    table=my_table,
    result_path="$.Item"
)

Attributes

comment

An optional description for this state.

Default:

  • No comment

condition_expression

A condition that must be satisfied in order for a conditional PutItem operation to succeed.

Default:

  • No condition expression

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ConditionExpression

expression_attribute_names

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

Default:

  • No expression attribute names

See:

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

expression_attribute_values

One or more values that can be substituted in an expression.

Default:

  • No expression attribute values

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ExpressionAttributeValues

heartbeat

Timeout for the heartbeat.

Default:

  • None

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

item

A map of attribute name/value pairs, one for each attribute.

Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-Item

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

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

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_PutItem.html#DDB-PutItem-request-ReturnConsumedCapacity

return_item_collection_metrics

The item collection metrics to returned in the response.

Default:

DynamoItemCollectionMetrics.NONE

See:

https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LSI.html#LSI.ItemCollections

return_values

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request.

Default:

DynamoReturnValues.NONE

See:

https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html#DDB-PutItem-request-ReturnValues

table

The name of the table where the item should be written .

timeout

Timeout for the state machine.

Default:

  • None