Amazonka.SageMaker.StartPipelineExecution

Starts a pipeline execution.

Creating a Request

data StartPipelineExecution

See: newStartPipelineExecution smart constructor.

Constructors

StartPipelineExecution'

Fields

• parallelismConfiguration :: Maybe ParallelismConfiguration

  This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

• pipelineExecutionDescription :: Maybe Text

  The description of the pipeline execution.

• pipelineExecutionDisplayName :: Maybe Text

  The display name of the pipeline execution.

• pipelineParameters :: Maybe [Parameter]

  Contains a list of pipeline parameters. This list can be empty.

• pipelineName :: Text

  The name of the pipeline.

• clientRequestToken :: Text

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

Instances

ToJSON StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

toJSON :: StartPipelineExecution -> Value

toEncoding :: StartPipelineExecution -> Encoding

toJSONList :: [StartPipelineExecution] -> Value

toEncodingList :: [StartPipelineExecution] -> Encoding

ToHeaders StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

toHeaders :: StartPipelineExecution -> [Header]

ToPath StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

toPath :: StartPipelineExecution -> ByteString

ToQuery StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

toQuery :: StartPipelineExecution -> QueryString

AWSRequest StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Associated Types

type AWSResponse StartPipelineExecution

Methods

request :: (Service -> Service) -> StartPipelineExecution -> Request StartPipelineExecution

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartPipelineExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartPipelineExecution)))

Generic StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Associated Types

type Rep StartPipelineExecution :: Type -> Type

Methods

from :: StartPipelineExecution -> Rep StartPipelineExecution x

to :: Rep StartPipelineExecution x -> StartPipelineExecution

Read StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

readsPrec :: Int -> ReadS StartPipelineExecution

readList :: ReadS [StartPipelineExecution]

readPrec :: ReadPrec StartPipelineExecution

readListPrec :: ReadPrec [StartPipelineExecution]

Show StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

showsPrec :: Int -> StartPipelineExecution -> ShowS

show :: StartPipelineExecution -> String

showList :: [StartPipelineExecution] -> ShowS

NFData StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

rnf :: StartPipelineExecution -> ()

Eq StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

(==) :: StartPipelineExecution -> StartPipelineExecution -> Bool

(/=) :: StartPipelineExecution -> StartPipelineExecution -> Bool

Hashable StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

hashWithSalt :: Int -> StartPipelineExecution -> Int

hash :: StartPipelineExecution -> Int

type AWSResponse StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

type AWSResponse StartPipelineExecution = StartPipelineExecutionResponse

type Rep StartPipelineExecution

Defined in Amazonka.SageMaker.StartPipelineExecution

type Rep StartPipelineExecution = D1 ('MetaData "StartPipelineExecution" "Amazonka.SageMaker.StartPipelineExecution" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "StartPipelineExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "parallelismConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParallelismConfiguration)) :*: (S1 ('MetaSel ('Just "pipelineExecutionDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pipelineExecutionDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "pipelineParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: (S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartPipelineExecution

Arguments

:: Text

StartPipelineExecution

-> Text

$sel:clientRequestToken:StartPipelineExecution'

-> StartPipelineExecution

Create a value of StartPipelineExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartPipelineExecution, startPipelineExecution_parallelismConfiguration - This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

StartPipelineExecution, startPipelineExecution_pipelineExecutionDescription - The description of the pipeline execution.

StartPipelineExecution, startPipelineExecution_pipelineExecutionDisplayName - The display name of the pipeline execution.

StartPipelineExecution, startPipelineExecution_pipelineParameters - Contains a list of pipeline parameters. This list can be empty.

StartPipelineExecution, startPipelineExecution_pipelineName - The name of the pipeline.

$sel:clientRequestToken:StartPipelineExecution', startPipelineExecution_clientRequestToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

Request Lenses

startPipelineExecution_parallelismConfiguration :: Lens' StartPipelineExecution (Maybe ParallelismConfiguration)

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

startPipelineExecution_pipelineExecutionDescription :: Lens' StartPipelineExecution (Maybe Text)

The description of the pipeline execution.

startPipelineExecution_pipelineExecutionDisplayName :: Lens' StartPipelineExecution (Maybe Text)

The display name of the pipeline execution.

startPipelineExecution_pipelineParameters :: Lens' StartPipelineExecution (Maybe [Parameter])

Contains a list of pipeline parameters. This list can be empty.

startPipelineExecution_pipelineName :: Lens' StartPipelineExecution Text

The name of the pipeline.

startPipelineExecution_clientRequestToken :: Lens' StartPipelineExecution Text

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

Destructuring the Response

data StartPipelineExecutionResponse

See: newStartPipelineExecutionResponse smart constructor.

Constructors

StartPipelineExecutionResponse'

Fields

• pipelineExecutionArn :: Maybe Text

  The Amazon Resource Name (ARN) of the pipeline execution.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartPipelineExecutionResponse

Defined in Amazonka.SageMaker.StartPipelineExecution

Associated Types

type Rep StartPipelineExecutionResponse :: Type -> Type

Methods

from :: StartPipelineExecutionResponse -> Rep StartPipelineExecutionResponse x

to :: Rep StartPipelineExecutionResponse x -> StartPipelineExecutionResponse

Read StartPipelineExecutionResponse

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

readsPrec :: Int -> ReadS StartPipelineExecutionResponse

readList :: ReadS [StartPipelineExecutionResponse]

readPrec :: ReadPrec StartPipelineExecutionResponse

readListPrec :: ReadPrec [StartPipelineExecutionResponse]

Show StartPipelineExecutionResponse

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

showsPrec :: Int -> StartPipelineExecutionResponse -> ShowS

show :: StartPipelineExecutionResponse -> String

showList :: [StartPipelineExecutionResponse] -> ShowS

NFData StartPipelineExecutionResponse

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

rnf :: StartPipelineExecutionResponse -> ()

Eq StartPipelineExecutionResponse

Defined in Amazonka.SageMaker.StartPipelineExecution

Methods

(==) :: StartPipelineExecutionResponse -> StartPipelineExecutionResponse -> Bool

(/=) :: StartPipelineExecutionResponse -> StartPipelineExecutionResponse -> Bool

type Rep StartPipelineExecutionResponse

Defined in Amazonka.SageMaker.StartPipelineExecution

type Rep StartPipelineExecutionResponse = D1 ('MetaData "StartPipelineExecutionResponse" "Amazonka.SageMaker.StartPipelineExecution" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "StartPipelineExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartPipelineExecutionResponse

Arguments

:: Int

$sel:httpStatus:StartPipelineExecutionResponse'

-> StartPipelineExecutionResponse

Create a value of StartPipelineExecutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartPipelineExecutionResponse, startPipelineExecutionResponse_pipelineExecutionArn - The Amazon Resource Name (ARN) of the pipeline execution.

$sel:httpStatus:StartPipelineExecutionResponse', startPipelineExecutionResponse_httpStatus - The response's http status code.

Response Lenses

startPipelineExecutionResponse_pipelineExecutionArn :: Lens' StartPipelineExecutionResponse (Maybe Text)

The Amazon Resource Name (ARN) of the pipeline execution.

startPipelineExecutionResponse_httpStatus :: Lens' StartPipelineExecutionResponse Int

The response's http status code.