Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
See: AWS API Reference for ListDomains.
This operation returns paginated results.
- listDomains :: RegistrationStatus -> ListDomains
- data ListDomains
- ldNextPageToken :: Lens' ListDomains (Maybe Text)
- ldReverseOrder :: Lens' ListDomains (Maybe Bool)
- ldMaximumPageSize :: Lens' ListDomains (Maybe Natural)
- ldRegistrationStatus :: Lens' ListDomains RegistrationStatus
- listDomainsResponse :: Int -> ListDomainsResponse
- data ListDomainsResponse
- ldrsNextPageToken :: Lens' ListDomainsResponse (Maybe Text)
- ldrsStatus :: Lens' ListDomainsResponse Int
- ldrsDomainInfos :: Lens' ListDomainsResponse [DomainInfo]
Creating a Request
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:
data ListDomains Source
See: listDomains
smart constructor.
Request Lenses
ldNextPageToken :: Lens' ListDomains (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.
ldReverseOrder :: 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.
ldMaximumPageSize :: Lens' ListDomains (Maybe Natural) Source
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 Source
Specifies the registration status of the domains to list.
Destructuring the Response
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:
data ListDomainsResponse Source
Contains a paginated collection of DomainInfo structures.
See: listDomainsResponse
smart constructor.
Response Lenses
ldrsNextPageToken :: 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.
ldrsStatus :: Lens' ListDomainsResponse Int Source
The response status code.
ldrsDomainInfos :: Lens' ListDomainsResponse [DomainInfo] Source
A list of DomainInfo structures.