CfnTransformJobPropsMixin

class aws_cdk.cfn_property_mixins.aws_sagemaker.CfnTransformJobPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource type definition for AWS::SageMaker::TransformJob.

A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-transformjob.html

CloudformationResource:

AWS::SageMaker::TransformJob

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_transform_job_props_mixin = sagemaker.CfnTransformJobPropsMixin(sagemaker.CfnTransformJobMixinProps(
    batch_strategy="batchStrategy",
    data_capture_config=sagemaker.CfnTransformJobPropsMixin.DataCaptureConfigProperty(
        destination_s3_uri="destinationS3Uri",
        generate_inference_id=False,
        kms_key_id="kmsKeyId"
    ),
    data_processing=sagemaker.CfnTransformJobPropsMixin.DataProcessingProperty(
        input_filter="inputFilter",
        join_source="joinSource",
        output_filter="outputFilter"
    ),
    environment={
        "environment_key": "environment"
    },
    experiment_config=sagemaker.CfnTransformJobPropsMixin.ExperimentConfigProperty(
        experiment_name="experimentName",
        trial_component_display_name="trialComponentDisplayName",
        trial_name="trialName"
    ),
    max_concurrent_transforms=123,
    max_payload_in_mb=123,
    model_client_config=sagemaker.CfnTransformJobPropsMixin.ModelClientConfigProperty(
        invocations_max_retries=123,
        invocations_timeout_in_seconds=123
    ),
    model_name="modelName",
    tags=[sagemaker.CfnTransformJobPropsMixin.TagsItemsProperty(
        key="key",
        value="value"
    )],
    transform_input=sagemaker.CfnTransformJobPropsMixin.TransformInputProperty(
        compression_type="compressionType",
        content_type="contentType",
        data_source=sagemaker.CfnTransformJobPropsMixin.DataSourceProperty(
            s3_data_source=sagemaker.CfnTransformJobPropsMixin.S3DataSourceProperty(
                s3_data_type="s3DataType",
                s3_uri="s3Uri"
            )
        ),
        split_type="splitType"
    ),
    transform_output=sagemaker.CfnTransformJobPropsMixin.TransformOutputProperty(
        accept="accept",
        assemble_with="assembleWith",
        kms_key_id="kmsKeyId",
        s3_output_path="s3OutputPath"
    ),
    transform_resources=sagemaker.CfnTransformJobPropsMixin.TransformResourcesProperty(
        instance_count=123,
        instance_type="instanceType",
        volume_kms_key_id="volumeKmsKeyId"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::SageMaker::TransformJob.

Parameters:

  • props (Union[CfnTransformJobMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['batchStrategy', 'dataCaptureConfig', 'dataProcessing', 'environment', 'experimentConfig', 'maxConcurrentTransforms', 'maxPayloadInMb', 'modelClientConfig', 'modelName', 'tags', 'transformInput', 'transformOutput', 'transformResources']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

DataCaptureConfigProperty

class CfnTransformJobPropsMixin.DataCaptureConfigProperty(*, destination_s3_uri=None, generate_inference_id=None, kms_key_id=None)

Bases: object

Configuration to control how SageMaker captures inference data.

Parameters:

  • destination_s3_uri (Optional[str]) – The Amazon S3 location being used to capture the data.

  • generate_inference_id (Union[bool, IResolvable, None]) – Flag that indicates whether to append inference id to the output.

  • kms_key_id (Optional[str]) – The ARN of a KMS key that SageMaker uses to encrypt data on the storage volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-datacaptureconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

data_capture_config_property = sagemaker.CfnTransformJobPropsMixin.DataCaptureConfigProperty(
    destination_s3_uri="destinationS3Uri",
    generate_inference_id=False,
    kms_key_id="kmsKeyId"
)

Attributes

destination_s3_uri

The Amazon S3 location being used to capture the data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-datacaptureconfig.html#cfn-sagemaker-transformjob-datacaptureconfig-destinations3uri

generate_inference_id

Flag that indicates whether to append inference id to the output.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-datacaptureconfig.html#cfn-sagemaker-transformjob-datacaptureconfig-generateinferenceid

kms_key_id

The ARN of a KMS key that SageMaker uses to encrypt data on the storage volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-datacaptureconfig.html#cfn-sagemaker-transformjob-datacaptureconfig-kmskeyid

DataProcessingProperty

class CfnTransformJobPropsMixin.DataProcessingProperty(*, input_filter=None, join_source=None, output_filter=None)

Bases: object

The data structure used to specify the data to be used for inference in a batch transform job.

Parameters:

  • input_filter (Optional[str]) – A JSONPath expression used to select a portion of the input data to pass to the algorithm.

  • join_source (Optional[str]) – Specifies the source of the data to join with the transformed data.

  • output_filter (Optional[str]) – A JSONPath expression used to select a portion of the joined dataset to save in the output file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-dataprocessing.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

data_processing_property = sagemaker.CfnTransformJobPropsMixin.DataProcessingProperty(
    input_filter="inputFilter",
    join_source="joinSource",
    output_filter="outputFilter"
)

Attributes

input_filter

A JSONPath expression used to select a portion of the input data to pass to the algorithm.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-dataprocessing.html#cfn-sagemaker-transformjob-dataprocessing-inputfilter

join_source

Specifies the source of the data to join with the transformed data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-dataprocessing.html#cfn-sagemaker-transformjob-dataprocessing-joinsource

output_filter

A JSONPath expression used to select a portion of the joined dataset to save in the output file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-dataprocessing.html#cfn-sagemaker-transformjob-dataprocessing-outputfilter

DataSourceProperty

class CfnTransformJobPropsMixin.DataSourceProperty(*, s3_data_source=None)

Bases: object

Describes the location of the channel data.

Parameters:

s3_data_source (Union[IResolvable, S3DataSourceProperty, Dict[str, Any], None]) – The S3 location of the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-datasource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

data_source_property = sagemaker.CfnTransformJobPropsMixin.DataSourceProperty(
    s3_data_source=sagemaker.CfnTransformJobPropsMixin.S3DataSourceProperty(
        s3_data_type="s3DataType",
        s3_uri="s3Uri"
    )
)

Attributes

s3_data_source

The S3 location of the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-datasource.html#cfn-sagemaker-transformjob-datasource-s3datasource

ExperimentConfigProperty

class CfnTransformJobPropsMixin.ExperimentConfigProperty(*, experiment_name=None, trial_component_display_name=None, trial_name=None)

Bases: object

Associates a SageMaker job as a trial component with an experiment and trial.

Parameters:

  • experiment_name (Optional[str]) – The name of an existing experiment to associate with the trial component.

  • trial_component_display_name (Optional[str]) – The display name for the trial component.

  • trial_name (Optional[str]) – The name of an existing trial to associate the trial component with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-experimentconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

experiment_config_property = sagemaker.CfnTransformJobPropsMixin.ExperimentConfigProperty(
    experiment_name="experimentName",
    trial_component_display_name="trialComponentDisplayName",
    trial_name="trialName"
)

Attributes

experiment_name

The name of an existing experiment to associate with the trial component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-experimentconfig.html#cfn-sagemaker-transformjob-experimentconfig-experimentname

trial_component_display_name

The display name for the trial component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-experimentconfig.html#cfn-sagemaker-transformjob-experimentconfig-trialcomponentdisplayname

trial_name

The name of an existing trial to associate the trial component with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-experimentconfig.html#cfn-sagemaker-transformjob-experimentconfig-trialname

ModelClientConfigProperty

class CfnTransformJobPropsMixin.ModelClientConfigProperty(*, invocations_max_retries=None, invocations_timeout_in_seconds=None)

Bases: object

Configures the timeout and maximum number of retries for processing a transform job invocation.

Parameters:

  • invocations_max_retries (Union[int, float, None]) – The maximum number of retries when invocation requests are failing.

  • invocations_timeout_in_seconds (Union[int, float, None]) – The timeout value in seconds for an invocation request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-modelclientconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

model_client_config_property = sagemaker.CfnTransformJobPropsMixin.ModelClientConfigProperty(
    invocations_max_retries=123,
    invocations_timeout_in_seconds=123
)

Attributes

invocations_max_retries

The maximum number of retries when invocation requests are failing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-modelclientconfig.html#cfn-sagemaker-transformjob-modelclientconfig-invocationsmaxretries

invocations_timeout_in_seconds

The timeout value in seconds for an invocation request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-modelclientconfig.html#cfn-sagemaker-transformjob-modelclientconfig-invocationstimeoutinseconds

S3DataSourceProperty

class CfnTransformJobPropsMixin.S3DataSourceProperty(*, s3_data_type=None, s3_uri=None)

Bases: object

The S3 location of the data source.

Parameters:

  • s3_data_type (Optional[str]) – The data type.

  • s3_uri (Optional[str]) – The S3 URI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-s3datasource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

s3_data_source_property = sagemaker.CfnTransformJobPropsMixin.S3DataSourceProperty(
    s3_data_type="s3DataType",
    s3_uri="s3Uri"
)

Attributes

s3_data_type

The data type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-s3datasource.html#cfn-sagemaker-transformjob-s3datasource-s3datatype

s3_uri

The S3 URI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-s3datasource.html#cfn-sagemaker-transformjob-s3datasource-s3uri

TagsItemsProperty

class CfnTransformJobPropsMixin.TagsItemsProperty(*, key=None, value=None)

Bases: object

Parameters:

  • key (Optional[str]) – The tag key.

  • value (Optional[str]) – The tag value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-tagsitems.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

tags_items_property = sagemaker.CfnTransformJobPropsMixin.TagsItemsProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-tagsitems.html#cfn-sagemaker-transformjob-tagsitems-key

value

The tag value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-tagsitems.html#cfn-sagemaker-transformjob-tagsitems-value

TransformInputProperty

class CfnTransformJobPropsMixin.TransformInputProperty(*, compression_type=None, content_type=None, data_source=None, split_type=None)

Bases: object

Describes the input source and the way the transform job consumes it.

Parameters:

  • compression_type (Optional[str]) – If your transform data is compressed, specify the compression type.

  • content_type (Optional[str]) – The multipurpose internet mail extension (MIME) type of the data.

  • data_source (Union[IResolvable, DataSourceProperty, Dict[str, Any], None]) – Describes the location of the channel data.

  • split_type (Optional[str]) – The method to use to split the transform job’s data files into smaller batches.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transforminput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

transform_input_property = sagemaker.CfnTransformJobPropsMixin.TransformInputProperty(
    compression_type="compressionType",
    content_type="contentType",
    data_source=sagemaker.CfnTransformJobPropsMixin.DataSourceProperty(
        s3_data_source=sagemaker.CfnTransformJobPropsMixin.S3DataSourceProperty(
            s3_data_type="s3DataType",
            s3_uri="s3Uri"
        )
    ),
    split_type="splitType"
)

Attributes

compression_type

If your transform data is compressed, specify the compression type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transforminput.html#cfn-sagemaker-transformjob-transforminput-compressiontype

content_type

The multipurpose internet mail extension (MIME) type of the data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transforminput.html#cfn-sagemaker-transformjob-transforminput-contenttype

data_source

Describes the location of the channel data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transforminput.html#cfn-sagemaker-transformjob-transforminput-datasource

split_type

The method to use to split the transform job’s data files into smaller batches.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transforminput.html#cfn-sagemaker-transformjob-transforminput-splittype

TransformOutputProperty

class CfnTransformJobPropsMixin.TransformOutputProperty(*, accept=None, assemble_with=None, kms_key_id=None, s3_output_path=None)

Bases: object

Describes the results of the transform job.

Parameters:

  • accept (Optional[str]) – The MIME type used to specify the output data.

  • assemble_with (Optional[str]) – Defines how to assemble the results of the transform job as a single S3 object.

  • kms_key_id (Optional[str]) – The AWS KMS key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

  • s3_output_path (Optional[str]) – The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformoutput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

transform_output_property = sagemaker.CfnTransformJobPropsMixin.TransformOutputProperty(
    accept="accept",
    assemble_with="assembleWith",
    kms_key_id="kmsKeyId",
    s3_output_path="s3OutputPath"
)

Attributes

accept

The MIME type used to specify the output data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformoutput.html#cfn-sagemaker-transformjob-transformoutput-accept

assemble_with

Defines how to assemble the results of the transform job as a single S3 object.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformoutput.html#cfn-sagemaker-transformjob-transformoutput-assemblewith

kms_key_id

The AWS KMS key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformoutput.html#cfn-sagemaker-transformjob-transformoutput-kmskeyid

s3_output_path

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformoutput.html#cfn-sagemaker-transformjob-transformoutput-s3outputpath

TransformResourcesProperty

class CfnTransformJobPropsMixin.TransformResourcesProperty(*, instance_count=None, instance_type=None, volume_kms_key_id=None)

Bases: object

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Parameters:

  • instance_count (Union[int, float, None]) – The number of ML compute instances to use in the transform job.

  • instance_type (Optional[str]) – The ML compute instance type for the transform job.

  • volume_kms_key_id (Optional[str]) – The AWS KMS key that Amazon SageMaker uses to encrypt model data on the storage volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformresources.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_sagemaker as sagemaker

transform_resources_property = sagemaker.CfnTransformJobPropsMixin.TransformResourcesProperty(
    instance_count=123,
    instance_type="instanceType",
    volume_kms_key_id="volumeKmsKeyId"
)

Attributes

instance_count

The number of ML compute instances to use in the transform job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformresources.html#cfn-sagemaker-transformjob-transformresources-instancecount

instance_type

The ML compute instance type for the transform job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformresources.html#cfn-sagemaker-transformjob-transformresources-instancetype

volume_kms_key_id

The AWS KMS key that Amazon SageMaker uses to encrypt model data on the storage volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-transformjob-transformresources.html#cfn-sagemaker-transformjob-transformresources-volumekmskeyid