Network.AWS.SWF.ListDomains

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

listDomains

Arguments

:: RegistrationStatus

ldRegistrationStatus

-> ListDomains

Creates a value of ListDomains with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ldNextPageToken
• ldReverseOrder
• ldMaximumPageSize
• ldRegistrationStatus

data ListDomains

See: listDomains smart constructor.

Instances

Eq ListDomains

Methods

(==) :: ListDomains -> ListDomains -> Bool

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

Data ListDomains

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListDomains -> c ListDomains

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListDomains

toConstr :: ListDomains -> Constr

dataTypeOf :: ListDomains -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListDomains)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListDomains)

gmapT :: (forall b. Data b => b -> b) -> ListDomains -> ListDomains

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListDomains -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListDomains -> r

gmapQ :: (forall d. Data d => d -> u) -> ListDomains -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListDomains -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListDomains -> m ListDomains

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDomains -> m ListDomains

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDomains -> m ListDomains

Read ListDomains

Methods

readsPrec :: Int -> ReadS ListDomains

readList :: ReadS [ListDomains]

readPrec :: ReadPrec ListDomains

readListPrec :: ReadPrec [ListDomains]

Show ListDomains

Methods

showsPrec :: Int -> ListDomains -> ShowS

show :: ListDomains -> String

showList :: [ListDomains] -> ShowS

Generic ListDomains

Associated Types

type Rep ListDomains :: * -> *

Methods

from :: ListDomains -> Rep ListDomains x

to :: Rep ListDomains x -> ListDomains

Hashable ListDomains

Methods

hashWithSalt :: Int -> ListDomains -> Int

hash :: ListDomains -> Int

NFData ListDomains

Methods

rnf :: ListDomains -> ()

AWSPager ListDomains

Methods

page :: ListDomains -> Rs ListDomains -> Maybe ListDomains

AWSRequest ListDomains

Associated Types

type Rs ListDomains :: *

Methods

request :: ListDomains -> Request ListDomains

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

ToPath ListDomains

Methods

toPath :: ListDomains -> ByteString

ToHeaders ListDomains

Methods

toHeaders :: ListDomains -> [Header]

ToQuery ListDomains

Methods

toQuery :: ListDomains -> QueryString

ToJSON ListDomains

Methods

toJSON :: ListDomains -> Value

toEncoding :: ListDomains -> Encoding

type Rep ListDomains

type Rep ListDomains = D1 (MetaData "ListDomains" "Network.AWS.SWF.ListDomains" "amazonka-swf-1.4.4-Dp39L54BbNUBjEhUE6RLW2" False) (C1 (MetaCons "ListDomains'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ldNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ldReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_ldMaximumPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_ldRegistrationStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RegistrationStatus)))))

type Rs ListDomains

type Rs ListDomains = ListDomainsResponse

Request Lenses

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

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

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

ldRegistrationStatus :: Lens' ListDomains RegistrationStatus

Specifies the registration status of the domains to list.

Destructuring the Response

listDomainsResponse

Arguments

:: Int

ldrsResponseStatus

-> ListDomainsResponse

Creates a value of ListDomainsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ldrsNextPageToken
• ldrsResponseStatus
• ldrsDomainInfos

data ListDomainsResponse

Contains a paginated collection of DomainInfo structures.

See: listDomainsResponse smart constructor.

Instances

Eq ListDomainsResponse

Methods

(==) :: ListDomainsResponse -> ListDomainsResponse -> Bool

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

Data ListDomainsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListDomainsResponse -> c ListDomainsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListDomainsResponse

toConstr :: ListDomainsResponse -> Constr

dataTypeOf :: ListDomainsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListDomainsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListDomainsResponse)

gmapT :: (forall b. Data b => b -> b) -> ListDomainsResponse -> ListDomainsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListDomainsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListDomainsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListDomainsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListDomainsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListDomainsResponse -> m ListDomainsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDomainsResponse -> m ListDomainsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListDomainsResponse -> m ListDomainsResponse

Read ListDomainsResponse

Methods

readsPrec :: Int -> ReadS ListDomainsResponse

readList :: ReadS [ListDomainsResponse]

readPrec :: ReadPrec ListDomainsResponse

readListPrec :: ReadPrec [ListDomainsResponse]

Show ListDomainsResponse

Methods

showsPrec :: Int -> ListDomainsResponse -> ShowS

show :: ListDomainsResponse -> String

showList :: [ListDomainsResponse] -> ShowS

Generic ListDomainsResponse

Associated Types

type Rep ListDomainsResponse :: * -> *

Methods

from :: ListDomainsResponse -> Rep ListDomainsResponse x

to :: Rep ListDomainsResponse x -> ListDomainsResponse

NFData ListDomainsResponse

Methods

rnf :: ListDomainsResponse -> ()

type Rep ListDomainsResponse

type Rep ListDomainsResponse = D1 (MetaData "ListDomainsResponse" "Network.AWS.SWF.ListDomains" "amazonka-swf-1.4.4-Dp39L54BbNUBjEhUE6RLW2" False) (C1 (MetaCons "ListDomainsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ldrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ldrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_ldrsDomainInfos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [DomainInfo])))))

Response Lenses

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

ldrsResponseStatus :: Lens' ListDomainsResponse Int

The response status code.

ldrsDomainInfos :: Lens' ListDomainsResponse [DomainInfo]

A list of DomainInfo structures.