Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class ListTrafficPolicyInstancesCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { Route53Client, ListTrafficPolicyInstancesCommand } from "@aws-sdk/client-route-53"; // ES Modules import
// const { Route53Client, ListTrafficPolicyInstancesCommand } = require("@aws-sdk/client-route-53"); // CommonJS import
const client = new Route53Client(config);
const input = { // ListTrafficPolicyInstancesRequest
HostedZoneIdMarker: "STRING_VALUE",
TrafficPolicyInstanceNameMarker: "STRING_VALUE",
TrafficPolicyInstanceTypeMarker: "SOA" || "A" || "TXT" || "NS" || "CNAME" || "MX" || "NAPTR" || "PTR" || "SRV" || "SPF" || "AAAA" || "CAA" || "DS",
MaxItems: Number("int"),
};
const command = new ListTrafficPolicyInstancesCommand(input);
const response = await client.send(command);
// { // ListTrafficPolicyInstancesResponse
// TrafficPolicyInstances: [ // TrafficPolicyInstances // required
// { // TrafficPolicyInstance
// Id: "STRING_VALUE", // required
// HostedZoneId: "STRING_VALUE", // required
// Name: "STRING_VALUE", // required
// TTL: Number("long"), // required
// State: "STRING_VALUE", // required
// Message: "STRING_VALUE", // required
// TrafficPolicyId: "STRING_VALUE", // required
// TrafficPolicyVersion: Number("int"), // required
// TrafficPolicyType: "SOA" || "A" || "TXT" || "NS" || "CNAME" || "MX" || "NAPTR" || "PTR" || "SRV" || "SPF" || "AAAA" || "CAA" || "DS", // required
// },
// ],
// HostedZoneIdMarker: "STRING_VALUE",
// TrafficPolicyInstanceNameMarker: "STRING_VALUE",
// TrafficPolicyInstanceTypeMarker: "SOA" || "A" || "TXT" || "NS" || "CNAME" || "MX" || "NAPTR" || "PTR" || "SRV" || "SPF" || "AAAA" || "CAA" || "DS",
// IsTruncated: true || false, // required
// MaxItems: Number("int"), // required
// };

Param

ListTrafficPolicyInstancesCommandInput

Returns

ListTrafficPolicyInstancesCommandOutput

See

Throws

InvalidInput (client fault)

The input is not valid.

Throws

NoSuchTrafficPolicyInstance (client fault)

No traffic policy instance exists with the specified ID.

Throws

Route53ServiceException

Base exception class for all service exceptions from Route53 service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods