Class: Aws::SageMaker::Types::CreateActionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass CreateActionRequest data as a hash:

{
  action_name: "ExperimentEntityName", # required
  source: { # required
    source_uri: "String2048", # required
    source_type: "String256",
    source_id: "String256",
  },
  action_type: "String256", # required
  description: "ExperimentDescription",
  status: "Unknown", # accepts Unknown, InProgress, Completed, Failed, Stopping, Stopped
  properties: {
    "StringParameterValue" => "StringParameterValue",
  },
  metadata_properties: {
    commit_id: "MetadataPropertyValue",
    repository: "MetadataPropertyValue",
    generated_by: "MetadataPropertyValue",
    project_id: "MetadataPropertyValue",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_nameString

The name of the action. Must be unique to your account in an Amazon Web Services Region.

Returns:

  • (String)


3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#action_typeString

The action type.

Returns:

  • (String)


3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the action.

Returns:

  • (String)


3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_propertiesTypes::MetadataProperties

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



3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#propertiesHash<String,String>

A list of properties to add to the action.

Returns:

  • (Hash<String,String>)


3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#sourceTypes::ActionSource

The source type, ID, and URI.

Returns:



3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the action.

Returns:

  • (String)


3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags to apply to the action.

Returns:



3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3839

class CreateActionRequest < Struct.new(
  :action_name,
  :source,
  :action_type,
  :description,
  :status,
  :properties,
  :metadata_properties,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end