Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns information about all activities registered in the specified
domain that match the specified name and registration status. The result
includes information like creation date, current status of the activity,
etc. The results may be split into multiple pages. To retrieve
subsequent pages, make the call again using the nextPageToken
returned
by the initial call.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
- Use a
Resource
element with the domain name to limit the action to only specified domains. - Use an
Action
element to allow or deny permission to call this action. - You cannot use an IAM policy to constrain this action's parameters.
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
See: AWS API Reference for ListActivityTypes.
This operation returns paginated results.
- listActivityTypes :: Text -> RegistrationStatus -> ListActivityTypes
- data ListActivityTypes
- latNextPageToken :: Lens' ListActivityTypes (Maybe Text)
- latReverseOrder :: Lens' ListActivityTypes (Maybe Bool)
- latName :: Lens' ListActivityTypes (Maybe Text)
- latMaximumPageSize :: Lens' ListActivityTypes (Maybe Natural)
- latDomain :: Lens' ListActivityTypes Text
- latRegistrationStatus :: Lens' ListActivityTypes RegistrationStatus
- listActivityTypesResponse :: Int -> ListActivityTypesResponse
- data ListActivityTypesResponse
- latrsNextPageToken :: Lens' ListActivityTypesResponse (Maybe Text)
- latrsStatus :: Lens' ListActivityTypesResponse Int
- latrsTypeInfos :: Lens' ListActivityTypesResponse [ActivityTypeInfo]
Creating a Request
Creates a value of ListActivityTypes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListActivityTypes Source
See: listActivityTypes
smart constructor.
Request Lenses
latNextPageToken :: Lens' ListActivityTypes (Maybe Text) Source
If a NextPageToken
was returned by a previous call, there are more
results available. To retrieve the next page of results, make the call
again using the returned token in nextPageToken
. Keep all other
arguments unchanged.
The configured maximumPageSize
determines how many results can be
returned in a single call.
latReverseOrder :: Lens' ListActivityTypes (Maybe Bool) Source
When set to true
, returns the results in reverse order. By default,
the results are returned in ascending alphabetical order by name
of
the activity types.
latName :: Lens' ListActivityTypes (Maybe Text) Source
If specified, only lists the activity types that have this name.
latMaximumPageSize :: Lens' ListActivityTypes (Maybe Natural) Source
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results. The
default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
latDomain :: Lens' ListActivityTypes Text Source
The name of the domain in which the activity types have been registered.
latRegistrationStatus :: Lens' ListActivityTypes RegistrationStatus Source
Specifies the registration status of the activity types to list.
Destructuring the Response
listActivityTypesResponse Source
Creates a value of ListActivityTypesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListActivityTypesResponse Source
Contains a paginated list of activity type information structures.
See: listActivityTypesResponse
smart constructor.
Response Lenses
latrsNextPageToken :: Lens' ListActivityTypesResponse (Maybe Text) Source
If a NextPageToken
was returned by a previous call, there are more
results available. To retrieve the next page of results, make the call
again using the returned token in nextPageToken
. Keep all other
arguments unchanged.
The configured maximumPageSize
determines how many results can be
returned in a single call.
latrsStatus :: Lens' ListActivityTypesResponse Int Source
The response status code.
latrsTypeInfos :: Lens' ListActivityTypesResponse [ActivityTypeInfo] Source
List of activity type information.