amazonka-swf-1.4.5: Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SWF.ListWorkflowTypes

Contents

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

listWorkflowTypes #

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 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 - 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 - If specified, lists the workflow type with this name.
  • lwtMaximumPageSize - 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.
  • 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 #

See: listWorkflowTypes smart constructor.

Instances

Eq ListWorkflowTypes # 
Data ListWorkflowTypes # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListWorkflowTypes -> c ListWorkflowTypes #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListWorkflowTypes #

toConstr :: ListWorkflowTypes -> Constr #

dataTypeOf :: ListWorkflowTypes -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListWorkflowTypes) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListWorkflowTypes) #

gmapT :: (forall b. Data b => b -> b) -> ListWorkflowTypes -> ListWorkflowTypes #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListWorkflowTypes -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListWorkflowTypes -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListWorkflowTypes -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListWorkflowTypes -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListWorkflowTypes -> m ListWorkflowTypes #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListWorkflowTypes -> m ListWorkflowTypes #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListWorkflowTypes -> m ListWorkflowTypes #

Read ListWorkflowTypes # 
Show ListWorkflowTypes # 
Generic ListWorkflowTypes # 
Hashable ListWorkflowTypes # 
ToJSON ListWorkflowTypes # 
NFData ListWorkflowTypes # 

Methods

rnf :: ListWorkflowTypes -> () #

AWSPager ListWorkflowTypes # 
AWSRequest ListWorkflowTypes # 
ToQuery ListWorkflowTypes # 
ToPath ListWorkflowTypes # 
ToHeaders ListWorkflowTypes # 
type Rep ListWorkflowTypes # 
type Rep ListWorkflowTypes = D1 (MetaData "ListWorkflowTypes" "Network.AWS.SWF.ListWorkflowTypes" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "ListWorkflowTypes'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lwtNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lwtReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_lwtName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_lwtMaximumPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_lwtDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_lwtRegistrationStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RegistrationStatus))))))
type Rs ListWorkflowTypes # 

Request Lenses

lwtNextPageToken :: Lens' ListWorkflowTypes (Maybe Text) #

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) #

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) #

If specified, lists the workflow type with this name.

lwtMaximumPageSize :: Lens' ListWorkflowTypes (Maybe Natural) #

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.

lwtDomain :: Lens' ListWorkflowTypes Text #

The name of the domain in which the workflow types have been registered.

lwtRegistrationStatus :: Lens' ListWorkflowTypes RegistrationStatus #

Specifies the registration status of the workflow types to list.

Destructuring the Response

listWorkflowTypesResponse #

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 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 - -- | The response status code.
  • lwtrsTypeInfos - The list of workflow type information.

data ListWorkflowTypesResponse #

Contains a paginated list of information structures about workflow types.

See: listWorkflowTypesResponse smart constructor.

Instances

Eq ListWorkflowTypesResponse # 
Data ListWorkflowTypesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListWorkflowTypesResponse -> c ListWorkflowTypesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListWorkflowTypesResponse #

toConstr :: ListWorkflowTypesResponse -> Constr #

dataTypeOf :: ListWorkflowTypesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListWorkflowTypesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListWorkflowTypesResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListWorkflowTypesResponse -> ListWorkflowTypesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListWorkflowTypesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListWorkflowTypesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListWorkflowTypesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListWorkflowTypesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListWorkflowTypesResponse -> m ListWorkflowTypesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListWorkflowTypesResponse -> m ListWorkflowTypesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListWorkflowTypesResponse -> m ListWorkflowTypesResponse #

Read ListWorkflowTypesResponse # 
Show ListWorkflowTypesResponse # 
Generic ListWorkflowTypesResponse # 
NFData ListWorkflowTypesResponse # 
type Rep ListWorkflowTypesResponse # 
type Rep ListWorkflowTypesResponse = D1 (MetaData "ListWorkflowTypesResponse" "Network.AWS.SWF.ListWorkflowTypes" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "ListWorkflowTypesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lwtrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lwtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_lwtrsTypeInfos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [WorkflowTypeInfo])))))

Response Lenses

lwtrsNextPageToken :: Lens' ListWorkflowTypesResponse (Maybe Text) #

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 #

  • - | The response status code.

lwtrsTypeInfos :: Lens' ListWorkflowTypesResponse [WorkflowTypeInfo] #

The list of workflow type information.