Amazonka.StepFunctions.ListStateMachines

Lists the existing state machines.

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 operation returns paginated results.

Creating a Request

data ListStateMachines

See: newListStateMachines smart constructor.

Constructors

ListStateMachines'

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.

Instances

ToJSON ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

toJSON :: ListStateMachines -> Value

toEncoding :: ListStateMachines -> Encoding

toJSONList :: [ListStateMachines] -> Value

toEncodingList :: [ListStateMachines] -> Encoding

ToHeaders ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

toHeaders :: ListStateMachines -> [Header]

ToPath ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

toPath :: ListStateMachines -> ByteString

ToQuery ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

toQuery :: ListStateMachines -> QueryString

AWSPager ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

page :: ListStateMachines -> AWSResponse ListStateMachines -> Maybe ListStateMachines

AWSRequest ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Associated Types

type AWSResponse ListStateMachines

Methods

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

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

Generic ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Associated Types

type Rep ListStateMachines :: Type -> Type

Methods

from :: ListStateMachines -> Rep ListStateMachines x

to :: Rep ListStateMachines x -> ListStateMachines

Read ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

readsPrec :: Int -> ReadS ListStateMachines

readList :: ReadS [ListStateMachines]

readPrec :: ReadPrec ListStateMachines

readListPrec :: ReadPrec [ListStateMachines]

Show ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

showsPrec :: Int -> ListStateMachines -> ShowS

show :: ListStateMachines -> String

showList :: [ListStateMachines] -> ShowS

NFData ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

rnf :: ListStateMachines -> ()

Eq ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

(==) :: ListStateMachines -> ListStateMachines -> Bool

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

Hashable ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

hashWithSalt :: Int -> ListStateMachines -> Int

hash :: ListStateMachines -> Int

type AWSResponse ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

type AWSResponse ListStateMachines = ListStateMachinesResponse

type Rep ListStateMachines

Defined in Amazonka.StepFunctions.ListStateMachines

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

newListStateMachines :: ListStateMachines

Create a value of ListStateMachines 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:ListStateMachines', listStateMachines_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.

ListStateMachines, listStateMachines_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.

Request Lenses

listStateMachines_maxResults :: Lens' ListStateMachines (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.

listStateMachines_nextToken :: Lens' ListStateMachines (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.

Destructuring the Response

data ListStateMachinesResponse

See: newListStateMachinesResponse smart constructor.

Constructors

ListStateMachinesResponse'

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.

• stateMachines :: [StateMachineListItem]

Instances

Generic ListStateMachinesResponse

Defined in Amazonka.StepFunctions.ListStateMachines

Associated Types

type Rep ListStateMachinesResponse :: Type -> Type

Methods

from :: ListStateMachinesResponse -> Rep ListStateMachinesResponse x

to :: Rep ListStateMachinesResponse x -> ListStateMachinesResponse

Read ListStateMachinesResponse

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

readsPrec :: Int -> ReadS ListStateMachinesResponse

readList :: ReadS [ListStateMachinesResponse]

readPrec :: ReadPrec ListStateMachinesResponse

readListPrec :: ReadPrec [ListStateMachinesResponse]

Show ListStateMachinesResponse

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

showsPrec :: Int -> ListStateMachinesResponse -> ShowS

show :: ListStateMachinesResponse -> String

showList :: [ListStateMachinesResponse] -> ShowS

NFData ListStateMachinesResponse

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

rnf :: ListStateMachinesResponse -> ()

Eq ListStateMachinesResponse

Defined in Amazonka.StepFunctions.ListStateMachines

Methods

(==) :: ListStateMachinesResponse -> ListStateMachinesResponse -> Bool

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

type Rep ListStateMachinesResponse

Defined in Amazonka.StepFunctions.ListStateMachines

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

newListStateMachinesResponse

Arguments

:: Int

$sel:httpStatus:ListStateMachinesResponse'

-> ListStateMachinesResponse

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

ListStateMachines, listStateMachinesResponse_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:ListStateMachinesResponse', listStateMachinesResponse_httpStatus - The response's http status code.

$sel:stateMachines:ListStateMachinesResponse', listStateMachinesResponse_stateMachines - Undocumented member.

Response Lenses

listStateMachinesResponse_nextToken :: Lens' ListStateMachinesResponse (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.

listStateMachinesResponse_httpStatus :: Lens' ListStateMachinesResponse Int

The response's http status code.

listStateMachinesResponse_stateMachines :: Lens' ListStateMachinesResponse [StateMachineListItem]

Undocumented member.