Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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

Synopsis

data ListActivityTypes = ListActivityTypes' {
- maximumPageSize :: Maybe Natural
- name :: Maybe Text
- nextPageToken :: Maybe Text
- reverseOrder :: Maybe Bool
- domain :: Text
- registrationStatus :: RegistrationStatus
}
newListActivityTypes :: Text -> RegistrationStatus -> ListActivityTypes
listActivityTypes_maximumPageSize :: Lens' ListActivityTypes (Maybe Natural)
listActivityTypes_name :: Lens' ListActivityTypes (Maybe Text)
listActivityTypes_nextPageToken :: Lens' ListActivityTypes (Maybe Text)
listActivityTypes_reverseOrder :: Lens' ListActivityTypes (Maybe Bool)
listActivityTypes_domain :: Lens' ListActivityTypes Text
listActivityTypes_registrationStatus :: Lens' ListActivityTypes RegistrationStatus
data ListActivityTypesResponse = ListActivityTypesResponse' {
- nextPageToken :: Maybe Text
- httpStatus :: Int
- typeInfos :: [ActivityTypeInfo]
}
newListActivityTypesResponse :: Int -> ListActivityTypesResponse
listActivityTypesResponse_nextPageToken :: Lens' ListActivityTypesResponse (Maybe Text)
listActivityTypesResponse_httpStatus :: Lens' ListActivityTypesResponse Int
listActivityTypesResponse_typeInfos :: Lens' ListActivityTypesResponse [ActivityTypeInfo]

Creating a Request

data ListActivityTypes Source #

See: newListActivityTypes smart constructor.

Constructors

ListActivityTypes'

Fields

maximumPageSize :: Maybe Natural
The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
name :: Maybe Text
If specified, only lists the activity types that have this name.
nextPageToken :: Maybe Text
If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
reverseOrder :: 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.
domain :: Text
The name of the domain in which the activity types have been registered.
registrationStatus :: RegistrationStatus
Specifies the registration status of the activity types to list.

Instances

Instances details

ToJSON ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods toJSON :: ListActivityTypes -> Value # toEncoding :: ListActivityTypes -> Encoding # toJSONList :: [ListActivityTypes] -> Value # toEncodingList :: [ListActivityTypes] -> Encoding #
ToHeaders ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods toHeaders :: ListActivityTypes -> [Header] #
ToPath ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods toPath :: ListActivityTypes -> ByteString #
ToQuery ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods toQuery :: ListActivityTypes -> QueryString #
AWSPager ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods page :: ListActivityTypes -> AWSResponse ListActivityTypes -> Maybe ListActivityTypes #
AWSRequest ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Associated Types type AWSResponse ListActivityTypes # Methods request :: (Service -> Service) -> ListActivityTypes -> Request ListActivityTypes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListActivityTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListActivityTypes))) #
Generic ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Associated Types type Rep ListActivityTypes :: Type -> Type # Methods from :: ListActivityTypes -> Rep ListActivityTypes x # to :: Rep ListActivityTypes x -> ListActivityTypes #
Read ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods readsPrec :: Int -> ReadS ListActivityTypes # readList :: ReadS [ListActivityTypes] # readPrec :: ReadPrec ListActivityTypes # readListPrec :: ReadPrec [ListActivityTypes] #
Show ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods showsPrec :: Int -> ListActivityTypes -> ShowS # show :: ListActivityTypes -> String # showList :: [ListActivityTypes] -> ShowS #
NFData ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods rnf :: ListActivityTypes -> () #
Eq ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods (==) :: ListActivityTypes -> ListActivityTypes -> Bool # (/=) :: ListActivityTypes -> ListActivityTypes -> Bool #
Hashable ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods hashWithSalt :: Int -> ListActivityTypes -> Int # hash :: ListActivityTypes -> Int #
type AWSResponse ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes type AWSResponse ListActivityTypes = ListActivityTypesResponse
type Rep ListActivityTypes Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes type Rep ListActivityTypes = D1 ('MetaData "ListActivityTypes" "Amazonka.SWF.ListActivityTypes" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "ListActivityTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maximumPageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "reverseOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "registrationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RegistrationStatus)))))

newListActivityTypes Source #

Arguments

:: Text	`$sel:domain:ListActivityTypes'`
-> RegistrationStatus	`$sel:registrationStatus:ListActivityTypes'`
-> ListActivityTypes

Create a value of ListActivityTypes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maximumPageSize:ListActivityTypes', listActivityTypes_maximumPageSize - The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

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

ListActivityTypes, listActivityTypes_nextPageToken - If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

$sel:reverseOrder:ListActivityTypes', listActivityTypes_reverseOrder - 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.

$sel:domain:ListActivityTypes', listActivityTypes_domain - The name of the domain in which the activity types have been registered.

$sel:registrationStatus:ListActivityTypes', listActivityTypes_registrationStatus - Specifies the registration status of the activity types to list.

Request Lenses

listActivityTypes_maximumPageSize :: Lens' ListActivityTypes (Maybe Natural) Source #

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

listActivityTypes_name :: Lens' ListActivityTypes (Maybe Text) Source #

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

listActivityTypes_nextPageToken :: Lens' ListActivityTypes (Maybe Text) Source #

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

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

listActivityTypes_domain :: Lens' ListActivityTypes Text Source #

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

listActivityTypes_registrationStatus :: Lens' ListActivityTypes RegistrationStatus Source #

Specifies the registration status of the activity types to list.

Destructuring the Response

data ListActivityTypesResponse Source #

Contains a paginated list of activity type information structures.

See: newListActivityTypesResponse smart constructor.

Constructors

ListActivityTypesResponse'

Fields

nextPageToken :: 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.
httpStatus :: Int
The response's http status code.
typeInfos :: [ActivityTypeInfo]
List of activity type information.

Instances

Instances details

Generic ListActivityTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Associated Types type Rep ListActivityTypesResponse :: Type -> Type # Methods from :: ListActivityTypesResponse -> Rep ListActivityTypesResponse x # to :: Rep ListActivityTypesResponse x -> ListActivityTypesResponse #
Read ListActivityTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods readsPrec :: Int -> ReadS ListActivityTypesResponse # readList :: ReadS [ListActivityTypesResponse] # readPrec :: ReadPrec ListActivityTypesResponse # readListPrec :: ReadPrec [ListActivityTypesResponse] #
Show ListActivityTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods showsPrec :: Int -> ListActivityTypesResponse -> ShowS # show :: ListActivityTypesResponse -> String # showList :: [ListActivityTypesResponse] -> ShowS #
NFData ListActivityTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods rnf :: ListActivityTypesResponse -> () #
Eq ListActivityTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes Methods (==) :: ListActivityTypesResponse -> ListActivityTypesResponse -> Bool # (/=) :: ListActivityTypesResponse -> ListActivityTypesResponse -> Bool #
type Rep ListActivityTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListActivityTypes type Rep ListActivityTypesResponse = D1 ('MetaData "ListActivityTypesResponse" "Amazonka.SWF.ListActivityTypes" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "ListActivityTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "typeInfos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ActivityTypeInfo]))))

newListActivityTypesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListActivityTypesResponse'`
-> ListActivityTypesResponse

Create a value of ListActivityTypesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListActivityTypes, listActivityTypesResponse_nextPageToken - 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.

$sel:httpStatus:ListActivityTypesResponse', listActivityTypesResponse_httpStatus - The response's http status code.

$sel:typeInfos:ListActivityTypesResponse', listActivityTypesResponse_typeInfos - List of activity type information.

Response Lenses

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

listActivityTypesResponse_httpStatus :: Lens' ListActivityTypesResponse Int Source #

The response's http status code.

listActivityTypesResponse_typeInfos :: Lens' ListActivityTypesResponse [ActivityTypeInfo] Source #

List of activity type information.