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 |
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 '/Route 53 API version/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 istrue
, there are more traffic policy instances associated with the specified traffic policy.If
IsTruncated
isfalse
, 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
istrue
, these values in the response represent the first traffic policy instance in the next group ofMaxItems
traffic policy instances. To list more traffic policy instances, make another call toListTrafficPolicyInstancesByPolicy
, and specify these values in the corresponding request parameters.If
IsTruncated
isfalse
, all three elements are omitted from the response.
- listTrafficPolicyInstancesByPolicy :: Text -> Natural -> ListTrafficPolicyInstancesByPolicy
- data ListTrafficPolicyInstancesByPolicy
- ltpibpTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe RecordType)
- ltpibpMaxItems :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)
- ltpibpHostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)
- ltpibpTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)
- ltpibpTrafficPolicyId :: Lens' ListTrafficPolicyInstancesByPolicy Text
- ltpibpTrafficPolicyVersion :: Lens' ListTrafficPolicyInstancesByPolicy Natural
- listTrafficPolicyInstancesByPolicyResponse :: Int -> Bool -> Text -> ListTrafficPolicyInstancesByPolicyResponse
- data ListTrafficPolicyInstancesByPolicyResponse
- ltpibprsTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe RecordType)
- ltpibprsHostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe Text)
- ltpibprsTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe Text)
- ltpibprsResponseStatus :: Lens' ListTrafficPolicyInstancesByPolicyResponse Int
- ltpibprsTrafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByPolicyResponse [TrafficPolicyInstance]
- ltpibprsIsTruncated :: Lens' ListTrafficPolicyInstancesByPolicyResponse Bool
- ltpibprsMaxItems :: Lens' ListTrafficPolicyInstancesByPolicyResponse Text
Creating a Request
listTrafficPolicyInstancesByPolicy Source #
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:
data ListTrafficPolicyInstancesByPolicy Source #
A complex type that contains the information about the request to list your traffic policy instances.
See: listTrafficPolicyInstancesByPolicy
smart constructor.
Request Lenses
ltpibpTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe RecordType) Source #
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) 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.
ltpibpHostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text) Source #
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) Source #
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 Source #
The ID of the traffic policy for which you want to list traffic policy instances.
ltpibpTrafficPolicyVersion :: Lens' ListTrafficPolicyInstancesByPolicy Natural Source #
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 Source #
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:
data ListTrafficPolicyInstancesByPolicyResponse Source #
A complex type that contains the response information for the request.
See: listTrafficPolicyInstancesByPolicyResponse
smart constructor.
Response Lenses
ltpibprsTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (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.
ltpibprsHostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe Text) Source #
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) Source #
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 Source #
The response status code.
ltpibprsTrafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByPolicyResponse [TrafficPolicyInstance] Source #
A list that contains one TrafficPolicyInstance
element for each traffic policy instance that matches the elements in the request.
ltpibprsIsTruncated :: Lens' ListTrafficPolicyInstancesByPolicyResponse 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 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 Source #
The value that you specified for the MaxItems
parameter in the call to ListTrafficPolicyInstancesByPolicy
that produced the current response.