Class: Aws::SageMaker::Types::CreatePipelineRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreatePipelineRequest

Defined in:

gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation.

• #parallelism_configuration ⇒ Types::ParallelismConfiguration

  This is the configuration that controls the parallelism of the pipeline.

• #pipeline_definition ⇒ String

  The [JSON pipeline definition][1] of the pipeline.

• #pipeline_definition_s3_location ⇒ Types::PipelineDefinitionS3Location

  The location of the pipeline definition stored in Amazon S3.

• #pipeline_description ⇒ String

  A description of the pipeline.

• #pipeline_display_name ⇒ String

  The display name of the pipeline.

• #pipeline_name ⇒ String

  The name of the pipeline.

• #pipeline_version_aliases ⇒ Array<String>

  The aliases to assign to the first version of the pipeline.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

• #tags ⇒ Array<Types::Tag>

  A list of tags to apply to the created pipeline.

Instance Attribute Details

#client_request_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#parallelism_configuration ⇒ Types::ParallelismConfiguration

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

Returns:

• (Types::ParallelismConfiguration)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_definition ⇒ String

The JSON pipeline definition of the pipeline.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_definition_s3_location ⇒ Types::PipelineDefinitionS3Location

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

Returns:

• (Types::PipelineDefinitionS3Location)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_description ⇒ String

A description of the pipeline.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_display_name ⇒ String

The display name of the pipeline.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_name ⇒ String

The name of the pipeline.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_version_aliases ⇒ Array<String>

The aliases to assign to the first version of the pipeline. You can use an alias instead of a pipeline version ID to start an execution, describe the pipeline, or list its executions. Each alias can contain 1-128 letters, numbers, periods (.), hyphens (-), and underscores (_), and can't consist of numbers only. An alias must be unique within the pipeline, and a version can have up to 10 aliases.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

Returns:

• (String)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags to apply to the created pipeline.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 14097

class CreatePipelineRequest < Struct.new(
  :pipeline_name,
  :pipeline_display_name,
  :pipeline_definition,
  :pipeline_definition_s3_location,
  :pipeline_description,
  :client_request_token,
  :role_arn,
  :tags,
  :parallelism_configuration,
  :pipeline_version_aliases)
  SENSITIVE = []
  include Aws::Structure
end