Amazonka.StepFunctions.ListActivities

Lists the existing activities.

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 ListActivities

See: newListActivities smart constructor.

Constructors

ListActivities'

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 ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

toJSON :: ListActivities -> Value

toEncoding :: ListActivities -> Encoding

toJSONList :: [ListActivities] -> Value

toEncodingList :: [ListActivities] -> Encoding

ToHeaders ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

toHeaders :: ListActivities -> [Header]

ToPath ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

toPath :: ListActivities -> ByteString

ToQuery ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

toQuery :: ListActivities -> QueryString

AWSPager ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

page :: ListActivities -> AWSResponse ListActivities -> Maybe ListActivities

AWSRequest ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Associated Types

type AWSResponse ListActivities

Methods

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

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

Generic ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Associated Types

type Rep ListActivities :: Type -> Type

Methods

from :: ListActivities -> Rep ListActivities x

to :: Rep ListActivities x -> ListActivities

Read ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

readsPrec :: Int -> ReadS ListActivities

readList :: ReadS [ListActivities]

readPrec :: ReadPrec ListActivities

readListPrec :: ReadPrec [ListActivities]

Show ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

showsPrec :: Int -> ListActivities -> ShowS

show :: ListActivities -> String

showList :: [ListActivities] -> ShowS

NFData ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

rnf :: ListActivities -> ()

Eq ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

(==) :: ListActivities -> ListActivities -> Bool

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

Hashable ListActivities

Defined in Amazonka.StepFunctions.ListActivities

Methods

hashWithSalt :: Int -> ListActivities -> Int

hash :: ListActivities -> Int

type AWSResponse ListActivities

Defined in Amazonka.StepFunctions.ListActivities

type AWSResponse ListActivities = ListActivitiesResponse

type Rep ListActivities

Defined in Amazonka.StepFunctions.ListActivities

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

newListActivities :: ListActivities

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

ListActivities, listActivities_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

listActivities_maxResults :: Lens' ListActivities (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.

listActivities_nextToken :: Lens' ListActivities (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 ListActivitiesResponse

See: newListActivitiesResponse smart constructor.

Constructors

ListActivitiesResponse'

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.

• activities :: [ActivityListItem]

  The list of activities.

Instances

Generic ListActivitiesResponse

Defined in Amazonka.StepFunctions.ListActivities

Associated Types

type Rep ListActivitiesResponse :: Type -> Type

Methods

from :: ListActivitiesResponse -> Rep ListActivitiesResponse x

to :: Rep ListActivitiesResponse x -> ListActivitiesResponse

Read ListActivitiesResponse

Defined in Amazonka.StepFunctions.ListActivities

Methods

readsPrec :: Int -> ReadS ListActivitiesResponse

readList :: ReadS [ListActivitiesResponse]

readPrec :: ReadPrec ListActivitiesResponse

readListPrec :: ReadPrec [ListActivitiesResponse]

Show ListActivitiesResponse

Defined in Amazonka.StepFunctions.ListActivities

Methods

showsPrec :: Int -> ListActivitiesResponse -> ShowS

show :: ListActivitiesResponse -> String

showList :: [ListActivitiesResponse] -> ShowS

NFData ListActivitiesResponse

Defined in Amazonka.StepFunctions.ListActivities

Methods

rnf :: ListActivitiesResponse -> ()

Eq ListActivitiesResponse

Defined in Amazonka.StepFunctions.ListActivities

Methods

(==) :: ListActivitiesResponse -> ListActivitiesResponse -> Bool

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

type Rep ListActivitiesResponse

Defined in Amazonka.StepFunctions.ListActivities

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

newListActivitiesResponse

Arguments

:: Int

$sel:httpStatus:ListActivitiesResponse'

-> ListActivitiesResponse

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

ListActivities, listActivitiesResponse_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:ListActivitiesResponse', listActivitiesResponse_httpStatus - The response's http status code.

$sel:activities:ListActivitiesResponse', listActivitiesResponse_activities - The list of activities.

Response Lenses

listActivitiesResponse_nextToken :: Lens' ListActivitiesResponse (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.

listActivitiesResponse_httpStatus :: Lens' ListActivitiesResponse Int

The response's http status code.

listActivitiesResponse_activities :: Lens' ListActivitiesResponse [ActivityListItem]

The list of activities.