Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
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 doesn't 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 is set to OPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide .
This operation returns paginated results.
- listWorkflowTypes :: Text -> RegistrationStatus -> ListWorkflowTypes
- data ListWorkflowTypes
- lwtNextPageToken :: Lens' ListWorkflowTypes (Maybe Text)
- lwtReverseOrder :: Lens' ListWorkflowTypes (Maybe Bool)
- lwtName :: Lens' ListWorkflowTypes (Maybe Text)
- lwtMaximumPageSize :: Lens' ListWorkflowTypes (Maybe Natural)
- lwtDomain :: Lens' ListWorkflowTypes Text
- lwtRegistrationStatus :: Lens' ListWorkflowTypes RegistrationStatus
- listWorkflowTypesResponse :: Int -> ListWorkflowTypesResponse
- data ListWorkflowTypesResponse
- lwtrsNextPageToken :: Lens' ListWorkflowTypesResponse (Maybe Text)
- lwtrsResponseStatus :: Lens' ListWorkflowTypesResponse Int
- lwtrsTypeInfos :: Lens' ListWorkflowTypesResponse [WorkflowTypeInfo]
Creating a Request
Creates a value of ListWorkflowTypes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lwtNextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged. The configuredmaximumPageSize
determines how many results can be returned in a single call.lwtReverseOrder
- When set totrue
, returns the results in reverse order. By default the results are returned in ascending alphabetical order of thename
of the workflow types.lwtName
- If specified, lists the workflow type with this name.lwtMaximumPageSize
- The maximum number of results that are 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.lwtDomain
- The name of the domain in which the workflow types have been registered.lwtRegistrationStatus
- Specifies the registration status of the workflow types to list.
data ListWorkflowTypes Source #
See: listWorkflowTypes
smart constructor.
Request Lenses
lwtNextPageToken :: Lens' ListWorkflowTypes (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.
lwtReverseOrder :: Lens' ListWorkflowTypes (Maybe Bool) Source #
When set to true
, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name
of the workflow types.
lwtName :: Lens' ListWorkflowTypes (Maybe Text) Source #
If specified, lists the workflow type with this name.
lwtMaximumPageSize :: Lens' ListWorkflowTypes (Maybe Natural) Source #
The maximum number of results that are 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.
lwtDomain :: Lens' ListWorkflowTypes Text Source #
The name of the domain in which the workflow types have been registered.
lwtRegistrationStatus :: Lens' ListWorkflowTypes RegistrationStatus Source #
Specifies the registration status of the workflow types to list.
Destructuring the Response
listWorkflowTypesResponse Source #
Creates a value of ListWorkflowTypesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lwtrsNextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged. The configuredmaximumPageSize
determines how many results can be returned in a single call.lwtrsResponseStatus
- -- | The response status code.lwtrsTypeInfos
- The list of workflow type information.
data ListWorkflowTypesResponse Source #
Contains a paginated list of information structures about workflow types.
See: listWorkflowTypesResponse
smart constructor.
Response Lenses
lwtrsNextPageToken :: Lens' ListWorkflowTypesResponse (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.
lwtrsResponseStatus :: Lens' ListWorkflowTypesResponse Int Source #
- - | The response status code.
lwtrsTypeInfos :: Lens' ListWorkflowTypesResponse [WorkflowTypeInfo] Source #
The list of workflow type information.