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.ListTrafficPolicyInstances

Description

Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.

After you submit 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

Creating a Request

data ListTrafficPolicyInstances Source #

A request to get information about the traffic policy instances that you created by using the current Amazon Web Services account.

See: newListTrafficPolicyInstances smart constructor.

Constructors

ListTrafficPolicyInstances' 

Fields

  • trafficPolicyInstanceTypeMarker :: Maybe RRType

    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 ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

  • maxItems :: Maybe Text

    The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances 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.

  • hostedZoneIdMarker :: Maybe ResourceId

    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 ListTrafficPolicyInstances 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 in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

  • trafficPolicyInstanceNameMarker :: Maybe Text

    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 ListTrafficPolicyInstances 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 in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Instances

Instances details
Eq ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Read ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Show ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Generic ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Associated Types

type Rep ListTrafficPolicyInstances :: Type -> Type #

NFData ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Hashable ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

AWSRequest ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

ToHeaders ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

ToPath ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

ToQuery ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

type Rep ListTrafficPolicyInstances Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

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

Defined in Amazonka.Route53.ListTrafficPolicyInstances

newListTrafficPolicyInstances :: ListTrafficPolicyInstances Source #

Create a value of ListTrafficPolicyInstances 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:trafficPolicyInstanceTypeMarker:ListTrafficPolicyInstances', listTrafficPolicyInstances_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 ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

$sel:maxItems:ListTrafficPolicyInstances', listTrafficPolicyInstances_maxItems - The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances 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.

$sel:hostedZoneIdMarker:ListTrafficPolicyInstances', listTrafficPolicyInstances_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 ListTrafficPolicyInstances 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 in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

$sel:trafficPolicyInstanceNameMarker:ListTrafficPolicyInstances', listTrafficPolicyInstances_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 ListTrafficPolicyInstances 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 in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Request Lenses

listTrafficPolicyInstances_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstances (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 ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstances_maxItems :: Lens' ListTrafficPolicyInstances (Maybe Text) Source #

The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances 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.

listTrafficPolicyInstances_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstances (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 ListTrafficPolicyInstances 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 in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstances_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstances (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 ListTrafficPolicyInstances 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 in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

Destructuring the Response

data ListTrafficPolicyInstancesResponse Source #

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

See: newListTrafficPolicyInstancesResponse smart constructor.

Constructors

ListTrafficPolicyInstancesResponse' 

Fields

  • trafficPolicyInstanceTypeMarker :: Maybe RRType

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

  • hostedZoneIdMarker :: Maybe ResourceId

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

  • trafficPolicyInstanceNameMarker :: Maybe Text

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

  • httpStatus :: Int

    The response's http status code.

  • trafficPolicyInstances :: [TrafficPolicyInstance]

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

  • isTruncated :: Bool

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

  • maxItems :: Text

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

Instances

Instances details
Eq ListTrafficPolicyInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Read ListTrafficPolicyInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Show ListTrafficPolicyInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Generic ListTrafficPolicyInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

Associated Types

type Rep ListTrafficPolicyInstancesResponse :: Type -> Type #

NFData ListTrafficPolicyInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

type Rep ListTrafficPolicyInstancesResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstances

type Rep ListTrafficPolicyInstancesResponse = D1 ('MetaData "ListTrafficPolicyInstancesResponse" "Amazonka.Route53.ListTrafficPolicyInstances" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "ListTrafficPolicyInstancesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "trafficPolicyInstanceTypeMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RRType)) :*: (S1 ('MetaSel ('Just "hostedZoneIdMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceId)) :*: S1 ('MetaSel ('Just "trafficPolicyInstanceNameMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "trafficPolicyInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TrafficPolicyInstance])) :*: (S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListTrafficPolicyInstancesResponse Source #

Create a value of ListTrafficPolicyInstancesResponse 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:trafficPolicyInstanceTypeMarker:ListTrafficPolicyInstances', listTrafficPolicyInstancesResponse_trafficPolicyInstanceTypeMarker - If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

$sel:hostedZoneIdMarker:ListTrafficPolicyInstances', listTrafficPolicyInstancesResponse_hostedZoneIdMarker - If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

$sel:trafficPolicyInstanceNameMarker:ListTrafficPolicyInstances', listTrafficPolicyInstancesResponse_trafficPolicyInstanceNameMarker - If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

$sel:httpStatus:ListTrafficPolicyInstancesResponse', listTrafficPolicyInstancesResponse_httpStatus - The response's http status code.

$sel:trafficPolicyInstances:ListTrafficPolicyInstancesResponse', listTrafficPolicyInstancesResponse_trafficPolicyInstances - A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

$sel:isTruncated:ListTrafficPolicyInstancesResponse', listTrafficPolicyInstancesResponse_isTruncated - A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

$sel:maxItems:ListTrafficPolicyInstances', listTrafficPolicyInstancesResponse_maxItems - The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

Response Lenses

listTrafficPolicyInstancesResponse_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesResponse (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 that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

listTrafficPolicyInstancesResponse_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe ResourceId) Source #

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

listTrafficPolicyInstancesResponse_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe Text) Source #

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

listTrafficPolicyInstancesResponse_trafficPolicyInstances :: Lens' ListTrafficPolicyInstancesResponse [TrafficPolicyInstance] Source #

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

listTrafficPolicyInstancesResponse_isTruncated :: Lens' ListTrafficPolicyInstancesResponse Bool Source #

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

listTrafficPolicyInstancesResponse_maxItems :: Lens' ListTrafficPolicyInstancesResponse Text Source #

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.