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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

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. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.
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 ListDomains = ListDomains' {
- maximumPageSize :: Maybe Natural
- nextPageToken :: Maybe Text
- reverseOrder :: Maybe Bool
- registrationStatus :: RegistrationStatus
}
newListDomains :: RegistrationStatus -> ListDomains
listDomains_maximumPageSize :: Lens' ListDomains (Maybe Natural)
listDomains_nextPageToken :: Lens' ListDomains (Maybe Text)
listDomains_reverseOrder :: Lens' ListDomains (Maybe Bool)
listDomains_registrationStatus :: Lens' ListDomains RegistrationStatus
data ListDomainsResponse = ListDomainsResponse' {
- nextPageToken :: Maybe Text
- httpStatus :: Int
- domainInfos :: [DomainInfo]
}
newListDomainsResponse :: Int -> ListDomainsResponse
listDomainsResponse_nextPageToken :: Lens' ListDomainsResponse (Maybe Text)
listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int
listDomainsResponse_domainInfos :: Lens' ListDomainsResponse [DomainInfo]

Creating a Request

data ListDomains Source #

See: newListDomains smart constructor.

Constructors

ListDomains'

Fields

maximumPageSize :: Maybe Natural
The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
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 domains.
registrationStatus :: RegistrationStatus
Specifies the registration status of the domains to list.

Instances

Instances details

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

newListDomains Source #

Arguments

:: RegistrationStatus	`$sel:registrationStatus:ListDomains'`
-> ListDomains

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

ListDomains, listDomains_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:ListDomains', listDomains_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 domains.

$sel:registrationStatus:ListDomains', listDomains_registrationStatus - Specifies the registration status of the domains to list.

Request Lenses

listDomains_maximumPageSize :: Lens' ListDomains (Maybe Natural) Source #

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

listDomains_nextPageToken :: Lens' ListDomains (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.

listDomains_reverseOrder :: Lens' ListDomains (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 domains.

listDomains_registrationStatus :: Lens' ListDomains RegistrationStatus Source #

Specifies the registration status of the domains to list.

Destructuring the Response

data ListDomainsResponse Source #

Contains a paginated collection of DomainInfo structures.

See: newListDomainsResponse smart constructor.

Constructors

ListDomainsResponse'

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.
domainInfos :: [DomainInfo]
A list of DomainInfo structures.

Instances

Instances details

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

newListDomainsResponse Source #

Arguments

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

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

ListDomains, listDomainsResponse_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:ListDomainsResponse', listDomainsResponse_httpStatus - The response's http status code.

$sel:domainInfos:ListDomainsResponse', listDomainsResponse_domainInfos - A list of DomainInfo structures.

Response Lenses

listDomainsResponse_nextPageToken :: Lens' ListDomainsResponse (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.

listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #

The response's http status code.

listDomainsResponse_domainInfos :: Lens' ListDomainsResponse [DomainInfo] Source #

A list of DomainInfo structures.