Network.AWS.SWF.ListWorkflowTypes

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.

Creating a Request

listWorkflowTypes

Arguments

:: Text

lwtDomain

-> RegistrationStatus

lwtRegistrationStatus

-> 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
• lwtReverseOrder
• lwtName
• lwtMaximumPageSize
• lwtDomain
• lwtRegistrationStatus

data ListWorkflowTypes

See: listWorkflowTypes smart constructor.

Instances

Eq ListWorkflowTypes

Methods

(==) :: ListWorkflowTypes -> ListWorkflowTypes -> Bool

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

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

Methods

readsPrec :: Int -> ReadS ListWorkflowTypes

readList :: ReadS [ListWorkflowTypes]

readPrec :: ReadPrec ListWorkflowTypes

readListPrec :: ReadPrec [ListWorkflowTypes]

Show ListWorkflowTypes

Methods

showsPrec :: Int -> ListWorkflowTypes -> ShowS

show :: ListWorkflowTypes -> String

showList :: [ListWorkflowTypes] -> ShowS

Generic ListWorkflowTypes

Associated Types

type Rep ListWorkflowTypes :: * -> *

Methods

from :: ListWorkflowTypes -> Rep ListWorkflowTypes x

to :: Rep ListWorkflowTypes x -> ListWorkflowTypes

ToJSON ListWorkflowTypes

Methods

toJSON :: ListWorkflowTypes -> Value

toEncoding :: ListWorkflowTypes -> Encoding

Hashable ListWorkflowTypes

Methods

hashWithSalt :: Int -> ListWorkflowTypes -> Int

hash :: ListWorkflowTypes -> Int

NFData ListWorkflowTypes

Methods

rnf :: ListWorkflowTypes -> ()

AWSPager ListWorkflowTypes

Methods

page :: ListWorkflowTypes -> Rs ListWorkflowTypes -> Maybe ListWorkflowTypes

AWSRequest ListWorkflowTypes

Associated Types

type Rs ListWorkflowTypes :: *

Methods

request :: ListWorkflowTypes -> Request ListWorkflowTypes

response :: MonadResource m => Logger -> Service -> Proxy * ListWorkflowTypes -> ClientResponse -> m (Response ListWorkflowTypes)

ToPath ListWorkflowTypes

Methods

toPath :: ListWorkflowTypes -> ByteString

ToHeaders ListWorkflowTypes

Methods

toHeaders :: ListWorkflowTypes -> [Header]

ToQuery ListWorkflowTypes

Methods

toQuery :: ListWorkflowTypes -> QueryString

type Rep ListWorkflowTypes

type Rep ListWorkflowTypes = D1 (MetaData "ListWorkflowTypes" "Network.AWS.SWF.ListWorkflowTypes" "amazonka-swf-1.4.2-KpvHtdRerYm5jnqWL346YW" 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

type Rs ListWorkflowTypes = ListWorkflowTypesResponse

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

Arguments

:: Int

lwtrsResponseStatus

-> 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
• lwtrsResponseStatus
• lwtrsTypeInfos

data ListWorkflowTypesResponse

Contains a paginated list of information structures about workflow types.

See: listWorkflowTypesResponse smart constructor.

Instances

Eq ListWorkflowTypesResponse

Methods

(==) :: ListWorkflowTypesResponse -> ListWorkflowTypesResponse -> Bool

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

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

Methods

readsPrec :: Int -> ReadS ListWorkflowTypesResponse

readList :: ReadS [ListWorkflowTypesResponse]

readPrec :: ReadPrec ListWorkflowTypesResponse

readListPrec :: ReadPrec [ListWorkflowTypesResponse]

Show ListWorkflowTypesResponse

Methods

showsPrec :: Int -> ListWorkflowTypesResponse -> ShowS

show :: ListWorkflowTypesResponse -> String

showList :: [ListWorkflowTypesResponse] -> ShowS

Generic ListWorkflowTypesResponse

Associated Types

type Rep ListWorkflowTypesResponse :: * -> *

Methods

from :: ListWorkflowTypesResponse -> Rep ListWorkflowTypesResponse x

to :: Rep ListWorkflowTypesResponse x -> ListWorkflowTypesResponse

NFData ListWorkflowTypesResponse

Methods

rnf :: ListWorkflowTypesResponse -> ()

type Rep ListWorkflowTypesResponse

type Rep ListWorkflowTypesResponse = D1 (MetaData "ListWorkflowTypesResponse" "Network.AWS.SWF.ListWorkflowTypes" "amazonka-swf-1.4.2-KpvHtdRerYm5jnqWL346YW" False) (C1 (MetaCons "ListWorkflowTypesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lwtrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lwtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.