DynamoGetItemProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
DynamoGetItemProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, key, table, consistent_read=None, expression_attribute_names=None, projection_expression=None, return_consumed_capacity=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
Properties for DynamoGetItem 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_RESPONSE
for most tasks.IntegrationPattern.RUN_JOB
for 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.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: falseexpression_attribute_names (
Optional
[Mapping
[str
,str
]]) – One or more substitution tokens for attribute names in an expression. Default: - No expression attributesprojection_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 expressionreturn_consumed_capacity (
Optional
[DynamoConsumedCapacity
]) – Determines the level of detail about provisioned throughput consumption that is returned in the response. Default: DynamoConsumedCapacity.NONE
- ExampleMetadata
infused
Example:
# my_table: dynamodb.Table tasks.DynamoGetItem(self, "Get Item", key={"message_id": tasks.DynamoAttributeValue.from_string("message-007")}, table=my_table )
Attributes
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
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
- Return type
Optional
[bool
]
-
expression_attribute_names
¶ One or more substitution tokens for attribute names in an expression.
- Default
No expression attributes
- See
- Return type
Optional
[Mapping
[str
,str
]]
-
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_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for 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
]
-
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
- Return type
Optional
[List
[DynamoProjectionExpression
]]
-
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
]