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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of the pipeline executions.

This operation returns paginated results.

Synopsis

Creating a Request

data ListPipelineExecutions Source #

See: newListPipelineExecutions smart constructor.

Constructors

ListPipelineExecutions'

Fields

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

Instances

Instances details

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

newListPipelineExecutions Source #

Arguments

:: Text	`ListPipelineExecutions`
-> ListPipelineExecutions

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

ListPipelineExecutions, listPipelineExecutions_createdAfter - A filter that returns the pipeline executions that were created after a specified time.

ListPipelineExecutions, listPipelineExecutions_createdBefore - A filter that returns the pipeline executions that were created before a specified time.

$sel:maxResults:ListPipelineExecutions', listPipelineExecutions_maxResults - The maximum number of pipeline executions to return in the response.

ListPipelineExecutions, listPipelineExecutions_nextToken - If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

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

$sel:sortOrder:ListPipelineExecutions', listPipelineExecutions_sortOrder - The sort order for results.

ListPipelineExecutions, listPipelineExecutions_pipelineName - The name of the pipeline.

Request Lenses

listPipelineExecutions_createdAfter :: Lens' ListPipelineExecutions (Maybe UTCTime) Source #

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

listPipelineExecutions_createdBefore :: Lens' ListPipelineExecutions (Maybe UTCTime) Source #

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

listPipelineExecutions_maxResults :: Lens' ListPipelineExecutions (Maybe Natural) Source #

The maximum number of pipeline executions to return in the response.

listPipelineExecutions_nextToken :: Lens' ListPipelineExecutions (Maybe Text) Source #

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

listPipelineExecutions_sortBy :: Lens' ListPipelineExecutions (Maybe SortPipelineExecutionsBy) Source #

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

listPipelineExecutions_sortOrder :: Lens' ListPipelineExecutions (Maybe SortOrder) Source #

The sort order for results.

listPipelineExecutions_pipelineName :: Lens' ListPipelineExecutions Text Source #

The name of the pipeline.

Destructuring the Response

data ListPipelineExecutionsResponse Source #

See: newListPipelineExecutionsResponse smart constructor.

Constructors

ListPipelineExecutionsResponse'

Fields

nextToken :: Maybe Text
If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.
pipelineExecutionSummaries :: Maybe [PipelineExecutionSummary]
Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListPipelineExecutionsResponse Source #

Arguments

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

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

ListPipelineExecutions, listPipelineExecutionsResponse_nextToken - If the result of the previous ListPipelineExecutions request was truncated, the response includes a NextToken. To retrieve the next set of pipeline executions, use the token in the next request.

$sel:pipelineExecutionSummaries:ListPipelineExecutionsResponse', listPipelineExecutionsResponse_pipelineExecutionSummaries - Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

$sel:httpStatus:ListPipelineExecutionsResponse', listPipelineExecutionsResponse_httpStatus - The response's http status code.

Response Lenses

listPipelineExecutionsResponse_nextToken :: Lens' ListPipelineExecutionsResponse (Maybe Text) Source #

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

listPipelineExecutionsResponse_pipelineExecutionSummaries :: Lens' ListPipelineExecutionsResponse (Maybe [PipelineExecutionSummary]) Source #

Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.

listPipelineExecutionsResponse_httpStatus :: Lens' ListPipelineExecutionsResponse Int Source #

The response's http status code.