amazonka-route53-2.0: Amazon Route 53 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Description

Gets information about the traffic policy instances that you created in a specified hosted zone.

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

Creating a Request

data ListTrafficPolicyInstancesByHostedZone Source #

A request for the traffic policy instances that you created in a specified hosted zone.

See: newListTrafficPolicyInstancesByHostedZone smart constructor.

Constructors

ListTrafficPolicyInstancesByHostedZone' 

Fields

  • maxItems :: Maybe Text

    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.

  • trafficPolicyInstanceNameMarker :: Maybe Text

    If the value of IsTruncated in the previous response is 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.

  • trafficPolicyInstanceTypeMarker :: Maybe RRType

    If the value of IsTruncated in the previous response is 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.

  • hostedZoneId :: ResourceId

    The ID of the hosted zone that you want to list traffic policy instances for.

Instances

Instances details
ToHeaders ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

ToPath ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

ToQuery ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

AWSRequest ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Generic ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Read ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Show ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

NFData ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Eq ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Hashable ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

type AWSResponse ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

type Rep ListTrafficPolicyInstancesByHostedZone Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

type Rep ListTrafficPolicyInstancesByHostedZone = D1 ('MetaData "ListTrafficPolicyInstancesByHostedZone" "Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "ListTrafficPolicyInstancesByHostedZone'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trafficPolicyInstanceNameMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "trafficPolicyInstanceTypeMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RRType)) :*: S1 ('MetaSel ('Just "hostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceId))))

newListTrafficPolicyInstancesByHostedZone Source #

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

ListTrafficPolicyInstancesByHostedZone, listTrafficPolicyInstancesByHostedZone_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.

ListTrafficPolicyInstancesByHostedZone, listTrafficPolicyInstancesByHostedZone_trafficPolicyInstanceNameMarker - If the value of IsTruncated in the previous response is 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.

ListTrafficPolicyInstancesByHostedZone, listTrafficPolicyInstancesByHostedZone_trafficPolicyInstanceTypeMarker - If the value of IsTruncated in the previous response is 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.

ListTrafficPolicyInstancesByHostedZone, listTrafficPolicyInstancesByHostedZone_hostedZoneId - The ID of the hosted zone that you want to list traffic policy instances for.

Request Lenses

listTrafficPolicyInstancesByHostedZone_maxItems :: Lens' ListTrafficPolicyInstancesByHostedZone (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.

listTrafficPolicyInstancesByHostedZone_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe Text) Source #

If the value of IsTruncated in the previous response is 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.

listTrafficPolicyInstancesByHostedZone_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe RRType) Source #

If the value of IsTruncated in the previous response is 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.

listTrafficPolicyInstancesByHostedZone_hostedZoneId :: Lens' ListTrafficPolicyInstancesByHostedZone ResourceId Source #

The ID of the hosted zone that you want to list traffic policy instances for.

Destructuring the Response

data ListTrafficPolicyInstancesByHostedZoneResponse Source #

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

See: newListTrafficPolicyInstancesByHostedZoneResponse smart constructor.

Constructors

ListTrafficPolicyInstancesByHostedZoneResponse' 

Fields

  • trafficPolicyInstanceNameMarker :: Maybe Text

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.

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

  • 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 the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

  • maxItems :: Text

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

Instances

Instances details
Generic ListTrafficPolicyInstancesByHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Read ListTrafficPolicyInstancesByHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Show ListTrafficPolicyInstancesByHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

NFData ListTrafficPolicyInstancesByHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

Eq ListTrafficPolicyInstancesByHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

type Rep ListTrafficPolicyInstancesByHostedZoneResponse Source # 
Instance details

Defined in Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone

type Rep ListTrafficPolicyInstancesByHostedZoneResponse = D1 ('MetaData "ListTrafficPolicyInstancesByHostedZoneResponse" "Amazonka.Route53.ListTrafficPolicyInstancesByHostedZone" "amazonka-route53-2.0-8wP357MyuPX6rh87d4wklb" 'False) (C1 ('MetaCons "ListTrafficPolicyInstancesByHostedZoneResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "trafficPolicyInstanceNameMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "trafficPolicyInstanceTypeMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RRType)) :*: 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)))))

newListTrafficPolicyInstancesByHostedZoneResponse Source #

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

ListTrafficPolicyInstancesByHostedZone, listTrafficPolicyInstancesByHostedZoneResponse_trafficPolicyInstanceNameMarker - If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.

ListTrafficPolicyInstancesByHostedZone, listTrafficPolicyInstancesByHostedZoneResponse_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 traffic policy instances.

$sel:httpStatus:ListTrafficPolicyInstancesByHostedZoneResponse', listTrafficPolicyInstancesByHostedZoneResponse_httpStatus - The response's http status code.

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

$sel:isTruncated:ListTrafficPolicyInstancesByHostedZoneResponse', listTrafficPolicyInstancesByHostedZoneResponse_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 submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

ListTrafficPolicyInstancesByHostedZone, listTrafficPolicyInstancesByHostedZoneResponse_maxItems - The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response.

Response Lenses

listTrafficPolicyInstancesByHostedZoneResponse_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (Maybe Text) Source #

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.

listTrafficPolicyInstancesByHostedZoneResponse_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (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 traffic policy instances.

listTrafficPolicyInstancesByHostedZoneResponse_trafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse [TrafficPolicyInstance] Source #

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

listTrafficPolicyInstancesByHostedZoneResponse_isTruncated :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse 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 submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

listTrafficPolicyInstancesByHostedZoneResponse_maxItems :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Text Source #

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