| Copyright | (c) 2013-2016 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 |
Network.AWS.Route53.ListTrafficPolicyInstancesByHostedZone
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.
Send a GET request to the '/Amazon 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
If the value of ''IsTruncated in the response is
true, there are more traffic policy instances associated with the current AWS account.If
IsTruncatedisfalse, this response includes the last traffic policy instance that is associated with the current account.MaxItems
The value that you specified for the
MaxItemsparameter in the request that produced the current response.TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker
If
IsTruncatedistrue, these two values in the response represent the first traffic policy instance in the next group ofMaxItemstraffic policy instances. To list more traffic policy instances, make another call toListTrafficPolicyInstancesByHostedZone, and specify these values in the corresponding request parameters.If
IsTruncatedisfalse, all three elements are omitted from the response.
- listTrafficPolicyInstancesByHostedZone :: Text -> ListTrafficPolicyInstancesByHostedZone
- data ListTrafficPolicyInstancesByHostedZone
- ltpibhzTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe RecordType)
- ltpibhzMaxItems :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe Text)
- ltpibhzTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe Text)
- ltpibhzHostedZoneId :: Lens' ListTrafficPolicyInstancesByHostedZone Text
- listTrafficPolicyInstancesByHostedZoneResponse :: Int -> Bool -> Text -> ListTrafficPolicyInstancesByHostedZoneResponse
- data ListTrafficPolicyInstancesByHostedZoneResponse
- ltpibhzrsTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (Maybe RecordType)
- ltpibhzrsTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (Maybe Text)
- ltpibhzrsResponseStatus :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Int
- ltpibhzrsTrafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse [TrafficPolicyInstance]
- ltpibhzrsIsTruncated :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Bool
- ltpibhzrsMaxItems :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Text
Creating a Request
listTrafficPolicyInstancesByHostedZone Source #
Creates a value of ListTrafficPolicyInstancesByHostedZone with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListTrafficPolicyInstancesByHostedZone Source #
A request for the traffic policy instances that you created in a specified hosted zone.
See: listTrafficPolicyInstancesByHostedZone smart constructor.
Instances
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
listTrafficPolicyInstancesByHostedZoneResponse Source #
Arguments
| :: Int | |
| -> Bool | |
| -> Text | |
| -> ListTrafficPolicyInstancesByHostedZoneResponse |
Creates a value of ListTrafficPolicyInstancesByHostedZoneResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListTrafficPolicyInstancesByHostedZoneResponse Source #
A complex type that contains the response information for the request.
See: listTrafficPolicyInstancesByHostedZoneResponse smart constructor.
Instances
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.
ltpibhzrsResponseStatus :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Int Source #
The response status code.
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.
ltpibhzrsMaxItems :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Text Source #
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByHostedZone that produced the current response.