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.Route53Resolver.ListFirewallDomains

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the domains that you have defined for the specified firewall domain list.

A single call might return only a partial list of the domains. For information, see MaxResults.

This operation returns paginated results.

Synopsis

data ListFirewallDomains = ListFirewallDomains' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- firewallDomainListId :: Text
}
newListFirewallDomains :: Text -> ListFirewallDomains
listFirewallDomains_maxResults :: Lens' ListFirewallDomains (Maybe Natural)
listFirewallDomains_nextToken :: Lens' ListFirewallDomains (Maybe Text)
listFirewallDomains_firewallDomainListId :: Lens' ListFirewallDomains Text
data ListFirewallDomainsResponse = ListFirewallDomainsResponse' {
- domains :: Maybe [Text]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListFirewallDomainsResponse :: Int -> ListFirewallDomainsResponse
listFirewallDomainsResponse_domains :: Lens' ListFirewallDomainsResponse (Maybe [Text])
listFirewallDomainsResponse_nextToken :: Lens' ListFirewallDomainsResponse (Maybe Text)
listFirewallDomainsResponse_httpStatus :: Lens' ListFirewallDomainsResponse Int

Creating a Request

data ListFirewallDomains Source #

See: newListFirewallDomains smart constructor.

Constructors

ListFirewallDomains'

Fields

maxResults :: Maybe Natural
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
nextToken :: Maybe Text
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
firewallDomainListId :: Text
The ID of the domain list whose domains you want to retrieve.

Instances

Instances details

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

newListFirewallDomains Source #

Arguments

:: Text	`ListFirewallDomains`
-> ListFirewallDomains

Create a value of ListFirewallDomains 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:maxResults:ListFirewallDomains', listFirewallDomains_maxResults - The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

ListFirewallDomains, listFirewallDomains_nextToken - For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

ListFirewallDomains, listFirewallDomains_firewallDomainListId - The ID of the domain list whose domains you want to retrieve.

Request Lenses

listFirewallDomains_maxResults :: Lens' ListFirewallDomains (Maybe Natural) Source #

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

listFirewallDomains_nextToken :: Lens' ListFirewallDomains (Maybe Text) Source #

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

listFirewallDomains_firewallDomainListId :: Lens' ListFirewallDomains Text Source #

The ID of the domain list whose domains you want to retrieve.

Destructuring the Response

data ListFirewallDomainsResponse Source #

See: newListFirewallDomainsResponse smart constructor.

Constructors

ListFirewallDomainsResponse'

Fields

domains :: Maybe [Text]
A list of the domains in the firewall domain list.
This might be a partial list of the domains that you've defined in the domain list. For information, see MaxResults.
nextToken :: Maybe Text
If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListFirewallDomainsResponse Source #

Arguments

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

Create a value of ListFirewallDomainsResponse 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:domains:ListFirewallDomainsResponse', listFirewallDomainsResponse_domains - A list of the domains in the firewall domain list.

This might be a partial list of the domains that you've defined in the domain list. For information, see MaxResults.

ListFirewallDomains, listFirewallDomainsResponse_nextToken - If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

$sel:httpStatus:ListFirewallDomainsResponse', listFirewallDomainsResponse_httpStatus - The response's http status code.

Response Lenses

listFirewallDomainsResponse_domains :: Lens' ListFirewallDomainsResponse (Maybe [Text]) Source #

A list of the domains in the firewall domain list.

This might be a partial list of the domains that you've defined in the domain list. For information, see MaxResults.

listFirewallDomainsResponse_nextToken :: Lens' ListFirewallDomainsResponse (Maybe Text) Source #

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

listFirewallDomainsResponse_httpStatus :: Lens' ListFirewallDomainsResponse Int Source #

The response's http status code.