SageMakerCreateModelProps

class aws_cdk.aws_stepfunctions_tasks.SageMakerCreateModelProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, model_name, primary_container, containers=None, enable_network_isolation=None, role=None, subnet_selection=None, tags=None, vpc=None)

Bases: aws_cdk.aws_stepfunctions.TaskStateBaseProps

Properties for creating an Amazon SageMaker model.

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

  • 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

  • model_name (str) – The name of the new model.

  • primary_container (IContainerDefinition) – The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

  • containers (Optional[Sequence[IContainerDefinition]]) – Specifies the containers in the inference pipeline. Default: - None

  • enable_network_isolation (Optional[bool]) – Isolates the model container. No inbound or outbound network calls can be made to or from the model container. Default: false

  • role (Optional[IRole]) – An execution role that you can pass in a CreateModel API request. Default: - a role will be created.

  • subnet_selection (Optional[SubnetSelection]) – The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided). Default: - Private Subnets are selected

  • tags (Optional[TaskInput]) – Tags to be applied to the model. Default: - No tags

  • vpc (Optional[IVpc]) – The VPC that is accessible by the hosted model. Default: - None

See

https://docs.aws.amazon.com/step-functions/latest/dg/connect-sagemaker.html

Example:

tasks.SageMakerCreateModel(self, "Sagemaker",
    model_name="MyModel",
    primary_container=tasks.ContainerDefinition(
        image=tasks.DockerImage.from_json_expression(sfn.JsonPath.string_at("$.Model.imageName")),
        mode=tasks.Mode.SINGLE_MODEL,
        model_s3_location=tasks.S3Location.from_json_expression("$.TrainingJob.ModelArtifacts.S3ModelArtifacts")
    )
)

Attributes

comment

An optional description for this state.

Default

  • No comment

Return type

Optional[str]

containers

Specifies the containers in the inference pipeline.

Default

  • None

Return type

Optional[List[IContainerDefinition]]

enable_network_isolation

Isolates the model container.

No inbound or outbound network calls can be made to or from the model container.

Default

false

Return type

Optional[bool]

heartbeat

Timeout for the heartbeat.

Default

  • None

Return type

Optional[Duration]

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]

model_name

The name of the new model.

Return type

str

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]

primary_container

The definition of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

Return type

IContainerDefinition

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

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

Return type

Optional[Mapping[str, Any]]

role

An execution role that you can pass in a CreateModel API request.

Default

  • a role will be created.

Return type

Optional[IRole]

subnet_selection

The subnets of the VPC to which the hosted model is connected (Note this parameter is only used when VPC is provided).

Default

  • Private Subnets are selected

Return type

Optional[SubnetSelection]

tags

Tags to be applied to the model.

Default

  • No tags

Return type

Optional[TaskInput]

timeout

Timeout for the state machine.

Default

  • None

Return type

Optional[Duration]

vpc

The VPC that is accessible by the hosted model.

Default

  • None

Return type

Optional[IVpc]