amazonka-route53-1.4.0: Amazon Route 53 SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Route53.ListTrafficPolicyInstancesByHostedZone

Contents

Description

Gets information about the traffic policy instances that you created in a specified hosted zone.

After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

To get information about the traffic policy instances that you created in a specified hosted zone, send a GET request to the '/Route 53 API version/trafficpolicyinstance' resource and include the ID of the hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes four values that help you navigate from one group of MaxItems traffic policy instances to the next:

  • IsTruncated
  • MaxItems
  • TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker

Synopsis

Creating a Request

Request Lenses

ltpibhzTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe RecordType) Source

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

ltpibhzMaxItems :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe Text) Source

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

ltpibhzTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe Text) Source

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

ltpibhzHostedZoneId :: Lens' ListTrafficPolicyInstancesByHostedZone Text Source

The ID of the hosted zone for which you want to list traffic policy instances.

Destructuring the Response

Response Lenses

ltpibhzrsTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (Maybe RecordType) Source

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

ltpibhzrsTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (Maybe Text) Source

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

ltpibhzrsTrafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse [TrafficPolicyInstance] Source

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

ltpibhzrsIsTruncated :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Bool Source

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByHostedZone again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

Valid Values: true | false

ltpibhzrsMaxItems :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Text Source

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByHostedZone that produced the current response.