libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions
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.StepFunctions.ListExecutions

Description

Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

This API action is not supported by EXPRESS state machines.

This operation returns paginated results.

Synopsis

Creating a Request

data ListExecutions Source #

See: newListExecutions smart constructor.

Constructors

ListExecutions' 

Fields

  • statusFilter :: Maybe ExecutionStatus

    If specified, only list the executions whose current execution status matches the given filter.

  • nextToken :: Maybe Text

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • maxResults :: Maybe Natural

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

  • stateMachineArn :: Text

    The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Instances

Instances details
Eq ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Read ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Show ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Generic ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Associated Types

type Rep ListExecutions :: Type -> Type #

NFData ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Methods

rnf :: ListExecutions -> () #

Hashable ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

ToJSON ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

AWSPager ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

AWSRequest ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Associated Types

type AWSResponse ListExecutions #

ToHeaders ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

ToPath ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

ToQuery ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

type Rep ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

type Rep ListExecutions = D1 ('MetaData "ListExecutions" "Amazonka.StepFunctions.ListExecutions" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "ListExecutions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "statusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListExecutions Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

newListExecutions Source #

Create a value of ListExecutions 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:statusFilter:ListExecutions', listExecutions_statusFilter - If specified, only list the executions whose current execution status matches the given filter.

$sel:nextToken:ListExecutions', listExecutions_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

$sel:maxResults:ListExecutions', listExecutions_maxResults - The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

$sel:stateMachineArn:ListExecutions', listExecutions_stateMachineArn - The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Request Lenses

listExecutions_statusFilter :: Lens' ListExecutions (Maybe ExecutionStatus) Source #

If specified, only list the executions whose current execution status matches the given filter.

listExecutions_nextToken :: Lens' ListExecutions (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

listExecutions_maxResults :: Lens' ListExecutions (Maybe Natural) Source #

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

listExecutions_stateMachineArn :: Lens' ListExecutions Text Source #

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Destructuring the Response

data ListExecutionsResponse Source #

See: newListExecutionsResponse smart constructor.

Constructors

ListExecutionsResponse' 

Fields

  • nextToken :: Maybe Text

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • httpStatus :: Int

    The response's http status code.

  • executions :: [ExecutionListItem]

    The list of matching executions.

Instances

Instances details
Eq ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Read ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Show ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Generic ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Associated Types

type Rep ListExecutionsResponse :: Type -> Type #

NFData ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

Methods

rnf :: ListExecutionsResponse -> () #

type Rep ListExecutionsResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.ListExecutions

type Rep ListExecutionsResponse = D1 ('MetaData "ListExecutionsResponse" "Amazonka.StepFunctions.ListExecutions" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "ListExecutionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "executions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ExecutionListItem]))))

newListExecutionsResponse Source #

Create a value of ListExecutionsResponse 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:nextToken:ListExecutions', listExecutionsResponse_nextToken - If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

$sel:httpStatus:ListExecutionsResponse', listExecutionsResponse_httpStatus - The response's http status code.

$sel:executions:ListExecutionsResponse', listExecutionsResponse_executions - The list of matching executions.

Response Lenses

listExecutionsResponse_nextToken :: Lens' ListExecutionsResponse (Maybe Text) Source #

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.