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 all of the versions for a specified traffic policy.
Send a GET
request to the /Amazon Route 53 API version /trafficpolicy
resource and specify the ID of the traffic policy for which you want to list versions.
Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the maxitems
parameter to list them in groups of up to 100.
The response includes three values that help you navigate from one group of maxitems
traffic policies to the next:
- IsTruncated
If the value of IsTruncated
in the response is true
, there are more traffic policy versions associated with the specified traffic policy.
If IsTruncated
is false
, this response includes the last traffic policy version that is associated with the specified traffic policy.
- TrafficPolicyVersionMarker
The ID of the next traffic policy version that is associated with the current AWS account. If you want to list more traffic policies, make another call to ListTrafficPolicyVersions
, and specify the value of the TrafficPolicyVersionMarker
element in the TrafficPolicyVersionMarker
request parameter.
If IsTruncated
is false
, Amazon Route 53 omits the TrafficPolicyVersionMarker
element from the response.
- MaxItems
The value that you specified for the MaxItems
parameter in the request that produced the current response.
- listTrafficPolicyVersions :: Text -> ListTrafficPolicyVersions
- data ListTrafficPolicyVersions
- ltpvMaxItems :: Lens' ListTrafficPolicyVersions (Maybe Text)
- ltpvTrafficPolicyVersionMarker :: Lens' ListTrafficPolicyVersions (Maybe Text)
- ltpvId :: Lens' ListTrafficPolicyVersions Text
- listTrafficPolicyVersionsResponse :: Int -> Bool -> Text -> Text -> ListTrafficPolicyVersionsResponse
- data ListTrafficPolicyVersionsResponse
- ltpvrsResponseStatus :: Lens' ListTrafficPolicyVersionsResponse Int
- ltpvrsTrafficPolicies :: Lens' ListTrafficPolicyVersionsResponse [TrafficPolicy]
- ltpvrsIsTruncated :: Lens' ListTrafficPolicyVersionsResponse Bool
- ltpvrsTrafficPolicyVersionMarker :: Lens' ListTrafficPolicyVersionsResponse Text
- ltpvrsMaxItems :: Lens' ListTrafficPolicyVersionsResponse Text
Creating a Request
listTrafficPolicyVersions Source #
Creates a value of ListTrafficPolicyVersions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltpvMaxItems
- The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more thanMaxItems
versions, the value of theIsTruncated
element in the response istrue
, and the value of theTrafficPolicyVersionMarker
element is the ID of the first version in the next group ofMaxItems
traffic policy versions.ltpvTrafficPolicyVersionMarker
- For your first request toListTrafficPolicyVersions
, do not include theTrafficPolicyVersionMarker
parameter. If you have more traffic policy versions than the value ofMaxItems
,ListTrafficPolicyVersions
returns only the first group ofMaxItems
versions. To get the next group ofMaxItems
traffic policy versions, submit another request toListTrafficPolicyVersions
. For the value ofTrafficPolicyVersionMarker
, specify the value of theTrafficPolicyVersionMarker
element that was returned in the previous response. Traffic policy versions are listed in sequential order.ltpvId
- Specify the value ofId
of the traffic policy for which you want to list all versions.
data ListTrafficPolicyVersions Source #
A complex type that contains the information about the request to list your traffic policies.
See: listTrafficPolicyVersions
smart constructor.
Request Lenses
ltpvMaxItems :: Lens' ListTrafficPolicyVersions (Maybe Text) Source #
The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems
versions, the value of the IsTruncated
element in the response is true
, and the value of the TrafficPolicyVersionMarker
element is the ID of the first version in the next group of MaxItems
traffic policy versions.
ltpvTrafficPolicyVersionMarker :: Lens' ListTrafficPolicyVersions (Maybe Text) Source #
For your first request to ListTrafficPolicyVersions
, do not include the TrafficPolicyVersionMarker
parameter. If you have more traffic policy versions than the value of MaxItems
, ListTrafficPolicyVersions
returns only the first group of MaxItems
versions. To get the next group of MaxItems
traffic policy versions, submit another request to ListTrafficPolicyVersions
. For the value of TrafficPolicyVersionMarker
, specify the value of the TrafficPolicyVersionMarker
element that was returned in the previous response. Traffic policy versions are listed in sequential order.
ltpvId :: Lens' ListTrafficPolicyVersions Text Source #
Specify the value of Id
of the traffic policy for which you want to list all versions.
Destructuring the Response
listTrafficPolicyVersionsResponse Source #
:: Int | |
-> Bool | |
-> Text | |
-> Text | |
-> ListTrafficPolicyVersionsResponse |
Creates a value of ListTrafficPolicyVersionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltpvrsResponseStatus
- -- | The response status code.ltpvrsTrafficPolicies
- A list that contains oneTrafficPolicy
element for each traffic policy version that is associated with the specified traffic policy.ltpvrsIsTruncated
- A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group ofmaxitems
traffic policies by callingListTrafficPolicyVersions
again and specifying the value of theNextMarker
element in themarker
parameter.ltpvrsTrafficPolicyVersionMarker
- IfIsTruncated
istrue
, the value ofTrafficPolicyVersionMarker
identifies the first traffic policy in the next group ofMaxItems
traffic policies. CallListTrafficPolicyVersions
again and specify the value ofTrafficPolicyVersionMarker
in theTrafficPolicyVersionMarker
request parameter. This element is present only ifIsTruncated
istrue
.ltpvrsMaxItems
- The value that you specified for themaxitems
parameter in the call toListTrafficPolicyVersions
that produced the current response.
data ListTrafficPolicyVersionsResponse Source #
A complex type that contains the response information for the request.
See: listTrafficPolicyVersionsResponse
smart constructor.
Response Lenses
ltpvrsResponseStatus :: Lens' ListTrafficPolicyVersionsResponse Int Source #
- - | The response status code.
ltpvrsTrafficPolicies :: Lens' ListTrafficPolicyVersionsResponse [TrafficPolicy] Source #
A list that contains one TrafficPolicy
element for each traffic policy version that is associated with the specified traffic policy.
ltpvrsIsTruncated :: Lens' ListTrafficPolicyVersionsResponse Bool Source #
A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of maxitems
traffic policies by calling ListTrafficPolicyVersions
again and specifying the value of the NextMarker
element in the marker
parameter.
ltpvrsTrafficPolicyVersionMarker :: Lens' ListTrafficPolicyVersionsResponse Text Source #
If IsTruncated
is true
, the value of TrafficPolicyVersionMarker
identifies the first traffic policy in the next group of MaxItems
traffic policies. Call ListTrafficPolicyVersions
again and specify the value of TrafficPolicyVersionMarker
in the TrafficPolicyVersionMarker
request parameter. This element is present only if IsTruncated
is true
.
ltpvrsMaxItems :: Lens' ListTrafficPolicyVersionsResponse Text Source #
The value that you specified for the maxitems
parameter in the call to ListTrafficPolicyVersions
that produced the current response.