Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SageMaker.CreatePipeline

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a pipeline using a JSON pipeline definition.

Synopsis

data CreatePipeline = CreatePipeline' {
- parallelismConfiguration :: Maybe ParallelismConfiguration
- pipelineDefinition :: Maybe Text
- pipelineDefinitionS3Location :: Maybe PipelineDefinitionS3Location
- pipelineDescription :: Maybe Text
- pipelineDisplayName :: Maybe Text
- tags :: Maybe [Tag]
- pipelineName :: Text
- clientRequestToken :: Text
- roleArn :: Text
}
newCreatePipeline :: Text -> Text -> Text -> CreatePipeline
createPipeline_parallelismConfiguration :: Lens' CreatePipeline (Maybe ParallelismConfiguration)
createPipeline_pipelineDefinition :: Lens' CreatePipeline (Maybe Text)
createPipeline_pipelineDefinitionS3Location :: Lens' CreatePipeline (Maybe PipelineDefinitionS3Location)
createPipeline_pipelineDescription :: Lens' CreatePipeline (Maybe Text)
createPipeline_pipelineDisplayName :: Lens' CreatePipeline (Maybe Text)
createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag])
createPipeline_pipelineName :: Lens' CreatePipeline Text
createPipeline_clientRequestToken :: Lens' CreatePipeline Text
createPipeline_roleArn :: Lens' CreatePipeline Text
data CreatePipelineResponse = CreatePipelineResponse' {
- pipelineArn :: Maybe Text
- httpStatus :: Int
}
newCreatePipelineResponse :: Int -> CreatePipelineResponse
createPipelineResponse_pipelineArn :: Lens' CreatePipelineResponse (Maybe Text)
createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int

Creating a Request

data CreatePipeline Source #

See: newCreatePipeline smart constructor.

Constructors

CreatePipeline'

Fields

parallelismConfiguration :: Maybe ParallelismConfiguration
This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.
pipelineDefinition :: Maybe Text
The JSON pipeline definition of the pipeline.
pipelineDefinitionS3Location :: Maybe PipelineDefinitionS3Location
The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.
pipelineDescription :: Maybe Text
A description of the pipeline.
pipelineDisplayName :: Maybe Text
The display name of the pipeline.
tags :: Maybe [Tag]
A list of tags to apply to the created pipeline.
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 one time.
roleArn :: Text
The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

Instances

Instances details

ToJSON CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods toJSON :: CreatePipeline -> Value # toEncoding :: CreatePipeline -> Encoding # toJSONList :: [CreatePipeline] -> Value # toEncodingList :: [CreatePipeline] -> Encoding #
ToHeaders CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods toHeaders :: CreatePipeline -> [Header] #
ToPath CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods toPath :: CreatePipeline -> ByteString #
ToQuery CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods toQuery :: CreatePipeline -> QueryString #
AWSRequest CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Associated Types type AWSResponse CreatePipeline # Methods request :: (Service -> Service) -> CreatePipeline -> Request CreatePipeline # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePipeline -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePipeline))) #
Generic CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Associated Types type Rep CreatePipeline :: Type -> Type # Methods from :: CreatePipeline -> Rep CreatePipeline x # to :: Rep CreatePipeline x -> CreatePipeline #
Read CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods readsPrec :: Int -> ReadS CreatePipeline # readList :: ReadS [CreatePipeline] # readPrec :: ReadPrec CreatePipeline # readListPrec :: ReadPrec [CreatePipeline] #
Show CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods showsPrec :: Int -> CreatePipeline -> ShowS # show :: CreatePipeline -> String # showList :: [CreatePipeline] -> ShowS #
NFData CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods rnf :: CreatePipeline -> () #
Eq CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods (==) :: CreatePipeline -> CreatePipeline -> Bool # (/=) :: CreatePipeline -> CreatePipeline -> Bool #
Hashable CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods hashWithSalt :: Int -> CreatePipeline -> Int # hash :: CreatePipeline -> Int #
type AWSResponse CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline type AWSResponse CreatePipeline = CreatePipelineResponse
type Rep CreatePipeline Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline type Rep CreatePipeline = D1 ('MetaData "CreatePipeline" "Amazonka.SageMaker.CreatePipeline" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreatePipeline'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "parallelismConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParallelismConfiguration)) :: S1 ('MetaSel ('Just "pipelineDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "pipelineDefinitionS3Location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineDefinitionS3Location)) :: S1 ('MetaSel ('Just "pipelineDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "pipelineDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreatePipeline Source #

Arguments

:: Text	`CreatePipeline`
-> Text	`$sel:clientRequestToken:CreatePipeline'`
-> Text	`CreatePipeline`
-> CreatePipeline

Create a value of CreatePipeline 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:

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

$sel:pipelineDefinition:CreatePipeline', createPipeline_pipelineDefinition - The JSON pipeline definition of the pipeline.

$sel:pipelineDefinitionS3Location:CreatePipeline', createPipeline_pipelineDefinitionS3Location - The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

CreatePipeline, createPipeline_pipelineDescription - A description of the pipeline.

CreatePipeline, createPipeline_pipelineDisplayName - The display name of the pipeline.

CreatePipeline, createPipeline_tags - A list of tags to apply to the created pipeline.

CreatePipeline, createPipeline_pipelineName - The name of the pipeline.

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

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

Request Lenses

createPipeline_parallelismConfiguration :: Lens' CreatePipeline (Maybe ParallelismConfiguration) Source #

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

createPipeline_pipelineDefinition :: Lens' CreatePipeline (Maybe Text) Source #

The JSON pipeline definition of the pipeline.

createPipeline_pipelineDefinitionS3Location :: Lens' CreatePipeline (Maybe PipelineDefinitionS3Location) Source #

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

createPipeline_pipelineDescription :: Lens' CreatePipeline (Maybe Text) Source #

A description of the pipeline.

createPipeline_pipelineDisplayName :: Lens' CreatePipeline (Maybe Text) Source #

The display name of the pipeline.

createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag]) Source #

A list of tags to apply to the created pipeline.

createPipeline_pipelineName :: Lens' CreatePipeline Text Source #

The name of the pipeline.

createPipeline_clientRequestToken :: Lens' CreatePipeline Text Source #

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

createPipeline_roleArn :: Lens' CreatePipeline Text Source #

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

Destructuring the Response

data CreatePipelineResponse Source #

See: newCreatePipelineResponse smart constructor.

Constructors

CreatePipelineResponse'
Fields pipelineArn :: Maybe Text The Amazon Resource Name (ARN) of the created pipeline. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreatePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Associated Types type Rep CreatePipelineResponse :: Type -> Type # Methods from :: CreatePipelineResponse -> Rep CreatePipelineResponse x # to :: Rep CreatePipelineResponse x -> CreatePipelineResponse #
Read CreatePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods readsPrec :: Int -> ReadS CreatePipelineResponse # readList :: ReadS [CreatePipelineResponse] # readPrec :: ReadPrec CreatePipelineResponse # readListPrec :: ReadPrec [CreatePipelineResponse] #
Show CreatePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods showsPrec :: Int -> CreatePipelineResponse -> ShowS # show :: CreatePipelineResponse -> String # showList :: [CreatePipelineResponse] -> ShowS #
NFData CreatePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods rnf :: CreatePipelineResponse -> () #
Eq CreatePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline Methods (==) :: CreatePipelineResponse -> CreatePipelineResponse -> Bool # (/=) :: CreatePipelineResponse -> CreatePipelineResponse -> Bool #
type Rep CreatePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.CreatePipeline type Rep CreatePipelineResponse = D1 ('MetaData "CreatePipelineResponse" "Amazonka.SageMaker.CreatePipeline" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreatePipelineResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePipelineResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreatePipelineResponse'`
-> CreatePipelineResponse

Create a value of CreatePipelineResponse 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:

CreatePipelineResponse, createPipelineResponse_pipelineArn - The Amazon Resource Name (ARN) of the created pipeline.

$sel:httpStatus:CreatePipelineResponse', createPipelineResponse_httpStatus - The response's http status code.

Response Lenses

createPipelineResponse_pipelineArn :: Lens' CreatePipelineResponse (Maybe Text) Source #

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

createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int Source #

The response's http status code.