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

Network.AWS.SWF.ListActivityTypes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

listActivityTypes #

Arguments

:: Text	`latDomain`
-> RegistrationStatus	`latRegistrationStatus`
-> ListActivityTypes

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:

latNextPageToken - 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 - 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 - If specified, only lists the activity types that have this name.
latMaximumPageSize - 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.
latDomain - The name of the domain in which the activity types have been registered.
latRegistrationStatus - Specifies the registration status of the activity types to list.

data ListActivityTypes #

See: listActivityTypes smart constructor.

Instances

Eq ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods (==) :: ListActivityTypes -> ListActivityTypes -> Bool # (/=) :: ListActivityTypes -> ListActivityTypes -> Bool #
Data ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListActivityTypes -> c ListActivityTypes # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListActivityTypes # toConstr :: ListActivityTypes -> Constr # dataTypeOf :: ListActivityTypes -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListActivityTypes) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListActivityTypes) # gmapT :: (forall b. Data b => b -> b) -> ListActivityTypes -> ListActivityTypes # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListActivityTypes -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListActivityTypes -> r # gmapQ :: (forall d. Data d => d -> u) -> ListActivityTypes -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListActivityTypes -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListActivityTypes -> m ListActivityTypes # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListActivityTypes -> m ListActivityTypes # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListActivityTypes -> m ListActivityTypes #
Read ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods readsPrec :: Int -> ReadS ListActivityTypes # readList :: ReadS [ListActivityTypes] # readPrec :: ReadPrec ListActivityTypes # readListPrec :: ReadPrec [ListActivityTypes] #
Show ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods showsPrec :: Int -> ListActivityTypes -> ShowS # show :: ListActivityTypes -> String # showList :: [ListActivityTypes] -> ShowS #
Generic ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Associated Types type Rep ListActivityTypes :: * -> * # Methods from :: ListActivityTypes -> Rep ListActivityTypes x # to :: Rep ListActivityTypes x -> ListActivityTypes #
Hashable ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods hashWithSalt :: Int -> ListActivityTypes -> Int # hash :: ListActivityTypes -> Int #
ToJSON ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods toJSON :: ListActivityTypes -> Value # toEncoding :: ListActivityTypes -> Encoding # toJSONList :: [ListActivityTypes] -> Value # toEncodingList :: [ListActivityTypes] -> Encoding #
AWSPager ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods page :: ListActivityTypes -> Rs ListActivityTypes -> Maybe ListActivityTypes #
AWSRequest ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Associated Types type Rs ListActivityTypes :: * # Methods request :: ListActivityTypes -> Request ListActivityTypes # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListActivityTypes -> ClientResponse -> m (Response ListActivityTypes) #
ToHeaders ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods toHeaders :: ListActivityTypes -> [Header] #
ToPath ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods toPath :: ListActivityTypes -> ByteString #
ToQuery ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods toQuery :: ListActivityTypes -> QueryString #
NFData ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods rnf :: ListActivityTypes -> () #
type Rep ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes type Rep ListActivityTypes = D1 (MetaData "ListActivityTypes" "Network.AWS.SWF.ListActivityTypes" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "ListActivityTypes'" PrefixI True) ((S1 (MetaSel (Just "_latNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_latReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_latName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_latMaximumPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: (S1 (MetaSel (Just "_latDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_latRegistrationStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RegistrationStatus)))))
type Rs ListActivityTypes #
Instance details Defined in Network.AWS.SWF.ListActivityTypes type Rs ListActivityTypes = ListActivityTypesResponse

Request Lenses

latNextPageToken :: Lens' ListActivityTypes (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.

latReverseOrder :: Lens' ListActivityTypes (Maybe Bool) #

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

If specified, only lists the activity types that have this name.

latMaximumPageSize :: Lens' ListActivityTypes (Maybe Natural) #

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.

latDomain :: Lens' ListActivityTypes Text #

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

latRegistrationStatus :: Lens' ListActivityTypes RegistrationStatus #

Specifies the registration status of the activity types to list.

Destructuring the Response

listActivityTypesResponse #

Arguments

:: Int	`latrsResponseStatus`
-> ListActivityTypesResponse

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:

latrsNextPageToken - 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.
latrsResponseStatus - -- | The response status code.
latrsTypeInfos - List of activity type information.

data ListActivityTypesResponse #

Contains a paginated list of activity type information structures.

See: listActivityTypesResponse smart constructor.

Instances

Eq ListActivityTypesResponse #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods (==) :: ListActivityTypesResponse -> ListActivityTypesResponse -> Bool # (/=) :: ListActivityTypesResponse -> ListActivityTypesResponse -> Bool #
Data ListActivityTypesResponse #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListActivityTypesResponse -> c ListActivityTypesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListActivityTypesResponse # toConstr :: ListActivityTypesResponse -> Constr # dataTypeOf :: ListActivityTypesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListActivityTypesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListActivityTypesResponse) # gmapT :: (forall b. Data b => b -> b) -> ListActivityTypesResponse -> ListActivityTypesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListActivityTypesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListActivityTypesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListActivityTypesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListActivityTypesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListActivityTypesResponse -> m ListActivityTypesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListActivityTypesResponse -> m ListActivityTypesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListActivityTypesResponse -> m ListActivityTypesResponse #
Read ListActivityTypesResponse #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods readsPrec :: Int -> ReadS ListActivityTypesResponse # readList :: ReadS [ListActivityTypesResponse] # readPrec :: ReadPrec ListActivityTypesResponse # readListPrec :: ReadPrec [ListActivityTypesResponse] #
Show ListActivityTypesResponse #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods showsPrec :: Int -> ListActivityTypesResponse -> ShowS # show :: ListActivityTypesResponse -> String # showList :: [ListActivityTypesResponse] -> ShowS #
Generic ListActivityTypesResponse #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Associated Types type Rep ListActivityTypesResponse :: * -> * # Methods from :: ListActivityTypesResponse -> Rep ListActivityTypesResponse x # to :: Rep ListActivityTypesResponse x -> ListActivityTypesResponse #
NFData ListActivityTypesResponse #
Instance details Defined in Network.AWS.SWF.ListActivityTypes Methods rnf :: ListActivityTypesResponse -> () #
type Rep ListActivityTypesResponse #
Instance details Defined in Network.AWS.SWF.ListActivityTypes type Rep ListActivityTypesResponse = D1 (MetaData "ListActivityTypesResponse" "Network.AWS.SWF.ListActivityTypes" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "ListActivityTypesResponse'" PrefixI True) (S1 (MetaSel (Just "_latrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_latrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: S1 (MetaSel (Just "_latrsTypeInfos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ActivityTypeInfo]))))

Response Lenses

latrsNextPageToken :: Lens' ListActivityTypesResponse (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.

latrsResponseStatus :: Lens' ListActivityTypesResponse Int #

- | The response status code.

latrsTypeInfos :: Lens' ListActivityTypesResponse [ActivityTypeInfo] #

List of activity type information.