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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 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 ListWorkflowTypes = ListWorkflowTypes' {
- maximumPageSize :: Maybe Natural
- name :: Maybe Text
- nextPageToken :: Maybe Text
- reverseOrder :: Maybe Bool
- domain :: Text
- registrationStatus :: RegistrationStatus
}
newListWorkflowTypes :: Text -> RegistrationStatus -> ListWorkflowTypes
listWorkflowTypes_maximumPageSize :: Lens' ListWorkflowTypes (Maybe Natural)
listWorkflowTypes_name :: Lens' ListWorkflowTypes (Maybe Text)
listWorkflowTypes_nextPageToken :: Lens' ListWorkflowTypes (Maybe Text)
listWorkflowTypes_reverseOrder :: Lens' ListWorkflowTypes (Maybe Bool)
listWorkflowTypes_domain :: Lens' ListWorkflowTypes Text
listWorkflowTypes_registrationStatus :: Lens' ListWorkflowTypes RegistrationStatus
data ListWorkflowTypesResponse = ListWorkflowTypesResponse' {
- nextPageToken :: Maybe Text
- httpStatus :: Int
- typeInfos :: [WorkflowTypeInfo]
}
newListWorkflowTypesResponse :: Int -> ListWorkflowTypesResponse
listWorkflowTypesResponse_nextPageToken :: Lens' ListWorkflowTypesResponse (Maybe Text)
listWorkflowTypesResponse_httpStatus :: Lens' ListWorkflowTypesResponse Int
listWorkflowTypesResponse_typeInfos :: Lens' ListWorkflowTypesResponse [WorkflowTypeInfo]

Creating a Request

data ListWorkflowTypes Source #

See: newListWorkflowTypes smart constructor.

Constructors

ListWorkflowTypes'

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, lists the workflow type with 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 of the name of the workflow types.
domain :: Text
The name of the domain in which the workflow types have been registered.
registrationStatus :: RegistrationStatus
Specifies the registration status of the workflow types to list.

Instances

Instances details

ToJSON ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods toJSON :: ListWorkflowTypes -> Value # toEncoding :: ListWorkflowTypes -> Encoding # toJSONList :: [ListWorkflowTypes] -> Value # toEncodingList :: [ListWorkflowTypes] -> Encoding #
ToHeaders ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods toHeaders :: ListWorkflowTypes -> [Header] #
ToPath ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods toPath :: ListWorkflowTypes -> ByteString #
ToQuery ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods toQuery :: ListWorkflowTypes -> QueryString #
AWSPager ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods page :: ListWorkflowTypes -> AWSResponse ListWorkflowTypes -> Maybe ListWorkflowTypes #
AWSRequest ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Associated Types type AWSResponse ListWorkflowTypes # Methods request :: (Service -> Service) -> ListWorkflowTypes -> Request ListWorkflowTypes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListWorkflowTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListWorkflowTypes))) #
Generic ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Associated Types type Rep ListWorkflowTypes :: Type -> Type # Methods from :: ListWorkflowTypes -> Rep ListWorkflowTypes x # to :: Rep ListWorkflowTypes x -> ListWorkflowTypes #
Read ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods readsPrec :: Int -> ReadS ListWorkflowTypes # readList :: ReadS [ListWorkflowTypes] # readPrec :: ReadPrec ListWorkflowTypes # readListPrec :: ReadPrec [ListWorkflowTypes] #
Show ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods showsPrec :: Int -> ListWorkflowTypes -> ShowS # show :: ListWorkflowTypes -> String # showList :: [ListWorkflowTypes] -> ShowS #
NFData ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods rnf :: ListWorkflowTypes -> () #
Eq ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods (==) :: ListWorkflowTypes -> ListWorkflowTypes -> Bool # (/=) :: ListWorkflowTypes -> ListWorkflowTypes -> Bool #
Hashable ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods hashWithSalt :: Int -> ListWorkflowTypes -> Int # hash :: ListWorkflowTypes -> Int #
type AWSResponse ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes type AWSResponse ListWorkflowTypes = ListWorkflowTypesResponse
type Rep ListWorkflowTypes Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes type Rep ListWorkflowTypes = D1 ('MetaData "ListWorkflowTypes" "Amazonka.SWF.ListWorkflowTypes" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "ListWorkflowTypes'" '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)))))

newListWorkflowTypes Source #

Arguments

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

Create a value of ListWorkflowTypes 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:ListWorkflowTypes', listWorkflowTypes_maximumPageSize - The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

ListWorkflowTypes, listWorkflowTypes_name - If specified, lists the workflow type with this name.

ListWorkflowTypes, listWorkflowTypes_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:ListWorkflowTypes', listWorkflowTypes_reverseOrder - 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.

$sel:domain:ListWorkflowTypes', listWorkflowTypes_domain - The name of the domain in which the workflow types have been registered.

$sel:registrationStatus:ListWorkflowTypes', listWorkflowTypes_registrationStatus - Specifies the registration status of the workflow types to list.

Request Lenses

listWorkflowTypes_maximumPageSize :: Lens' ListWorkflowTypes (Maybe Natural) Source #

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

listWorkflowTypes_name :: Lens' ListWorkflowTypes (Maybe Text) Source #

If specified, lists the workflow type with this name.

listWorkflowTypes_nextPageToken :: Lens' ListWorkflowTypes (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.

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

listWorkflowTypes_domain :: Lens' ListWorkflowTypes Text Source #

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

listWorkflowTypes_registrationStatus :: Lens' ListWorkflowTypes RegistrationStatus Source #

Specifies the registration status of the workflow types to list.

Destructuring the Response

data ListWorkflowTypesResponse Source #

Contains a paginated list of information structures about workflow types.

See: newListWorkflowTypesResponse smart constructor.

Constructors

ListWorkflowTypesResponse'

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 :: [WorkflowTypeInfo]
The list of workflow type information.

Instances

Instances details

Generic ListWorkflowTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Associated Types type Rep ListWorkflowTypesResponse :: Type -> Type # Methods from :: ListWorkflowTypesResponse -> Rep ListWorkflowTypesResponse x # to :: Rep ListWorkflowTypesResponse x -> ListWorkflowTypesResponse #
Read ListWorkflowTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods readsPrec :: Int -> ReadS ListWorkflowTypesResponse # readList :: ReadS [ListWorkflowTypesResponse] # readPrec :: ReadPrec ListWorkflowTypesResponse # readListPrec :: ReadPrec [ListWorkflowTypesResponse] #
Show ListWorkflowTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods showsPrec :: Int -> ListWorkflowTypesResponse -> ShowS # show :: ListWorkflowTypesResponse -> String # showList :: [ListWorkflowTypesResponse] -> ShowS #
NFData ListWorkflowTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods rnf :: ListWorkflowTypesResponse -> () #
Eq ListWorkflowTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes Methods (==) :: ListWorkflowTypesResponse -> ListWorkflowTypesResponse -> Bool # (/=) :: ListWorkflowTypesResponse -> ListWorkflowTypesResponse -> Bool #
type Rep ListWorkflowTypesResponse Source #
Instance details Defined in Amazonka.SWF.ListWorkflowTypes type Rep ListWorkflowTypesResponse = D1 ('MetaData "ListWorkflowTypesResponse" "Amazonka.SWF.ListWorkflowTypes" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "ListWorkflowTypesResponse'" '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 [WorkflowTypeInfo]))))

newListWorkflowTypesResponse Source #

Arguments

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

Create a value of ListWorkflowTypesResponse 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:

ListWorkflowTypes, listWorkflowTypesResponse_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:ListWorkflowTypesResponse', listWorkflowTypesResponse_httpStatus - The response's http status code.

$sel:typeInfos:ListWorkflowTypesResponse', listWorkflowTypesResponse_typeInfos - The list of workflow type information.

Response Lenses

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

listWorkflowTypesResponse_httpStatus :: Lens' ListWorkflowTypesResponse Int Source #

The response's http status code.

listWorkflowTypesResponse_typeInfos :: Lens' ListWorkflowTypesResponse [WorkflowTypeInfo] Source #

The list of workflow type information.