SageMakerCreateEndpointProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
SageMakerCreateEndpointProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, endpoint_config_name, endpoint_name, tags=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
(experimental) Properties for creating an Amazon SageMaker endpoint.
- 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_RESPONSEoutput_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 ‘$’)timeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Noneendpoint_config_name (
str
) – (experimental) The name of an endpoint configuration.endpoint_name (
str
) – (experimental) The name of the endpoint. The name must be unique within an AWS Region in your AWS account.tags (
Optional
[TaskInput
]) – (experimental) Tags to be applied to the endpoint. Default: - No tags
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html
- Stability
experimental
Attributes
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
endpoint_config_name
¶ (experimental) The name of an endpoint configuration.
- Stability
experimental
- Return type
str
-
endpoint_name
¶ (experimental) The name of the endpoint.
The name must be unique within an AWS Region in your AWS account.
- Stability
experimental
- Return type
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
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
- Return type
Optional
[IntegrationPattern
]
-
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
]
(experimental) Tags to be applied to the endpoint.
- Default
No tags
- Stability
experimental
- Return type
Optional
[TaskInput
]