| 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.ListTrafficPolicies
Description
Gets information about the latest version for every traffic policy that is associated with the current AWS account. Send a GET request to the /Amazon Route 53 API version /trafficpolicy resource.
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 policies associated with the current AWS account.
If IsTruncated is false , this response includes the last traffic policy that is associated with the current account.
- TrafficPolicyIdMarker
If IsTruncated is true , TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. If you want to list more traffic policies, make another call to ListTrafficPolicies , and specify the value of the TrafficPolicyIdMarker element from the response in the TrafficPolicyIdMarker request parameter.
If IsTruncated is false , the TrafficPolicyIdMarker element is omitted from the response.
- MaxItems
The value that you specified for the MaxItems parameter in the request that produced the current response.
- listTrafficPolicies :: ListTrafficPolicies
- data ListTrafficPolicies
- ltpTrafficPolicyIdMarker :: Lens' ListTrafficPolicies (Maybe Text)
- ltpMaxItems :: Lens' ListTrafficPolicies (Maybe Text)
- listTrafficPoliciesResponse :: Int -> Bool -> Text -> Text -> ListTrafficPoliciesResponse
- data ListTrafficPoliciesResponse
- ltprsResponseStatus :: Lens' ListTrafficPoliciesResponse Int
- ltprsTrafficPolicySummaries :: Lens' ListTrafficPoliciesResponse [TrafficPolicySummary]
- ltprsIsTruncated :: Lens' ListTrafficPoliciesResponse Bool
- ltprsTrafficPolicyIdMarker :: Lens' ListTrafficPoliciesResponse Text
- ltprsMaxItems :: Lens' ListTrafficPoliciesResponse Text
Creating a Request
listTrafficPolicies :: ListTrafficPolicies #
Creates a value of ListTrafficPolicies with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltpTrafficPolicyIdMarker- (Conditional) For your first request toListTrafficPolicies, do not include theTrafficPolicyIdMarkerparameter. If you have more traffic policies than the value ofMaxItems,ListTrafficPoliciesreturns only the firstMaxItemstraffic policies. To get the next group ofMaxItemspolicies, submit another request toListTrafficPolicies. For the value ofTrafficPolicyIdMarker, specify the value of theTrafficPolicyIdMarkerelement that was returned in the previous response. Policies are listed in the order in which they were created.ltpMaxItems- (Optional) The maximum number of traffic policies to be included in the response body for this request. If you have more thanMaxItemstraffic policies, the value of theIsTruncatedelement in the response istrue, and the value of theTrafficPolicyIdMarkerelement is the ID of the first traffic policy in the next group ofMaxItemstraffic policies.
data ListTrafficPolicies #
A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.
See: listTrafficPolicies smart constructor.
Instances
Request Lenses
ltpTrafficPolicyIdMarker :: Lens' ListTrafficPolicies (Maybe Text) #
(Conditional) For your first request to ListTrafficPolicies , do not include the TrafficPolicyIdMarker parameter. If you have more traffic policies than the value of MaxItems , ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of MaxItems policies, submit another request to ListTrafficPolicies . For the value of TrafficPolicyIdMarker , specify the value of the TrafficPolicyIdMarker element that was returned in the previous response. Policies are listed in the order in which they were created.
ltpMaxItems :: Lens' ListTrafficPolicies (Maybe Text) #
(Optional) The maximum number of traffic policies to be included in the response body for this request. If you have more than MaxItems traffic policies, the value of the IsTruncated element in the response is true , and the value of the TrafficPolicyIdMarker element is the ID of the first traffic policy in the next group of MaxItems traffic policies.
Destructuring the Response
Arguments
| :: Int | |
| -> Bool | |
| -> Text | |
| -> Text | |
| -> ListTrafficPoliciesResponse |
Creates a value of ListTrafficPoliciesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltprsResponseStatus- -- | The response status code.ltprsTrafficPolicySummaries- A list that contains oneTrafficPolicySummaryelement for each traffic policy that was created by the current AWS account.ltprsIsTruncated- A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group ofMaxItemstraffic policies by callingListTrafficPoliciesagain and specifying the value of theTrafficPolicyIdMarkerelement in theTrafficPolicyIdMarkerrequest parameter. Valid Values:true|falseltprsTrafficPolicyIdMarker- If the value ofIsTruncatedistrue,TrafficPolicyIdMarkeris the ID of the first traffic policy in the next group ofMaxItemstraffic policies.ltprsMaxItems- The value that you specified for theMaxItemsparameter in the call toListTrafficPoliciesthat produced the current response.
data ListTrafficPoliciesResponse #
A complex type that contains the response information for the request.
See: listTrafficPoliciesResponse smart constructor.
Response Lenses
ltprsResponseStatus :: Lens' ListTrafficPoliciesResponse Int #
- - | The response status code.
ltprsTrafficPolicySummaries :: Lens' ListTrafficPoliciesResponse [TrafficPolicySummary] #
A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.
ltprsIsTruncated :: Lens' ListTrafficPoliciesResponse Bool #
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 ListTrafficPolicies again and specifying the value of the TrafficPolicyIdMarker element in the TrafficPolicyIdMarker request parameter. Valid Values: true | false
ltprsTrafficPolicyIdMarker :: Lens' ListTrafficPoliciesResponse Text #
If the value of IsTruncated is true , TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.
ltprsMaxItems :: Lens' ListTrafficPoliciesResponse Text #
The value that you specified for the MaxItems parameter in the call to ListTrafficPolicies that produced the current response.