Amazonka.EMR.ListNotebookExecutions

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.

Creating a Request

data ListNotebookExecutions

See: newListNotebookExecutions smart constructor.

Constructors

ListNotebookExecutions'

Fields

• editorId :: Maybe Text

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

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

• 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.
• to :: Maybe POSIX

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

Instances

ToJSON ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toJSON :: ListNotebookExecutions -> Value

toEncoding :: ListNotebookExecutions -> Encoding

toJSONList :: [ListNotebookExecutions] -> Value

toEncodingList :: [ListNotebookExecutions] -> Encoding

ToHeaders ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toHeaders :: ListNotebookExecutions -> [Header]

ToPath ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toPath :: ListNotebookExecutions -> ByteString

ToQuery ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

toQuery :: ListNotebookExecutions -> QueryString

AWSPager ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

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

AWSRequest ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Associated Types

type AWSResponse ListNotebookExecutions

Methods

request :: (Service -> Service) -> ListNotebookExecutions -> Request ListNotebookExecutions

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

Generic ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Associated Types

type Rep ListNotebookExecutions :: Type -> Type

Methods

from :: ListNotebookExecutions -> Rep ListNotebookExecutions x

to :: Rep ListNotebookExecutions x -> ListNotebookExecutions

Read ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

readsPrec :: Int -> ReadS ListNotebookExecutions

readList :: ReadS [ListNotebookExecutions]

readPrec :: ReadPrec ListNotebookExecutions

readListPrec :: ReadPrec [ListNotebookExecutions]

Show ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

showsPrec :: Int -> ListNotebookExecutions -> ShowS

show :: ListNotebookExecutions -> String

showList :: [ListNotebookExecutions] -> ShowS

NFData ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

rnf :: ListNotebookExecutions -> ()

Eq ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

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

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

Hashable ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

hashWithSalt :: Int -> ListNotebookExecutions -> Int

hash :: ListNotebookExecutions -> Int

type AWSResponse ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

type AWSResponse ListNotebookExecutions = ListNotebookExecutionsResponse

type Rep ListNotebookExecutions

Defined in Amazonka.EMR.ListNotebookExecutions

type Rep ListNotebookExecutions = D1 ('MetaData "ListNotebookExecutions" "Amazonka.EMR.ListNotebookExecutions" "amazonka-emr-2.0-B3cWhP6sdymF3IBUMdPGcd" 'False) (C1 ('MetaCons "ListNotebookExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "editorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotebookExecutionStatus)) :*: S1 ('MetaSel ('Just "to") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newListNotebookExecutions :: ListNotebookExecutions

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:

ListNotebookExecutions, listNotebookExecutions_editorId - The unique ID of the editor associated with the notebook execution.

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

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

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:to:ListNotebookExecutions', listNotebookExecutions_to - The end of time range filter for listing notebook executions. The default is the current timestamp.

Request Lenses

listNotebookExecutions_editorId :: Lens' ListNotebookExecutions (Maybe Text)

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

listNotebookExecutions_from :: Lens' ListNotebookExecutions (Maybe UTCTime)

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)

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

listNotebookExecutions_status :: Lens' ListNotebookExecutions (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.

listNotebookExecutions_to :: Lens' ListNotebookExecutions (Maybe UTCTime)

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

Destructuring the Response

data ListNotebookExecutionsResponse

See: newListNotebookExecutionsResponse smart constructor.

Constructors

ListNotebookExecutionsResponse'

Fields

• marker :: Maybe Text

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

• notebookExecutions :: Maybe [NotebookExecutionSummary]

  A list of notebook executions.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListNotebookExecutionsResponse

Defined in Amazonka.EMR.ListNotebookExecutions

Associated Types

type Rep ListNotebookExecutionsResponse :: Type -> Type

Methods

from :: ListNotebookExecutionsResponse -> Rep ListNotebookExecutionsResponse x

to :: Rep ListNotebookExecutionsResponse x -> ListNotebookExecutionsResponse

Read ListNotebookExecutionsResponse

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

readsPrec :: Int -> ReadS ListNotebookExecutionsResponse

readList :: ReadS [ListNotebookExecutionsResponse]

readPrec :: ReadPrec ListNotebookExecutionsResponse

readListPrec :: ReadPrec [ListNotebookExecutionsResponse]

Show ListNotebookExecutionsResponse

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

showsPrec :: Int -> ListNotebookExecutionsResponse -> ShowS

show :: ListNotebookExecutionsResponse -> String

showList :: [ListNotebookExecutionsResponse] -> ShowS

NFData ListNotebookExecutionsResponse

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

rnf :: ListNotebookExecutionsResponse -> ()

Eq ListNotebookExecutionsResponse

Defined in Amazonka.EMR.ListNotebookExecutions

Methods

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

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

type Rep ListNotebookExecutionsResponse

Defined in Amazonka.EMR.ListNotebookExecutions

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

newListNotebookExecutionsResponse

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:

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

$sel:notebookExecutions:ListNotebookExecutionsResponse', listNotebookExecutionsResponse_notebookExecutions - A list of notebook executions.

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

Response Lenses

listNotebookExecutionsResponse_marker :: Lens' ListNotebookExecutionsResponse (Maybe Text)

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

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

A list of notebook executions.

listNotebookExecutionsResponse_httpStatus :: Lens' ListNotebookExecutionsResponse Int

The response's http status code.