Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.ListPipelines

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of pipelines.

This operation returns paginated results.

Synopsis

data ListPipelines = ListPipelines' {
- createdAfter :: Maybe POSIX
- pipelineNamePrefix :: Maybe Text
- nextToken :: Maybe Text
- sortOrder :: Maybe SortOrder
- maxResults :: Maybe Natural
- createdBefore :: Maybe POSIX
- sortBy :: Maybe SortPipelinesBy
}
newListPipelines :: ListPipelines
listPipelines_createdAfter :: Lens' ListPipelines (Maybe UTCTime)
listPipelines_pipelineNamePrefix :: Lens' ListPipelines (Maybe Text)
listPipelines_nextToken :: Lens' ListPipelines (Maybe Text)
listPipelines_sortOrder :: Lens' ListPipelines (Maybe SortOrder)
listPipelines_maxResults :: Lens' ListPipelines (Maybe Natural)
listPipelines_createdBefore :: Lens' ListPipelines (Maybe UTCTime)
listPipelines_sortBy :: Lens' ListPipelines (Maybe SortPipelinesBy)
data ListPipelinesResponse = ListPipelinesResponse' {
- pipelineSummaries :: Maybe [PipelineSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListPipelinesResponse :: Int -> ListPipelinesResponse
listPipelinesResponse_pipelineSummaries :: Lens' ListPipelinesResponse (Maybe [PipelineSummary])
listPipelinesResponse_nextToken :: Lens' ListPipelinesResponse (Maybe Text)
listPipelinesResponse_httpStatus :: Lens' ListPipelinesResponse Int

Creating a Request

data ListPipelines Source #

See: newListPipelines smart constructor.

Constructors

ListPipelines'

Fields

createdAfter :: Maybe POSIX
A filter that returns the pipelines that were created after a specified time.
pipelineNamePrefix :: Maybe Text
The prefix of the pipeline name.
nextToken :: Maybe Text
If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
sortOrder :: Maybe SortOrder
The sort order for results.
maxResults :: Maybe Natural
The maximum number of pipelines to return in the response.
createdBefore :: Maybe POSIX
A filter that returns the pipelines that were created before a specified time.
sortBy :: Maybe SortPipelinesBy
The field by which to sort results. The default is CreatedTime.

Instances

Instances details

Eq ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods (==) :: ListPipelines -> ListPipelines -> Bool # (/=) :: ListPipelines -> ListPipelines -> Bool #
Read ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods readsPrec :: Int -> ReadS ListPipelines # readList :: ReadS [ListPipelines] # readPrec :: ReadPrec ListPipelines # readListPrec :: ReadPrec [ListPipelines] #
Show ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods showsPrec :: Int -> ListPipelines -> ShowS # show :: ListPipelines -> String # showList :: [ListPipelines] -> ShowS #
Generic ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Associated Types type Rep ListPipelines :: Type -> Type # Methods from :: ListPipelines -> Rep ListPipelines x # to :: Rep ListPipelines x -> ListPipelines #
NFData ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods rnf :: ListPipelines -> () #
Hashable ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods hashWithSalt :: Int -> ListPipelines -> Int # hash :: ListPipelines -> Int #
ToJSON ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods toJSON :: ListPipelines -> Value # toEncoding :: ListPipelines -> Encoding # toJSONList :: [ListPipelines] -> Value # toEncodingList :: [ListPipelines] -> Encoding #
AWSPager ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods page :: ListPipelines -> AWSResponse ListPipelines -> Maybe ListPipelines #
AWSRequest ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Associated Types type AWSResponse ListPipelines # Methods request :: ListPipelines -> Request ListPipelines # response :: MonadResource m => Logger -> Service -> Proxy ListPipelines -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPipelines))) #
ToHeaders ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods toHeaders :: ListPipelines -> [Header] #
ToPath ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods toPath :: ListPipelines -> ByteString #
ToQuery ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines Methods toQuery :: ListPipelines -> QueryString #
type Rep ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines type Rep ListPipelines = D1 ('MetaData "ListPipelines" "Amazonka.SageMaker.ListPipelines" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListPipelines'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "createdAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "pipelineNamePrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "createdBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortPipelinesBy))))))
type AWSResponse ListPipelines Source #
Instance details Defined in Amazonka.SageMaker.ListPipelines type AWSResponse ListPipelines = ListPipelinesResponse

newListPipelines :: ListPipelines Source #

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

$sel:createdAfter:ListPipelines', listPipelines_createdAfter - A filter that returns the pipelines that were created after a specified time.

$sel:pipelineNamePrefix:ListPipelines', listPipelines_pipelineNamePrefix - The prefix of the pipeline name.

$sel:nextToken:ListPipelines', listPipelines_nextToken - If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

$sel:sortOrder:ListPipelines', listPipelines_sortOrder - The sort order for results.

$sel:maxResults:ListPipelines', listPipelines_maxResults - The maximum number of pipelines to return in the response.

$sel:createdBefore:ListPipelines', listPipelines_createdBefore - A filter that returns the pipelines that were created before a specified time.

$sel:sortBy:ListPipelines', listPipelines_sortBy - The field by which to sort results. The default is CreatedTime.

Request Lenses

listPipelines_createdAfter :: Lens' ListPipelines (Maybe UTCTime) Source #

A filter that returns the pipelines that were created after a specified time.

listPipelines_pipelineNamePrefix :: Lens' ListPipelines (Maybe Text) Source #

The prefix of the pipeline name.

listPipelines_nextToken :: Lens' ListPipelines (Maybe Text) Source #

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

listPipelines_sortOrder :: Lens' ListPipelines (Maybe SortOrder) Source #

The sort order for results.

listPipelines_maxResults :: Lens' ListPipelines (Maybe Natural) Source #

The maximum number of pipelines to return in the response.

listPipelines_createdBefore :: Lens' ListPipelines (Maybe UTCTime) Source #

A filter that returns the pipelines that were created before a specified time.

listPipelines_sortBy :: Lens' ListPipelines (Maybe SortPipelinesBy) Source #

The field by which to sort results. The default is CreatedTime.

Destructuring the Response

data ListPipelinesResponse Source #

See: newListPipelinesResponse smart constructor.

Constructors

ListPipelinesResponse'

Fields

pipelineSummaries :: Maybe [PipelineSummary]
Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.
nextToken :: Maybe Text
If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListPipelinesResponse Source #

Arguments

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

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

$sel:pipelineSummaries:ListPipelinesResponse', listPipelinesResponse_pipelineSummaries - Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

$sel:nextToken:ListPipelines', listPipelinesResponse_nextToken - If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

$sel:httpStatus:ListPipelinesResponse', listPipelinesResponse_httpStatus - The response's http status code.

Response Lenses

listPipelinesResponse_pipelineSummaries :: Lens' ListPipelinesResponse (Maybe [PipelineSummary]) Source #

Contains a sorted list of PipelineSummary objects matching the specified filters. Each PipelineSummary consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

listPipelinesResponse_nextToken :: Lens' ListPipelinesResponse (Maybe Text) Source #

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

listPipelinesResponse_httpStatus :: Lens' ListPipelinesResponse Int Source #

The response's http status code.