Amazonka.Route53.ListHostedZonesByVPC

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The HostedZoneOwner structure in the response contains one of the following values:

• An OwningAccount element, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account.
• An OwningService element, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value of Owner is efs.amazonaws.com.

When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

The following are the supported partitions:

• aws - Amazon Web Services Regions
• aws-cn - China Regions
• aws-us-gov - Amazon Web Services GovCloud (US) Region

For more information, see Access Management in the Amazon Web Services General Reference.

Creating a Request

data ListHostedZonesByVPC

Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account created the hosted zones.

See: newListHostedZonesByVPC smart constructor.

Constructors

ListHostedZonesByVPC'

Fields

• maxItems :: Maybe Text

  (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with more than MaxItems hosted zones, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.

• nextToken :: Maybe Text

  If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit another ListHostedZonesByVPC request.

  For the value of NextToken, specify the value of NextToken from the previous response.

  If the previous response didn't include a NextToken element, there are no more hosted zones to get.

• vPCId :: Text

  The ID of the Amazon VPC that you want to list hosted zones for.

• vPCRegion :: VPCRegion

  For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.

Instances

ToHeaders ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

toHeaders :: ListHostedZonesByVPC -> [Header]

ToPath ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

toPath :: ListHostedZonesByVPC -> ByteString

ToQuery ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

toQuery :: ListHostedZonesByVPC -> QueryString

AWSRequest ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Associated Types

type AWSResponse ListHostedZonesByVPC

Methods

request :: (Service -> Service) -> ListHostedZonesByVPC -> Request ListHostedZonesByVPC

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListHostedZonesByVPC -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListHostedZonesByVPC)))

Generic ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Associated Types

type Rep ListHostedZonesByVPC :: Type -> Type

Methods

from :: ListHostedZonesByVPC -> Rep ListHostedZonesByVPC x

to :: Rep ListHostedZonesByVPC x -> ListHostedZonesByVPC

Read ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

readsPrec :: Int -> ReadS ListHostedZonesByVPC

readList :: ReadS [ListHostedZonesByVPC]

readPrec :: ReadPrec ListHostedZonesByVPC

readListPrec :: ReadPrec [ListHostedZonesByVPC]

Show ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

showsPrec :: Int -> ListHostedZonesByVPC -> ShowS

show :: ListHostedZonesByVPC -> String

showList :: [ListHostedZonesByVPC] -> ShowS

NFData ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

rnf :: ListHostedZonesByVPC -> ()

Eq ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

(==) :: ListHostedZonesByVPC -> ListHostedZonesByVPC -> Bool

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

Hashable ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

hashWithSalt :: Int -> ListHostedZonesByVPC -> Int

hash :: ListHostedZonesByVPC -> Int

type AWSResponse ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

type AWSResponse ListHostedZonesByVPC = ListHostedZonesByVPCResponse

type Rep ListHostedZonesByVPC

Defined in Amazonka.Route53.ListHostedZonesByVPC

type Rep ListHostedZonesByVPC = D1 ('MetaData "ListHostedZonesByVPC" "Amazonka.Route53.ListHostedZonesByVPC" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "ListHostedZonesByVPC'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vPCId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vPCRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VPCRegion))))

newListHostedZonesByVPC

Arguments

:: Text

ListHostedZonesByVPC

-> VPCRegion

ListHostedZonesByVPC

-> ListHostedZonesByVPC

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

ListHostedZonesByVPC, listHostedZonesByVPC_maxItems - (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with more than MaxItems hosted zones, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.

ListHostedZonesByVPC, listHostedZonesByVPC_nextToken - If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit another ListHostedZonesByVPC request.

For the value of NextToken, specify the value of NextToken from the previous response.

If the previous response didn't include a NextToken element, there are no more hosted zones to get.

ListHostedZonesByVPC, listHostedZonesByVPC_vPCId - The ID of the Amazon VPC that you want to list hosted zones for.

ListHostedZonesByVPC, listHostedZonesByVPC_vPCRegion - For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.

Request Lenses

listHostedZonesByVPC_maxItems :: Lens' ListHostedZonesByVPC (Maybe Text)

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with more than MaxItems hosted zones, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.

listHostedZonesByVPC_nextToken :: Lens' ListHostedZonesByVPC (Maybe Text)

If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit another ListHostedZonesByVPC request.

For the value of NextToken, specify the value of NextToken from the previous response.

If the previous response didn't include a NextToken element, there are no more hosted zones to get.

listHostedZonesByVPC_vPCId :: Lens' ListHostedZonesByVPC Text

The ID of the Amazon VPC that you want to list hosted zones for.

listHostedZonesByVPC_vPCRegion :: Lens' ListHostedZonesByVPC VPCRegion

For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.

Destructuring the Response

data ListHostedZonesByVPCResponse

See: newListHostedZonesByVPCResponse smart constructor.

Constructors

ListHostedZonesByVPCResponse'

Fields

• nextToken :: Maybe Text

  The value that you will use for NextToken in the next ListHostedZonesByVPC request.

• httpStatus :: Int

  The response's http status code.

• hostedZoneSummaries :: [HostedZoneSummary]

  A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

• maxItems :: Text

  The value that you specified for MaxItems in the most recent ListHostedZonesByVPC request.

Instances

Generic ListHostedZonesByVPCResponse

Defined in Amazonka.Route53.ListHostedZonesByVPC

Associated Types

type Rep ListHostedZonesByVPCResponse :: Type -> Type

Methods

from :: ListHostedZonesByVPCResponse -> Rep ListHostedZonesByVPCResponse x

to :: Rep ListHostedZonesByVPCResponse x -> ListHostedZonesByVPCResponse

Read ListHostedZonesByVPCResponse

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

readsPrec :: Int -> ReadS ListHostedZonesByVPCResponse

readList :: ReadS [ListHostedZonesByVPCResponse]

readPrec :: ReadPrec ListHostedZonesByVPCResponse

readListPrec :: ReadPrec [ListHostedZonesByVPCResponse]

Show ListHostedZonesByVPCResponse

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

showsPrec :: Int -> ListHostedZonesByVPCResponse -> ShowS

show :: ListHostedZonesByVPCResponse -> String

showList :: [ListHostedZonesByVPCResponse] -> ShowS

NFData ListHostedZonesByVPCResponse

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

rnf :: ListHostedZonesByVPCResponse -> ()

Eq ListHostedZonesByVPCResponse

Defined in Amazonka.Route53.ListHostedZonesByVPC

Methods

(==) :: ListHostedZonesByVPCResponse -> ListHostedZonesByVPCResponse -> Bool

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

type Rep ListHostedZonesByVPCResponse

Defined in Amazonka.Route53.ListHostedZonesByVPC

type Rep ListHostedZonesByVPCResponse = D1 ('MetaData "ListHostedZonesByVPCResponse" "Amazonka.Route53.ListHostedZonesByVPC" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "ListHostedZonesByVPCResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "hostedZoneSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [HostedZoneSummary]) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListHostedZonesByVPCResponse

Arguments

:: Int

$sel:httpStatus:ListHostedZonesByVPCResponse'

-> Text

ListHostedZonesByVPC

-> ListHostedZonesByVPCResponse

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

ListHostedZonesByVPC, listHostedZonesByVPCResponse_nextToken - The value that you will use for NextToken in the next ListHostedZonesByVPC request.

$sel:httpStatus:ListHostedZonesByVPCResponse', listHostedZonesByVPCResponse_httpStatus - The response's http status code.

$sel:hostedZoneSummaries:ListHostedZonesByVPCResponse', listHostedZonesByVPCResponse_hostedZoneSummaries - A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

ListHostedZonesByVPC, listHostedZonesByVPCResponse_maxItems - The value that you specified for MaxItems in the most recent ListHostedZonesByVPC request.

Response Lenses

listHostedZonesByVPCResponse_nextToken :: Lens' ListHostedZonesByVPCResponse (Maybe Text)

The value that you will use for NextToken in the next ListHostedZonesByVPC request.

listHostedZonesByVPCResponse_httpStatus :: Lens' ListHostedZonesByVPCResponse Int

The response's http status code.

listHostedZonesByVPCResponse_hostedZoneSummaries :: Lens' ListHostedZonesByVPCResponse [HostedZoneSummary]

A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

listHostedZonesByVPCResponse_maxItems :: Lens' ListHostedZonesByVPCResponse Text

The value that you specified for MaxItems in the most recent ListHostedZonesByVPC request.