libZSservicesZSamazonka-emrZSamazonka-emr
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.EMR.ListNotebookExecutions

Description

Provides summaries of all notebook executions. You can filter the list based on multiple criteria such as status, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to track the paging of a longer notebook execution list across multiple ListNotebookExecution calls.

This operation returns paginated results.

Synopsis

Creating a Request

data ListNotebookExecutions Source #

See: newListNotebookExecutions smart constructor.

Constructors

ListNotebookExecutions' 

Fields

  • status :: Maybe NotebookExecutionStatus

    The status filter for listing notebook executions.

    • START_PENDING indicates that the cluster has received the execution request but execution has not begun.
    • STARTING indicates that the execution is starting on the cluster.
    • RUNNING indicates that the execution is being processed by the cluster.
    • FINISHING indicates that execution processing is in the final stages.
    • FINISHED indicates that the execution has completed without error.
    • FAILING indicates that the execution is failing and will not finish successfully.
    • FAILED indicates that the execution failed.
    • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
    • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
    • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.
  • editorId :: Maybe Text

    The unique ID of the editor associated with the notebook execution.

  • to :: Maybe POSIX

    The end of time range filter for listing notebook executions. The default is the current timestamp.

  • from :: Maybe POSIX

    The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

  • marker :: Maybe Text

    The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Instances

Instances details
Eq ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

(==) :: ListNotebookExecutions -> ListNotebookExecutions -> Bool #

(/=) :: ListNotebookExecutions -> ListNotebookExecutions -> Bool #

Read ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

readsPrec :: Int -> ReadS ListNotebookExecutions #

readList :: ReadS [ListNotebookExecutions] #

readPrec :: ReadPrec ListNotebookExecutions #

readListPrec :: ReadPrec [ListNotebookExecutions] #

Show ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

showsPrec :: Int -> ListNotebookExecutions -> ShowS #

show :: ListNotebookExecutions -> String #

showList :: [ListNotebookExecutions] -> ShowS #

Generic ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Associated Types

type Rep ListNotebookExecutions :: Type -> Type #

Methods

from :: ListNotebookExecutions -> Rep ListNotebookExecutions x #

to :: Rep ListNotebookExecutions x -> ListNotebookExecutions #

NFData ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

rnf :: ListNotebookExecutions -> () #

Hashable ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

hashWithSalt :: Int -> ListNotebookExecutions -> Int #

hash :: ListNotebookExecutions -> Int #

ToJSON ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toJSON :: ListNotebookExecutions -> Value #

toEncoding :: ListNotebookExecutions -> Encoding #

toJSONList :: [ListNotebookExecutions] -> Value #

toEncodingList :: [ListNotebookExecutions] -> Encoding #

AWSPager ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

page :: ListNotebookExecutions -> AWSResponse ListNotebookExecutions -> Maybe ListNotebookExecutions #

AWSRequest ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Associated Types

type AWSResponse ListNotebookExecutions #

Methods

request :: ListNotebookExecutions -> Request ListNotebookExecutions #

response :: MonadResource m => Logger -> Service -> Proxy ListNotebookExecutions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListNotebookExecutions))) #

ToHeaders ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toHeaders :: ListNotebookExecutions -> [Header] #

ToPath ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toPath :: ListNotebookExecutions -> ByteString #

ToQuery ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toQuery :: ListNotebookExecutions -> QueryString #

type Rep ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

type Rep ListNotebookExecutions = D1 ('MetaData "ListNotebookExecutions" "Amazonka.EMR.ListNotebookExecutions" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "ListNotebookExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotebookExecutionStatus)) :*: S1 ('MetaSel ('Just "editorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "to") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse ListNotebookExecutions Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

type AWSResponse ListNotebookExecutions = ListNotebookExecutionsResponse

newListNotebookExecutions :: ListNotebookExecutions Source #

Create a value of ListNotebookExecutions 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:status:ListNotebookExecutions', listNotebookExecutions_status - The status filter for listing notebook executions.

  • START_PENDING indicates that the cluster has received the execution request but execution has not begun.
  • STARTING indicates that the execution is starting on the cluster.
  • RUNNING indicates that the execution is being processed by the cluster.
  • FINISHING indicates that execution processing is in the final stages.
  • FINISHED indicates that the execution has completed without error.
  • FAILING indicates that the execution is failing and will not finish successfully.
  • FAILED indicates that the execution failed.
  • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
  • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
  • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

$sel:editorId:ListNotebookExecutions', listNotebookExecutions_editorId - The unique ID of the editor associated with the notebook execution.

$sel:to:ListNotebookExecutions', listNotebookExecutions_to - The end of time range filter for listing notebook executions. The default is the current timestamp.

$sel:from:ListNotebookExecutions', listNotebookExecutions_from - The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

$sel:marker:ListNotebookExecutions', listNotebookExecutions_marker - The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Request Lenses

listNotebookExecutions_status :: Lens' ListNotebookExecutions (Maybe NotebookExecutionStatus) Source #

The status filter for listing notebook executions.

  • START_PENDING indicates that the cluster has received the execution request but execution has not begun.
  • STARTING indicates that the execution is starting on the cluster.
  • RUNNING indicates that the execution is being processed by the cluster.
  • FINISHING indicates that execution processing is in the final stages.
  • FINISHED indicates that the execution has completed without error.
  • FAILING indicates that the execution is failing and will not finish successfully.
  • FAILED indicates that the execution failed.
  • STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and the stop is pending.
  • STOPPING indicates that the cluster is in the process of stopping the execution as a result of a StopNotebookExecution request.
  • STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

listNotebookExecutions_editorId :: Lens' ListNotebookExecutions (Maybe Text) Source #

The unique ID of the editor associated with the notebook execution.

listNotebookExecutions_to :: Lens' ListNotebookExecutions (Maybe UTCTime) Source #

The end of time range filter for listing notebook executions. The default is the current timestamp.

listNotebookExecutions_from :: Lens' ListNotebookExecutions (Maybe UTCTime) Source #

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

listNotebookExecutions_marker :: Lens' ListNotebookExecutions (Maybe Text) Source #

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Destructuring the Response

data ListNotebookExecutionsResponse Source #

See: newListNotebookExecutionsResponse smart constructor.

Constructors

ListNotebookExecutionsResponse' 

Fields

Instances

Instances details
Eq ListNotebookExecutionsResponse Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

(==) :: ListNotebookExecutionsResponse -> ListNotebookExecutionsResponse -> Bool #

(/=) :: ListNotebookExecutionsResponse -> ListNotebookExecutionsResponse -> Bool #

Read ListNotebookExecutionsResponse Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

readsPrec :: Int -> ReadS ListNotebookExecutionsResponse #

readList :: ReadS [ListNotebookExecutionsResponse] #

readPrec :: ReadPrec ListNotebookExecutionsResponse #

readListPrec :: ReadPrec [ListNotebookExecutionsResponse] #

Show ListNotebookExecutionsResponse Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

showsPrec :: Int -> ListNotebookExecutionsResponse -> ShowS #

show :: ListNotebookExecutionsResponse -> String #

showList :: [ListNotebookExecutionsResponse] -> ShowS #

Generic ListNotebookExecutionsResponse Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Associated Types

type Rep ListNotebookExecutionsResponse :: Type -> Type #

Methods

from :: ListNotebookExecutionsResponse -> Rep ListNotebookExecutionsResponse x #

to :: Rep ListNotebookExecutionsResponse x -> ListNotebookExecutionsResponse #

NFData ListNotebookExecutionsResponse Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

rnf :: ListNotebookExecutionsResponse -> () #

type Rep ListNotebookExecutionsResponse Source # 
Instance details

Defined in Amazonka.EMR.ListNotebookExecutions

type Rep ListNotebookExecutionsResponse = D1 ('MetaData "ListNotebookExecutionsResponse" "Amazonka.EMR.ListNotebookExecutions" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "ListNotebookExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "notebookExecutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotebookExecutionSummary])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListNotebookExecutionsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListNotebookExecutionsResponse'

-> ListNotebookExecutionsResponse 

Create a value of ListNotebookExecutionsResponse 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:notebookExecutions:ListNotebookExecutionsResponse', listNotebookExecutionsResponse_notebookExecutions - A list of notebook executions.

$sel:marker:ListNotebookExecutions', listNotebookExecutionsResponse_marker - A pagination token that a subsequent ListNotebookExecutions can use to determine the next set of results to retrieve.

$sel:httpStatus:ListNotebookExecutionsResponse', listNotebookExecutionsResponse_httpStatus - The response's http status code.

Response Lenses

listNotebookExecutionsResponse_notebookExecutions :: Lens' ListNotebookExecutionsResponse (Maybe [NotebookExecutionSummary]) Source #

A list of notebook executions.

listNotebookExecutionsResponse_marker :: Lens' ListNotebookExecutionsResponse (Maybe Text) Source #

A pagination token that a subsequent ListNotebookExecutions can use to determine the next set of results to retrieve.

listNotebookExecutionsResponse_httpStatus :: Lens' ListNotebookExecutionsResponse Int Source #

The response's http status code.