Network.AWS.Route53.ListTrafficPolicyInstancesByPolicy

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

After you submit a CreateTrafficPolicyInstance or 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 by using a specify traffic policy version, send a GET request to the '2013-04-01\/trafficpolicyinstance' resource and include the ID and version of the traffic policy.

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 five values that help you navigate from one group of MaxItems traffic policy instances to the next:

• IsTruncated

  If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the specified traffic policy.

  If IsTruncated is false, this response includes the last traffic policy instance that is associated with the specified traffic policy.

• MaxItems

  The value that you specified for the MaxItems parameter in the request that produced the current response.

• HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker

  If IsTruncated is true, these values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByPolicy, and specify these values in the corresponding request parameters.

  If IsTruncated is false, all three elements are omitted from the response.

See: AWS API Reference for ListTrafficPolicyInstancesByPolicy.

Creating a Request

listTrafficPolicyInstancesByPolicy

Arguments

:: Text

ltpibpTrafficPolicyId

-> Natural

ltpibpTrafficPolicyVersion

-> ListTrafficPolicyInstancesByPolicy

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

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

• ltpibpTrafficPolicyInstanceTypeMarker
• ltpibpMaxItems
• ltpibpHostedZoneIdMarker
• ltpibpTrafficPolicyInstanceNameMarker
• ltpibpTrafficPolicyId
• ltpibpTrafficPolicyVersion

data ListTrafficPolicyInstancesByPolicy

A complex type that contains the information about the request to list your traffic policy instances.

See: listTrafficPolicyInstancesByPolicy smart constructor.

Instances

Eq ListTrafficPolicyInstancesByPolicy

Data ListTrafficPolicyInstancesByPolicy

Read ListTrafficPolicyInstancesByPolicy

Show ListTrafficPolicyInstancesByPolicy

Generic ListTrafficPolicyInstancesByPolicy

AWSRequest ListTrafficPolicyInstancesByPolicy

ToPath ListTrafficPolicyInstancesByPolicy

ToHeaders ListTrafficPolicyInstancesByPolicy

ToQuery ListTrafficPolicyInstancesByPolicy

type Rep ListTrafficPolicyInstancesByPolicy

type Rs ListTrafficPolicyInstancesByPolicy = ListTrafficPolicyInstancesByPolicyResponse

Request Lenses

ltpibpTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe RecordType)

For the first request to ListTrafficPolicyInstancesByPolicy, 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.

ltpibpMaxItems :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)

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.

ltpibpHostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for 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.

ltpibpTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)

For the first request to ListTrafficPolicyInstancesByPolicy, 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.

ltpibpTrafficPolicyId :: Lens' ListTrafficPolicyInstancesByPolicy Text

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

ltpibpTrafficPolicyVersion :: Lens' ListTrafficPolicyInstancesByPolicy Natural

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

Destructuring the Response

listTrafficPolicyInstancesByPolicyResponse

Arguments

:: Int

ltpibprsResponseStatus

-> Bool

ltpibprsIsTruncated

-> Text

ltpibprsMaxItems

-> ListTrafficPolicyInstancesByPolicyResponse

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

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

• ltpibprsTrafficPolicyInstanceTypeMarker
• ltpibprsHostedZoneIdMarker
• ltpibprsTrafficPolicyInstanceNameMarker
• ltpibprsResponseStatus
• ltpibprsTrafficPolicyInstances
• ltpibprsIsTruncated
• ltpibprsMaxItems

data ListTrafficPolicyInstancesByPolicyResponse

A complex type that contains the response information for the request.

See: listTrafficPolicyInstancesByPolicyResponse smart constructor.

Instances

Eq ListTrafficPolicyInstancesByPolicyResponse

Data ListTrafficPolicyInstancesByPolicyResponse

Read ListTrafficPolicyInstancesByPolicyResponse

Show ListTrafficPolicyInstancesByPolicyResponse

Generic ListTrafficPolicyInstancesByPolicyResponse

type Rep ListTrafficPolicyInstancesByPolicyResponse

Response Lenses

ltpibprsTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe RecordType)

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.

ltpibprsHostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe Text)

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

ltpibprsTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe Text)

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

ltpibprsResponseStatus :: Lens' ListTrafficPolicyInstancesByPolicyResponse Int

The response status code.

ltpibprsTrafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByPolicyResponse [TrafficPolicyInstance]

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

ltpibprsIsTruncated :: Lens' ListTrafficPolicyInstancesByPolicyResponse Bool

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 ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

Valid Values: true | false

ltpibprsMaxItems :: Lens' ListTrafficPolicyInstancesByPolicyResponse Text

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