Amazonka.StepFunctions.ListMapRuns

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call DescribeMapRun to obtain more information, if needed.

This operation returns paginated results.

Creating a Request

data ListMapRuns

See: newListMapRuns smart constructor.

Constructors

ListMapRuns'

Fields

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

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

• executionArn :: Text

  The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

Instances

ToJSON ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

toJSON :: ListMapRuns -> Value

toEncoding :: ListMapRuns -> Encoding

toJSONList :: [ListMapRuns] -> Value

toEncodingList :: [ListMapRuns] -> Encoding

ToHeaders ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

toHeaders :: ListMapRuns -> [Header]

ToPath ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

toPath :: ListMapRuns -> ByteString

ToQuery ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

toQuery :: ListMapRuns -> QueryString

AWSPager ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

page :: ListMapRuns -> AWSResponse ListMapRuns -> Maybe ListMapRuns

AWSRequest ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Associated Types

type AWSResponse ListMapRuns

Methods

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

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

Generic ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Associated Types

type Rep ListMapRuns :: Type -> Type

Methods

from :: ListMapRuns -> Rep ListMapRuns x

to :: Rep ListMapRuns x -> ListMapRuns

Read ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

readsPrec :: Int -> ReadS ListMapRuns

readList :: ReadS [ListMapRuns]

readPrec :: ReadPrec ListMapRuns

readListPrec :: ReadPrec [ListMapRuns]

Show ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

showsPrec :: Int -> ListMapRuns -> ShowS

show :: ListMapRuns -> String

showList :: [ListMapRuns] -> ShowS

NFData ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

rnf :: ListMapRuns -> ()

Eq ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

(==) :: ListMapRuns -> ListMapRuns -> Bool

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

Hashable ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

hashWithSalt :: Int -> ListMapRuns -> Int

hash :: ListMapRuns -> Int

type AWSResponse ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

type AWSResponse ListMapRuns = ListMapRunsResponse

type Rep ListMapRuns

Defined in Amazonka.StepFunctions.ListMapRuns

type Rep ListMapRuns = D1 ('MetaData "ListMapRuns" "Amazonka.StepFunctions.ListMapRuns" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "ListMapRuns'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListMapRuns

Arguments

:: Text

ListMapRuns

-> ListMapRuns

Create a value of ListMapRuns 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:maxResults:ListMapRuns', listMapRuns_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.

ListMapRuns, listMapRuns_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.

ListMapRuns, listMapRuns_executionArn - The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

Request Lenses

listMapRuns_maxResults :: Lens' ListMapRuns (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.

listMapRuns_nextToken :: Lens' ListMapRuns (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.

listMapRuns_executionArn :: Lens' ListMapRuns Text

The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

Destructuring the Response

data ListMapRunsResponse

See: newListMapRunsResponse smart constructor.

Constructors

ListMapRunsResponse'

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.

• mapRuns :: [MapRunListItem]

  An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.

Instances

Generic ListMapRunsResponse

Defined in Amazonka.StepFunctions.ListMapRuns

Associated Types

type Rep ListMapRunsResponse :: Type -> Type

Methods

from :: ListMapRunsResponse -> Rep ListMapRunsResponse x

to :: Rep ListMapRunsResponse x -> ListMapRunsResponse

Read ListMapRunsResponse

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

readsPrec :: Int -> ReadS ListMapRunsResponse

readList :: ReadS [ListMapRunsResponse]

readPrec :: ReadPrec ListMapRunsResponse

readListPrec :: ReadPrec [ListMapRunsResponse]

Show ListMapRunsResponse

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

showsPrec :: Int -> ListMapRunsResponse -> ShowS

show :: ListMapRunsResponse -> String

showList :: [ListMapRunsResponse] -> ShowS

NFData ListMapRunsResponse

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

rnf :: ListMapRunsResponse -> ()

Eq ListMapRunsResponse

Defined in Amazonka.StepFunctions.ListMapRuns

Methods

(==) :: ListMapRunsResponse -> ListMapRunsResponse -> Bool

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

type Rep ListMapRunsResponse

Defined in Amazonka.StepFunctions.ListMapRuns

type Rep ListMapRunsResponse = D1 ('MetaData "ListMapRunsResponse" "Amazonka.StepFunctions.ListMapRuns" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "ListMapRunsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "mapRuns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [MapRunListItem]))))

newListMapRunsResponse

Arguments

:: Int

$sel:httpStatus:ListMapRunsResponse'

-> ListMapRunsResponse

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

ListMapRuns, listMapRunsResponse_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:ListMapRunsResponse', listMapRunsResponse_httpStatus - The response's http status code.

$sel:mapRuns:ListMapRunsResponse', listMapRunsResponse_mapRuns - An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.

Response Lenses

listMapRunsResponse_nextToken :: Lens' ListMapRunsResponse (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.

listMapRunsResponse_httpStatus :: Lens' ListMapRunsResponse Int

The response's http status code.

listMapRunsResponse_mapRuns :: Lens' ListMapRunsResponse [MapRunListItem]

An array that lists information related to a Map Run, such as the Amazon Resource Name (ARN) of the Map Run and the ARN of the state machine that started the Map Run.