Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
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.
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.
Synopsis
- data ListTrafficPolicyInstancesByPolicy = ListTrafficPolicyInstancesByPolicy' {}
- newListTrafficPolicyInstancesByPolicy :: Text -> Natural -> ListTrafficPolicyInstancesByPolicy
- listTrafficPolicyInstancesByPolicy_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe ResourceId)
- listTrafficPolicyInstancesByPolicy_maxItems :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)
- listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text)
- listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe RRType)
- listTrafficPolicyInstancesByPolicy_trafficPolicyId :: Lens' ListTrafficPolicyInstancesByPolicy Text
- listTrafficPolicyInstancesByPolicy_trafficPolicyVersion :: Lens' ListTrafficPolicyInstancesByPolicy Natural
- data ListTrafficPolicyInstancesByPolicyResponse = ListTrafficPolicyInstancesByPolicyResponse' {}
- newListTrafficPolicyInstancesByPolicyResponse :: Int -> Bool -> Text -> ListTrafficPolicyInstancesByPolicyResponse
- listTrafficPolicyInstancesByPolicyResponse_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe ResourceId)
- listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe Text)
- listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe RRType)
- listTrafficPolicyInstancesByPolicyResponse_httpStatus :: Lens' ListTrafficPolicyInstancesByPolicyResponse Int
- listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByPolicyResponse [TrafficPolicyInstance]
- listTrafficPolicyInstancesByPolicyResponse_isTruncated :: Lens' ListTrafficPolicyInstancesByPolicyResponse Bool
- listTrafficPolicyInstancesByPolicyResponse_maxItems :: Lens' ListTrafficPolicyInstancesByPolicyResponse Text
Creating a Request
data ListTrafficPolicyInstancesByPolicy Source #
A complex type that contains the information about the request to list your traffic policy instances.
See: newListTrafficPolicyInstancesByPolicy
smart constructor.
ListTrafficPolicyInstancesByPolicy' | |
|
Instances
newListTrafficPolicyInstancesByPolicy Source #
Create a value of ListTrafficPolicyInstancesByPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicy_hostedZoneIdMarker
- If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of hostedzoneid
, specify the value of
HostedZoneIdMarker
from the previous response, which is the hosted
zone ID of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicy_maxItems
- 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 that Amazon Route 53 will
return if you submit another request.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceNameMarker
- If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of trafficpolicyinstancename
, specify the value of
TrafficPolicyInstanceNameMarker
from the previous response, which is
the name of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceTypeMarker
- If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of trafficpolicyinstancetype
, specify the value of
TrafficPolicyInstanceTypeMarker
from the previous response, which is
the name of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicy_trafficPolicyId
- The ID of the traffic policy for which you want to list traffic policy
instances.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicy_trafficPolicyVersion
- 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
.
Request Lenses
listTrafficPolicyInstancesByPolicy_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe ResourceId) Source #
If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of hostedzoneid
, specify the value of
HostedZoneIdMarker
from the previous response, which is the hosted
zone ID of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
listTrafficPolicyInstancesByPolicy_maxItems :: 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 that Amazon Route 53 will
return if you submit another request.
listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text) Source #
If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of trafficpolicyinstancename
, specify the value of
TrafficPolicyInstanceNameMarker
from the previous response, which is
the name of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe RRType) Source #
If the value of IsTruncated
in the previous response was true
, you
have more traffic policy instances. To get more traffic policy
instances, submit another ListTrafficPolicyInstancesByPolicy
request.
For the value of trafficpolicyinstancetype
, specify the value of
TrafficPolicyInstanceTypeMarker
from the previous response, which is
the name of the first traffic policy instance that Amazon Route 53 will
return if you submit another request.
If the value of IsTruncated
in the previous response was false
,
there are no more traffic policy instances to get.
listTrafficPolicyInstancesByPolicy_trafficPolicyId :: Lens' ListTrafficPolicyInstancesByPolicy Text Source #
The ID of the traffic policy for which you want to list traffic policy instances.
listTrafficPolicyInstancesByPolicy_trafficPolicyVersion :: 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
data ListTrafficPolicyInstancesByPolicyResponse Source #
A complex type that contains the response information for the request.
See: newListTrafficPolicyInstancesByPolicyResponse
smart constructor.
ListTrafficPolicyInstancesByPolicyResponse' | |
|
Instances
newListTrafficPolicyInstancesByPolicyResponse Source #
:: Int | |
-> Bool |
|
-> Text | |
-> ListTrafficPolicyInstancesByPolicyResponse |
Create a value of ListTrafficPolicyInstancesByPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicyResponse_hostedZoneIdMarker
- If IsTruncated
is true
, HostedZoneIdMarker
is the ID of the hosted
zone of the first traffic policy instance in the next group of traffic
policy instances.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceNameMarker
- If IsTruncated
is true
, TrafficPolicyInstanceNameMarker
is the
name of the first traffic policy instance in the next group of
MaxItems
traffic policy instances.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceTypeMarker
- 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.
$sel:httpStatus:ListTrafficPolicyInstancesByPolicyResponse'
, listTrafficPolicyInstancesByPolicyResponse_httpStatus
- The response's http status code.
$sel:trafficPolicyInstances:ListTrafficPolicyInstancesByPolicyResponse'
, listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstances
- A list that contains one TrafficPolicyInstance
element for each
traffic policy instance that matches the elements in the request.
$sel:isTruncated:ListTrafficPolicyInstancesByPolicyResponse'
, listTrafficPolicyInstancesByPolicyResponse_isTruncated
- 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
traffic policy instances by calling ListTrafficPolicyInstancesByPolicy
again and specifying the values of the HostedZoneIdMarker
,
TrafficPolicyInstanceNameMarker
, and TrafficPolicyInstanceTypeMarker
elements in the corresponding request parameters.
ListTrafficPolicyInstancesByPolicy
, listTrafficPolicyInstancesByPolicyResponse_maxItems
- The value that you specified for the MaxItems
parameter in the call to
ListTrafficPolicyInstancesByPolicy
that produced the current response.
Response Lenses
listTrafficPolicyInstancesByPolicyResponse_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe ResourceId) Source #
If IsTruncated
is true
, HostedZoneIdMarker
is the ID of the hosted
zone of the first traffic policy instance in the next group of traffic
policy instances.
listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceNameMarker :: 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.
listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe RRType) 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.
listTrafficPolicyInstancesByPolicyResponse_httpStatus :: Lens' ListTrafficPolicyInstancesByPolicyResponse Int Source #
The response's http status code.
listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByPolicyResponse [TrafficPolicyInstance] Source #
A list that contains one TrafficPolicyInstance
element for each
traffic policy instance that matches the elements in the request.
listTrafficPolicyInstancesByPolicyResponse_isTruncated :: 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
traffic policy instances by calling ListTrafficPolicyInstancesByPolicy
again and specifying the values of the HostedZoneIdMarker
,
TrafficPolicyInstanceNameMarker
, and TrafficPolicyInstanceTypeMarker
elements in the corresponding request parameters.
listTrafficPolicyInstancesByPolicyResponse_maxItems :: Lens' ListTrafficPolicyInstancesByPolicyResponse Text Source #
The value that you specified for the MaxItems
parameter in the call to
ListTrafficPolicyInstancesByPolicy
that produced the current response.