libZSservicesZSamazonka-route53ZSamazonka-route53
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Route53.ListTrafficPolicies

Description

Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.

For information about how of deleting a traffic policy affects the response from ListTrafficPolicies, see DeleteTrafficPolicy.

Synopsis

Creating a Request

data ListTrafficPolicies Source #

A complex type that contains the information about the request to list the traffic policies that are associated with the current Amazon Web Services account.

See: newListTrafficPolicies smart constructor.

Constructors

ListTrafficPolicies' 

Fields

  • trafficPolicyIdMarker :: Maybe Text

    (Conditional) For your first request to ListTrafficPolicies, don't 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 policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

  • maxItems :: Maybe Text

    (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.

Instances

Instances details
Eq ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Read ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Show ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Generic ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Associated Types

type Rep ListTrafficPolicies :: Type -> Type #

NFData ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Methods

rnf :: ListTrafficPolicies -> () #

Hashable ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

AWSRequest ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Associated Types

type AWSResponse ListTrafficPolicies #

ToHeaders ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

ToPath ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

ToQuery ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

type Rep ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

type Rep ListTrafficPolicies = D1 ('MetaData "ListTrafficPolicies" "Amazonka.Route53.ListTrafficPolicies" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "ListTrafficPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trafficPolicyIdMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse ListTrafficPolicies Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

newListTrafficPolicies :: ListTrafficPolicies Source #

Create a value of ListTrafficPolicies 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:

$sel:trafficPolicyIdMarker:ListTrafficPolicies', listTrafficPolicies_trafficPolicyIdMarker - (Conditional) For your first request to ListTrafficPolicies, don't 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 policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

$sel:maxItems:ListTrafficPolicies', listTrafficPolicies_maxItems - (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.

Request Lenses

listTrafficPolicies_trafficPolicyIdMarker :: Lens' ListTrafficPolicies (Maybe Text) Source #

(Conditional) For your first request to ListTrafficPolicies, don't 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 policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

listTrafficPolicies_maxItems :: Lens' ListTrafficPolicies (Maybe Text) Source #

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.

Destructuring the Response

data ListTrafficPoliciesResponse Source #

A complex type that contains the response information for the request.

See: newListTrafficPoliciesResponse smart constructor.

Constructors

ListTrafficPoliciesResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • trafficPolicySummaries :: [TrafficPolicySummary]

    A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

  • isTruncated :: 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 traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

  • trafficPolicyIdMarker :: 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.

  • maxItems :: Text

    The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.

Instances

Instances details
Eq ListTrafficPoliciesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Read ListTrafficPoliciesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Show ListTrafficPoliciesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Generic ListTrafficPoliciesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

Associated Types

type Rep ListTrafficPoliciesResponse :: Type -> Type #

NFData ListTrafficPoliciesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

type Rep ListTrafficPoliciesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicies

type Rep ListTrafficPoliciesResponse = D1 ('MetaData "ListTrafficPoliciesResponse" "Amazonka.Route53.ListTrafficPolicies" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "ListTrafficPoliciesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "trafficPolicySummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TrafficPolicySummary])) :*: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "trafficPolicyIdMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListTrafficPoliciesResponse Source #

Create a value of ListTrafficPoliciesResponse 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:

$sel:httpStatus:ListTrafficPoliciesResponse', listTrafficPoliciesResponse_httpStatus - The response's http status code.

$sel:trafficPolicySummaries:ListTrafficPoliciesResponse', listTrafficPoliciesResponse_trafficPolicySummaries - A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

$sel:isTruncated:ListTrafficPoliciesResponse', listTrafficPoliciesResponse_isTruncated - 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 traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

$sel:trafficPolicyIdMarker:ListTrafficPolicies', listTrafficPoliciesResponse_trafficPolicyIdMarker - If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

$sel:maxItems:ListTrafficPolicies', listTrafficPoliciesResponse_maxItems - The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.

Response Lenses

listTrafficPoliciesResponse_trafficPolicySummaries :: Lens' ListTrafficPoliciesResponse [TrafficPolicySummary] Source #

A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

listTrafficPoliciesResponse_isTruncated :: Lens' ListTrafficPoliciesResponse 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 traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

listTrafficPoliciesResponse_trafficPolicyIdMarker :: Lens' ListTrafficPoliciesResponse Text Source #

If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

listTrafficPoliciesResponse_maxItems :: Lens' ListTrafficPoliciesResponse Text Source #

The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.