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.DescribePipeline

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the details of a pipeline.

Synopsis

data DescribePipeline = DescribePipeline' {
- pipelineName :: Text
}
newDescribePipeline :: Text -> DescribePipeline
describePipeline_pipelineName :: Lens' DescribePipeline Text
data DescribePipelineResponse = DescribePipelineResponse' {
- createdBy :: Maybe UserContext
- creationTime :: Maybe POSIX
- lastModifiedBy :: Maybe UserContext
- lastModifiedTime :: Maybe POSIX
- lastRunTime :: Maybe POSIX
- parallelismConfiguration :: Maybe ParallelismConfiguration
- pipelineArn :: Maybe Text
- pipelineDefinition :: Maybe Text
- pipelineDescription :: Maybe Text
- pipelineDisplayName :: Maybe Text
- pipelineName :: Maybe Text
- pipelineStatus :: Maybe PipelineStatus
- roleArn :: Maybe Text
- httpStatus :: Int
}
newDescribePipelineResponse :: Int -> DescribePipelineResponse
describePipelineResponse_createdBy :: Lens' DescribePipelineResponse (Maybe UserContext)
describePipelineResponse_creationTime :: Lens' DescribePipelineResponse (Maybe UTCTime)
describePipelineResponse_lastModifiedBy :: Lens' DescribePipelineResponse (Maybe UserContext)
describePipelineResponse_lastModifiedTime :: Lens' DescribePipelineResponse (Maybe UTCTime)
describePipelineResponse_lastRunTime :: Lens' DescribePipelineResponse (Maybe UTCTime)
describePipelineResponse_parallelismConfiguration :: Lens' DescribePipelineResponse (Maybe ParallelismConfiguration)
describePipelineResponse_pipelineArn :: Lens' DescribePipelineResponse (Maybe Text)
describePipelineResponse_pipelineDefinition :: Lens' DescribePipelineResponse (Maybe Text)
describePipelineResponse_pipelineDescription :: Lens' DescribePipelineResponse (Maybe Text)
describePipelineResponse_pipelineDisplayName :: Lens' DescribePipelineResponse (Maybe Text)
describePipelineResponse_pipelineName :: Lens' DescribePipelineResponse (Maybe Text)
describePipelineResponse_pipelineStatus :: Lens' DescribePipelineResponse (Maybe PipelineStatus)
describePipelineResponse_roleArn :: Lens' DescribePipelineResponse (Maybe Text)
describePipelineResponse_httpStatus :: Lens' DescribePipelineResponse Int

Creating a Request

data DescribePipeline Source #

See: newDescribePipeline smart constructor.

Constructors

DescribePipeline'
Fields pipelineName :: Text The name of the pipeline to describe.

Instances

Instances details

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

newDescribePipeline Source #

Arguments

:: Text	`DescribePipeline`
-> DescribePipeline

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

DescribePipeline, describePipeline_pipelineName - The name of the pipeline to describe.

Request Lenses

describePipeline_pipelineName :: Lens' DescribePipeline Text Source #

The name of the pipeline to describe.

Destructuring the Response

data DescribePipelineResponse Source #

See: newDescribePipelineResponse smart constructor.

Constructors

DescribePipelineResponse'

Fields

createdBy :: Maybe UserContext
creationTime :: Maybe POSIX
The time when the pipeline was created.
lastModifiedBy :: Maybe UserContext
lastModifiedTime :: Maybe POSIX
The time when the pipeline was last modified.
lastRunTime :: Maybe POSIX
The time when the pipeline was last run.
parallelismConfiguration :: Maybe ParallelismConfiguration
Lists the parallelism configuration applied to the pipeline.
pipelineArn :: Maybe Text
The Amazon Resource Name (ARN) of the pipeline.
pipelineDefinition :: Maybe Text
The JSON pipeline definition.
pipelineDescription :: Maybe Text
The description of the pipeline.
pipelineDisplayName :: Maybe Text
The display name of the pipeline.
pipelineName :: Maybe Text
The name of the pipeline.
pipelineStatus :: Maybe PipelineStatus
The status of the pipeline execution.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) that the pipeline uses to execute.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribePipeline Associated Types type Rep DescribePipelineResponse :: Type -> Type # Methods from :: DescribePipelineResponse -> Rep DescribePipelineResponse x # to :: Rep DescribePipelineResponse x -> DescribePipelineResponse #
Read DescribePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribePipeline Methods readsPrec :: Int -> ReadS DescribePipelineResponse # readList :: ReadS [DescribePipelineResponse] # readPrec :: ReadPrec DescribePipelineResponse # readListPrec :: ReadPrec [DescribePipelineResponse] #
Show DescribePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribePipeline Methods showsPrec :: Int -> DescribePipelineResponse -> ShowS # show :: DescribePipelineResponse -> String # showList :: [DescribePipelineResponse] -> ShowS #
NFData DescribePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribePipeline Methods rnf :: DescribePipelineResponse -> () #
Eq DescribePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribePipeline Methods (==) :: DescribePipelineResponse -> DescribePipelineResponse -> Bool # (/=) :: DescribePipelineResponse -> DescribePipelineResponse -> Bool #
type Rep DescribePipelineResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribePipeline type Rep DescribePipelineResponse = D1 ('MetaData "DescribePipelineResponse" "Amazonka.SageMaker.DescribePipeline" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "DescribePipelineResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastModifiedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserContext)))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastRunTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "parallelismConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParallelismConfiguration)) :: S1 ('MetaSel ('Just "pipelineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "pipelineDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pipelineDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pipelineDisplayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pipelineStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineStatus))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribePipelineResponse Source #

Arguments

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

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

DescribePipelineResponse, describePipelineResponse_createdBy - Undocumented member.

DescribePipelineResponse, describePipelineResponse_creationTime - The time when the pipeline was created.

DescribePipelineResponse, describePipelineResponse_lastModifiedBy - Undocumented member.

DescribePipelineResponse, describePipelineResponse_lastModifiedTime - The time when the pipeline was last modified.

DescribePipelineResponse, describePipelineResponse_lastRunTime - The time when the pipeline was last run.

DescribePipelineResponse, describePipelineResponse_parallelismConfiguration - Lists the parallelism configuration applied to the pipeline.

DescribePipelineResponse, describePipelineResponse_pipelineArn - The Amazon Resource Name (ARN) of the pipeline.

$sel:pipelineDefinition:DescribePipelineResponse', describePipelineResponse_pipelineDefinition - The JSON pipeline definition.

DescribePipelineResponse, describePipelineResponse_pipelineDescription - The description of the pipeline.

DescribePipelineResponse, describePipelineResponse_pipelineDisplayName - The display name of the pipeline.

DescribePipeline, describePipelineResponse_pipelineName - The name of the pipeline.

DescribePipelineResponse, describePipelineResponse_pipelineStatus - The status of the pipeline execution.

DescribePipelineResponse, describePipelineResponse_roleArn - The Amazon Resource Name (ARN) that the pipeline uses to execute.

$sel:httpStatus:DescribePipelineResponse', describePipelineResponse_httpStatus - The response's http status code.

Response Lenses

describePipelineResponse_createdBy :: Lens' DescribePipelineResponse (Maybe UserContext) Source #

Undocumented member.

describePipelineResponse_creationTime :: Lens' DescribePipelineResponse (Maybe UTCTime) Source #

The time when the pipeline was created.

describePipelineResponse_lastModifiedBy :: Lens' DescribePipelineResponse (Maybe UserContext) Source #

Undocumented member.

describePipelineResponse_lastModifiedTime :: Lens' DescribePipelineResponse (Maybe UTCTime) Source #

The time when the pipeline was last modified.

describePipelineResponse_lastRunTime :: Lens' DescribePipelineResponse (Maybe UTCTime) Source #

The time when the pipeline was last run.

describePipelineResponse_parallelismConfiguration :: Lens' DescribePipelineResponse (Maybe ParallelismConfiguration) Source #

Lists the parallelism configuration applied to the pipeline.

describePipelineResponse_pipelineArn :: Lens' DescribePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline.

describePipelineResponse_pipelineDefinition :: Lens' DescribePipelineResponse (Maybe Text) Source #

The JSON pipeline definition.

describePipelineResponse_pipelineDescription :: Lens' DescribePipelineResponse (Maybe Text) Source #

The description of the pipeline.

describePipelineResponse_pipelineDisplayName :: Lens' DescribePipelineResponse (Maybe Text) Source #

The display name of the pipeline.

describePipelineResponse_pipelineName :: Lens' DescribePipelineResponse (Maybe Text) Source #

The name of the pipeline.

describePipelineResponse_pipelineStatus :: Lens' DescribePipelineResponse (Maybe PipelineStatus) Source #

The status of the pipeline execution.

describePipelineResponse_roleArn :: Lens' DescribePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that the pipeline uses to execute.

describePipelineResponse_httpStatus :: Lens' DescribePipelineResponse Int Source #

The response's http status code.