CfnTrialComponentPropsMixin

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

Bases: Mixin

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

A trial component is a stage of a machine learning trial, such as a preprocessing job, training job, or batch transform job.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-trialcomponent.html
CloudformationResource:: AWS::SageMaker::TrialComponent
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_trial_component_props_mixin = sagemaker.CfnTrialComponentPropsMixin(sagemaker.CfnTrialComponentMixinProps(
    display_name="displayName",
    input_artifacts={
        "input_artifacts_key": sagemaker.CfnTrialComponentPropsMixin.TrialComponentArtifactProperty(
            media_type="mediaType",
            value="value"
        )
    },
    metadata_properties=sagemaker.CfnTrialComponentPropsMixin.MetadataPropertiesProperty(
        commit_id="commitId",
        generated_by="generatedBy",
        project_id="projectId",
        repository="repository"
    ),
    output_artifacts={
        "output_artifacts_key": sagemaker.CfnTrialComponentPropsMixin.TrialComponentArtifactProperty(
            media_type="mediaType",
            value="value"
        )
    },
    parameters={
        "parameters_key": sagemaker.CfnTrialComponentPropsMixin.TrialComponentParameterValueProperty(
            number_value=123,
            string_value="stringValue"
        )
    },
    status=sagemaker.CfnTrialComponentPropsMixin.TrialComponentStatusProperty(
        message="message",
        primary_status="primaryStatus"
    ),
    tags=[sagemaker.CfnTrialComponentPropsMixin.TagsItemsProperty(
        key="key",
        value="value"
    )],
    trial_component_name="trialComponentName"
),
    strategy=merge_strategy
)

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

Parameters:

props (Union[CfnTrialComponentMixinProps, 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 = ['displayName', 'inputArtifacts', 'metadataProperties', 'outputArtifacts', 'parameters', 'status', 'tags', 'trialComponentName']

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.

MetadataPropertiesProperty

class CfnTrialComponentPropsMixin.MetadataPropertiesProperty(*, commit_id=None, generated_by=None, project_id=None, repository=None)

Bases: object

Metadata properties of the tracking entity, trial, or trial component.

Parameters:

commit_id (Optional[str]) – The commit ID.
generated_by (Optional[str]) – The entity this entity was generated by.
project_id (Optional[str]) – The project ID.
repository (Optional[str]) – The repository.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-metadataproperties.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

metadata_properties_property = sagemaker.CfnTrialComponentPropsMixin.MetadataPropertiesProperty(
    commit_id="commitId",
    generated_by="generatedBy",
    project_id="projectId",
    repository="repository"
)

Attributes

commit_id

The commit ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-metadataproperties.html#cfn-sagemaker-trialcomponent-metadataproperties-commitid

generated_by

The entity this entity was generated by.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-metadataproperties.html#cfn-sagemaker-trialcomponent-metadataproperties-generatedby

project_id

The project ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-metadataproperties.html#cfn-sagemaker-trialcomponent-metadataproperties-projectid

repository

The repository.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-metadataproperties.html#cfn-sagemaker-trialcomponent-metadataproperties-repository

TagsItemsProperty

class CfnTrialComponentPropsMixin.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-trialcomponent-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.CfnTrialComponentPropsMixin.TagsItemsProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key.

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

value

The tag value.

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

TrialComponentArtifactProperty

class CfnTrialComponentPropsMixin.TrialComponentArtifactProperty(*, media_type=None, value=None)

Bases: object

Represents an input or output artifact of a trial component.

Parameters:

media_type (Optional[str]) – The media type of the artifact.
value (Optional[str]) – The location of the artifact.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentartifact.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

trial_component_artifact_property = sagemaker.CfnTrialComponentPropsMixin.TrialComponentArtifactProperty(
    media_type="mediaType",
    value="value"
)

Attributes

media_type

The media type of the artifact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentartifact.html#cfn-sagemaker-trialcomponent-trialcomponentartifact-mediatype

value

The location of the artifact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentartifact.html#cfn-sagemaker-trialcomponent-trialcomponentartifact-value

TrialComponentParameterValueProperty

class CfnTrialComponentPropsMixin.TrialComponentParameterValueProperty(*, number_value=None, string_value=None)

Bases: object

The value of a hyperparameter.

Only one of StringValue or NumberValue can be specified.

Parameters:

number_value (Union[int, float, None]) – The numeric value of a numeric hyperparameter.
string_value (Optional[str]) – The string value of a categorical hyperparameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentparametervalue.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

trial_component_parameter_value_property = sagemaker.CfnTrialComponentPropsMixin.TrialComponentParameterValueProperty(
    number_value=123,
    string_value="stringValue"
)

Attributes

number_value

The numeric value of a numeric hyperparameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentparametervalue.html#cfn-sagemaker-trialcomponent-trialcomponentparametervalue-numbervalue

string_value

The string value of a categorical hyperparameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentparametervalue.html#cfn-sagemaker-trialcomponent-trialcomponentparametervalue-stringvalue

TrialComponentStatusProperty

class CfnTrialComponentPropsMixin.TrialComponentStatusProperty(*, message=None, primary_status=None)

Bases: object

The status of the trial component.

Parameters:

message (Optional[str]) – If the component failed, a message describing why.
primary_status (Optional[str]) – The status of the trial component.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentstatus.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

trial_component_status_property = sagemaker.CfnTrialComponentPropsMixin.TrialComponentStatusProperty(
    message="message",
    primary_status="primaryStatus"
)

Attributes

message

If the component failed, a message describing why.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentstatus.html#cfn-sagemaker-trialcomponent-trialcomponentstatus-message

primary_status

The status of the trial component.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-trialcomponent-trialcomponentstatus.html#cfn-sagemaker-trialcomponent-trialcomponentstatus-primarystatus