Network.AWS.Route53.ListTrafficPolicyInstances

Gets information about the traffic policy instances that you created by using the current AWS account.

Send a GET request to the /Amazon Route 53 API version /trafficpolicyinstance resource.

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

The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:

• IsTruncated

If the value of IsTruncated in the response is true , there are more traffic policy instances associated with the current AWS account.

If IsTruncated is false , this response includes the last traffic policy instance that is associated with the current account.

• MaxItems

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

• HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker

If IsTruncated is true , these three values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstances , and specify these values in the corresponding request parameters.

If IsTruncated is false , all three elements are omitted from the response.

Creating a Request

listTrafficPolicyInstances :: ListTrafficPolicyInstances

Creates a value of ListTrafficPolicyInstances with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltpiTrafficPolicyInstanceTypeMarker - For the first request to ListTrafficPolicyInstances , omit this value. If the value of IsTruncated in the previous response was true , TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances. If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
• ltpiMaxItems - 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 in the next group of MaxItems traffic policy instances.
• ltpiHostedZoneIdMarker - For the first request to ListTrafficPolicyInstances , omit this value. If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get the next group of MaxItems traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker , 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 MaxItems traffic policy instances. If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.
• ltpiTrafficPolicyInstanceNameMarker - For the first request to ListTrafficPolicyInstances , omit this value. If the value of IsTruncated in the previous response was true , TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances. If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.

data ListTrafficPolicyInstances

A complex type that contains the information about the request to list your traffic policy instances.

See: listTrafficPolicyInstances smart constructor.

Instances

Eq ListTrafficPolicyInstances

Methods

(==) :: ListTrafficPolicyInstances -> ListTrafficPolicyInstances -> Bool

(/=) :: ListTrafficPolicyInstances -> ListTrafficPolicyInstances -> Bool

Data ListTrafficPolicyInstances

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTrafficPolicyInstances -> c ListTrafficPolicyInstances

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTrafficPolicyInstances

toConstr :: ListTrafficPolicyInstances -> Constr

dataTypeOf :: ListTrafficPolicyInstances -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTrafficPolicyInstances)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTrafficPolicyInstances)

gmapT :: (forall b. Data b => b -> b) -> ListTrafficPolicyInstances -> ListTrafficPolicyInstances

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTrafficPolicyInstances -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTrafficPolicyInstances -> r

gmapQ :: (forall d. Data d => d -> u) -> ListTrafficPolicyInstances -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTrafficPolicyInstances -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTrafficPolicyInstances -> m ListTrafficPolicyInstances

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTrafficPolicyInstances -> m ListTrafficPolicyInstances

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTrafficPolicyInstances -> m ListTrafficPolicyInstances

Read ListTrafficPolicyInstances

Methods

readsPrec :: Int -> ReadS ListTrafficPolicyInstances

readList :: ReadS [ListTrafficPolicyInstances]

readPrec :: ReadPrec ListTrafficPolicyInstances

readListPrec :: ReadPrec [ListTrafficPolicyInstances]

Show ListTrafficPolicyInstances

Methods

showsPrec :: Int -> ListTrafficPolicyInstances -> ShowS

show :: ListTrafficPolicyInstances -> String

showList :: [ListTrafficPolicyInstances] -> ShowS

Generic ListTrafficPolicyInstances

Associated Types

type Rep ListTrafficPolicyInstances :: * -> *

Methods

from :: ListTrafficPolicyInstances -> Rep ListTrafficPolicyInstances x

to :: Rep ListTrafficPolicyInstances x -> ListTrafficPolicyInstances

Hashable ListTrafficPolicyInstances

Methods

hashWithSalt :: Int -> ListTrafficPolicyInstances -> Int

hash :: ListTrafficPolicyInstances -> Int

NFData ListTrafficPolicyInstances

Methods

rnf :: ListTrafficPolicyInstances -> ()

AWSRequest ListTrafficPolicyInstances

Associated Types

type Rs ListTrafficPolicyInstances :: *

Methods

request :: ListTrafficPolicyInstances -> Request ListTrafficPolicyInstances

response :: MonadResource m => Logger -> Service -> Proxy * ListTrafficPolicyInstances -> ClientResponse -> m (Response ListTrafficPolicyInstances)

ToPath ListTrafficPolicyInstances

Methods

toPath :: ListTrafficPolicyInstances -> ByteString

ToHeaders ListTrafficPolicyInstances

Methods

toHeaders :: ListTrafficPolicyInstances -> [Header]

ToQuery ListTrafficPolicyInstances

Methods

toQuery :: ListTrafficPolicyInstances -> QueryString

type Rep ListTrafficPolicyInstances

type Rep ListTrafficPolicyInstances = D1 (MetaData "ListTrafficPolicyInstances" "Network.AWS.Route53.ListTrafficPolicyInstances" "amazonka-route53-1.4.5-DoQ7bXPvDC1HwWocjSAILy" False) (C1 (MetaCons "ListTrafficPolicyInstances'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ltpiTrafficPolicyInstanceTypeMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RecordType))) (S1 (MetaSel (Just Symbol "_ltpiMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ltpiHostedZoneIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResourceId))) (S1 (MetaSel (Just Symbol "_ltpiTrafficPolicyInstanceNameMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Rs ListTrafficPolicyInstances

type Rs ListTrafficPolicyInstances = ListTrafficPolicyInstancesResponse

Request Lenses

ltpiTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstances (Maybe RecordType)

For the first request to ListTrafficPolicyInstances , omit this value. If the value of IsTruncated in the previous response was true , TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances. If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.

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

ltpiHostedZoneIdMarker :: Lens' ListTrafficPolicyInstances (Maybe ResourceId)

For the first request to ListTrafficPolicyInstances , omit this value. If the value of IsTruncated in the previous response was true , you have more traffic policy instances. To get the next group of MaxItems traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker , 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 MaxItems traffic policy instances. If the value of IsTruncated in the previous response was false , there are no more traffic policy instances to get.

ltpiTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstances (Maybe Text)

For the first request to ListTrafficPolicyInstances , omit this value. If the value of IsTruncated in the previous response was true , TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems 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

listTrafficPolicyInstancesResponse

Arguments

:: Int

ltpirsResponseStatus

-> Bool

ltpirsIsTruncated

-> Text

ltpirsMaxItems

-> ListTrafficPolicyInstancesResponse

Creates a value of ListTrafficPolicyInstancesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltpirsTrafficPolicyInstanceTypeMarker - 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.
• ltpirsHostedZoneIdMarker - If IsTruncated is true , HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.
• ltpirsTrafficPolicyInstanceNameMarker - If IsTruncated is true , TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.
• ltpirsResponseStatus - -- | The response status code.
• ltpirsTrafficPolicyInstances - A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.
• ltpirsIsTruncated - 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 MaxItems traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.
• ltpirsMaxItems - The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

data ListTrafficPolicyInstancesResponse

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

See: listTrafficPolicyInstancesResponse smart constructor.

Instances

Eq ListTrafficPolicyInstancesResponse

Methods

(==) :: ListTrafficPolicyInstancesResponse -> ListTrafficPolicyInstancesResponse -> Bool

(/=) :: ListTrafficPolicyInstancesResponse -> ListTrafficPolicyInstancesResponse -> Bool

Data ListTrafficPolicyInstancesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTrafficPolicyInstancesResponse -> c ListTrafficPolicyInstancesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTrafficPolicyInstancesResponse

toConstr :: ListTrafficPolicyInstancesResponse -> Constr

dataTypeOf :: ListTrafficPolicyInstancesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTrafficPolicyInstancesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTrafficPolicyInstancesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListTrafficPolicyInstancesResponse -> ListTrafficPolicyInstancesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTrafficPolicyInstancesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTrafficPolicyInstancesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListTrafficPolicyInstancesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTrafficPolicyInstancesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTrafficPolicyInstancesResponse -> m ListTrafficPolicyInstancesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTrafficPolicyInstancesResponse -> m ListTrafficPolicyInstancesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTrafficPolicyInstancesResponse -> m ListTrafficPolicyInstancesResponse

Read ListTrafficPolicyInstancesResponse

Methods

readsPrec :: Int -> ReadS ListTrafficPolicyInstancesResponse

readList :: ReadS [ListTrafficPolicyInstancesResponse]

readPrec :: ReadPrec ListTrafficPolicyInstancesResponse

readListPrec :: ReadPrec [ListTrafficPolicyInstancesResponse]

Show ListTrafficPolicyInstancesResponse

Methods

showsPrec :: Int -> ListTrafficPolicyInstancesResponse -> ShowS

show :: ListTrafficPolicyInstancesResponse -> String

showList :: [ListTrafficPolicyInstancesResponse] -> ShowS

Generic ListTrafficPolicyInstancesResponse

Associated Types

type Rep ListTrafficPolicyInstancesResponse :: * -> *

Methods

from :: ListTrafficPolicyInstancesResponse -> Rep ListTrafficPolicyInstancesResponse x

to :: Rep ListTrafficPolicyInstancesResponse x -> ListTrafficPolicyInstancesResponse

NFData ListTrafficPolicyInstancesResponse

Methods

rnf :: ListTrafficPolicyInstancesResponse -> ()

type Rep ListTrafficPolicyInstancesResponse

type Rep ListTrafficPolicyInstancesResponse = D1 (MetaData "ListTrafficPolicyInstancesResponse" "Network.AWS.Route53.ListTrafficPolicyInstances" "amazonka-route53-1.4.5-DoQ7bXPvDC1HwWocjSAILy" False) (C1 (MetaCons "ListTrafficPolicyInstancesResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ltpirsTrafficPolicyInstanceTypeMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RecordType))) ((:*:) (S1 (MetaSel (Just Symbol "_ltpirsHostedZoneIdMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResourceId))) (S1 (MetaSel (Just Symbol "_ltpirsTrafficPolicyInstanceNameMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ltpirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_ltpirsTrafficPolicyInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [TrafficPolicyInstance]))) ((:*:) (S1 (MetaSel (Just Symbol "_ltpirsIsTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_ltpirsMaxItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

Response Lenses

ltpirsTrafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe RecordType)

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.

ltpirsHostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe ResourceId)

If IsTruncated is true , HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

ltpirsTrafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe Text)

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

ltpirsResponseStatus :: Lens' ListTrafficPolicyInstancesResponse Int

• - | The response status code.

ltpirsTrafficPolicyInstances :: Lens' ListTrafficPolicyInstancesResponse [TrafficPolicyInstance]

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

ltpirsIsTruncated :: Lens' ListTrafficPolicyInstancesResponse 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 MaxItems traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker , TrafficPolicyInstanceNameMarker , and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

ltpirsMaxItems :: Lens' ListTrafficPolicyInstancesResponse Text

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