DynamoDeleteItemProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.DynamoDeleteItemProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, key, 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:
aws_cdk.aws_stepfunctions.TaskStateBasePropsProperties for DynamoDeleteItem Task.
- Parameters
comment (
Optional[str]) – An optional description for this state. Default: - No commentheartbeat (
Optional[Duration]) – Timeout for the heartbeat. Default: - Noneinput_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_RESPONSEfor most tasks.IntegrationPattern.RUN_JOBfor the following exceptions:BatchSubmitJob,EmrAddStep,EmrCreateCluster,EmrTerminationCluster, andEmrContainersStartJobRun.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: - Nonetimeout (
Optional[Duration]) – Timeout for the state machine. Default: - Nonekey (
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.condition_expression (
Optional[str]) – A condition that must be satisfied in order for a conditional DeleteItem to succeed. Default: - No condition expressionexpression_attribute_names (
Optional[Mapping[str,str]]) – One or more substitution tokens for attribute names in an expression. Default: - No expression attribute namesexpression_attribute_values (
Optional[Mapping[str,DynamoAttributeValue]]) – One or more values that can be substituted in an expression. Default: - No expression attribute valuesreturn_consumed_capacity (
Optional[DynamoConsumedCapacity]) – Determines the level of detail about provisioned throughput consumption that is returned in the response. Default: DynamoConsumedCapacity.NONEreturn_item_collection_metrics (
Optional[DynamoItemCollectionMetrics]) – Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned. Default: DynamoItemCollectionMetrics.NONEreturn_values (
Optional[DynamoReturnValues]) – Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. Default: DynamoReturnValues.NONE
- ExampleMetadata
infused
Example:
# my_table: dynamodb.Table tasks.DynamoDeleteItem(self, "DeleteItem", key={"MessageId": tasks.DynamoAttributeValue.from_string("message-007")}, table=my_table, result_path=sfn.JsonPath.DISCARD )
Attributes
-
comment¶ An optional description for this state.
- Default
No comment
- Return type
Optional[str]
-
condition_expression¶ A condition that must be satisfied in order for a conditional DeleteItem to succeed.
- Default
No condition expression
- See
- Return type
Optional[str]
-
expression_attribute_names¶ One or more substitution tokens for attribute names in an expression.
- Default
No expression attribute names
- See
- Return type
Optional[Mapping[str,str]]
-
expression_attribute_values¶ One or more values that can be substituted in an expression.
- Default
No expression attribute values
- See
- Return type
Optional[Mapping[str,DynamoAttributeValue]]
-
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 ‘$’)
- Return type
Optional[str]
-
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_RESPONSEfor most tasks.
IntegrationPattern.RUN_JOBfor the following exceptions:BatchSubmitJob,EmrAddStep,EmrCreateCluster,EmrTerminationCluster, andEmrContainersStartJobRun.
-
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
- Return type
Mapping[str,DynamoAttributeValue]
-
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 ‘$’)
- Return type
Optional[str]
-
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 ‘$’)
- Return type
Optional[str]
-
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
- Return type
Optional[Mapping[str,Any]]
-
return_consumed_capacity¶ Determines the level of detail about provisioned throughput consumption that is returned in the response.
- Default
DynamoConsumedCapacity.NONE
- See
- Return type
Optional[DynamoConsumedCapacity]
-
return_item_collection_metrics¶ Determines whether item collection metrics are returned.
If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.
- Default
DynamoItemCollectionMetrics.NONE
- Return type
Optional[DynamoItemCollectionMetrics]
-
return_values¶ Use ReturnValues if you want to get the item attributes as they appeared before they were deleted.
- Default
DynamoReturnValues.NONE
- See
- Return type
Optional[DynamoReturnValues]