Amazon Route 53 Route 53 Trafficpolicyinstances API
The Route 53 Trafficpolicyinstances API from Amazon Route 53 — 3 operation(s) for route 53 trafficpolicyinstances.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-route-53:amazon-route-53-trafficpolicyinstances-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: Amazon Route 53 Trafficpolicyinstances API
version: '2013-04-01'
description: Generated from AWS's published Smithy model for Amazon Route 53. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://route53.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/2013-04-01/trafficpolicyinstances:
get:
operationId: ListTrafficPolicyInstances
summary: List Traffic Policy Instances
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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ListTrafficPolicyInstancesResponse'
'400':
description: InvalidInput
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidInput'
'404':
description: NoSuchTrafficPolicyInstance
content:
text/xml:
schema:
$ref: '#/components/schemas/NoSuchTrafficPolicyInstance'
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/ListTrafficPolicyInstancesRequest'
tags:
- Trafficpolicyinstances
/2013-04-01/trafficpolicyinstances/hostedzone:
get:
operationId: ListTrafficPolicyInstancesByHostedZone
summary: List Traffic Policy Instances By Hosted Zone
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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ListTrafficPolicyInstancesByHostedZoneResponse'
'400':
description: InvalidInput
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidInput'
'404':
description: NoSuchHostedZone; NoSuchTrafficPolicyInstance
content:
text/xml:
schema:
$ref: '#/components/schemas/NoSuchHostedZone'
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/ListTrafficPolicyInstancesByHostedZoneRequest'
tags:
- Trafficpolicyinstances
/2013-04-01/trafficpolicyinstances/trafficpolicy:
get:
operationId: ListTrafficPolicyInstancesByPolicy
summary: List Traffic Policy Instances By Policy
description: Gets information about the traffic policy instances that you created by using a specify traffic policy
version. 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ListTrafficPolicyInstancesByPolicyResponse'
'400':
description: InvalidInput
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidInput'
'404':
description: NoSuchTrafficPolicy; NoSuchTrafficPolicyInstance
content:
text/xml:
schema:
$ref: '#/components/schemas/NoSuchTrafficPolicy'
requestBody:
content:
application/xml:
schema:
$ref: '#/components/schemas/ListTrafficPolicyInstancesByPolicyRequest'
tags:
- Trafficpolicyinstances
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: route53
schemas:
InvalidInput:
type: object
properties:
message:
type: string
ListTrafficPolicyInstancesByHostedZoneRequest:
type: object
properties:
HostedZoneId:
type: string
description: The ID of the hosted zone that you want to list traffic policy instances for.
TrafficPolicyInstanceNameMarker:
type: string
description: 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:
type: string
enum:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
- DS
- TLSA
- SSHFP
- SVCB
- HTTPS
description: 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.
MaxItems:
type: integer
description: 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.
required:
- HostedZoneId
ListTrafficPolicyInstancesByHostedZoneResponse:
type: object
properties:
TrafficPolicyInstances:
type: array
items:
$ref: '#/components/schemas/TrafficPolicyInstance'
description: A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches
the elements in the request.
TrafficPolicyInstanceNameMarker:
type: string
description: If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance
in the next group of traffic policy instances.
TrafficPolicyInstanceTypeMarker:
type: string
enum:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
- DS
- TLSA
- SSHFP
- SVCB
- HTTPS
description: 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.
IsTruncated:
type: boolean
description: 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:
type: integer
description: The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone
request that produced the current response.
required:
- TrafficPolicyInstances
- IsTruncated
- MaxItems
ListTrafficPolicyInstancesByPolicyRequest:
type: object
properties:
TrafficPolicyId:
type: string
description: The ID of the traffic policy for which you want to list traffic policy instances.
TrafficPolicyVersion:
type: integer
description: The version of the traffic policy for which you want to list traffic policy instances. The version
must be associated with the traffic policy that is specified by TrafficPolicyId.
HostedZoneIdMarker:
type: string
description: 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 ListTrafficPolicyInstancesByPolicy 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 that Amazon Route 53 will return if you submit another request. If the
value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.
TrafficPolicyInstanceNameMarker:
type: string
description: 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 ListTrafficPolicyInstancesByPolicy 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 that Amazon Route 53 will return if you submit another
request. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances
to get.
TrafficPolicyInstanceTypeMarker:
type: string
enum:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
- DS
- TLSA
- SSHFP
- SVCB
- HTTPS
description: 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 ListTrafficPolicyInstancesByPolicy request. For the value
of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response,
which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another
request. If the value of IsTruncated in the previous response was false, there are no more traffic policy instances
to get.
MaxItems:
type: integer
description: 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.
required:
- TrafficPolicyId
- TrafficPolicyVersion
ListTrafficPolicyInstancesByPolicyResponse:
type: object
properties:
TrafficPolicyInstances:
type: array
items:
$ref: '#/components/schemas/TrafficPolicyInstance'
description: A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches
the elements in the request.
HostedZoneIdMarker:
type: string
description: If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy
instance in the next group of traffic policy instances.
TrafficPolicyInstanceNameMarker:
type: string
description: If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance
in the next group of MaxItems traffic policy instances.
TrafficPolicyInstanceTypeMarker:
type: string
enum:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
- DS
- TLSA
- SSHFP
- SVCB
- HTTPS
description: 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.
IsTruncated:
type: boolean
description: 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 calling ListTrafficPolicyInstancesByPolicy
again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker
elements in the corresponding request parameters.
MaxItems:
type: integer
description: The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy
that produced the current response.
required:
- TrafficPolicyInstances
- IsTruncated
- MaxItems
ListTrafficPolicyInstancesRequest:
type: object
properties:
HostedZoneIdMarker:
type: string
description: 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:
type: string
description: 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.
TrafficPolicyInstanceTypeMarker:
type: string
enum:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
- DS
- TLSA
- SSHFP
- SVCB
- HTTPS
description: 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:
type: integer
description: 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.
ListTrafficPolicyInstancesResponse:
type: object
properties:
TrafficPolicyInstances:
type: array
items:
$ref: '#/components/schemas/TrafficPolicyInstance'
description: A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches
the elements in the request.
HostedZoneIdMarker:
type: string
description: 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:
type: string
description: 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.
TrafficPolicyInstanceTypeMarker:
type: string
enum:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
- DS
- TLSA
- SSHFP
- SVCB
- HTTPS
description: 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.
IsTruncated:
type: boolean
description: 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:
type: integer
description: The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that
produced the current response.
required:
- TrafficPolicyInstances
- IsTruncated
- MaxItems
NoSuchHostedZone:
type: object
properties:
message:
type: string
NoSuchTrafficPolicy:
type: object
properties:
message:
type: string
NoSuchTrafficPolicyInstance:
type: object
properties:
message:
type: string
TrafficPolicyInstance:
type: object
properties:
Id:
type: string
description: The ID that Amazon Route 53 assigned to the new traffic policy instance.
HostedZoneId:
type: string
description: The ID of the hosted zone that Amazon Route 53 created resource record sets in.
Name:
type: string
description: The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource
record sets that are associated with this traffic policy instance.
TTL:
type: integer
description: The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified
hosted zone.
State:
type: string
description: 'The value of State is one of the following values: Applied Amazon Route 53 has finished creating resource
record sets, and changes have propagated to all Route 53 edge locations. Creating Route 53 is creating the resource
record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.
Failed Route 53 wasn''t able to create or update the resource record sets. When the value of State is Failed,
see Message for an explanation of what caused the request to fail.'
Message:
type: string
description: If State is Failed, an explanation of the reason for the failure. If State is another value, Message
is empty.
TrafficPolicyId:
type: string
description: The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified
hosted zone.
TrafficPolicyVersion:
type: integer
description: The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified
hosted zone.
TrafficPolicyType:
type: string
enum:
- SOA
- A
- TXT
- NS
- CNAME
- MX
- NAPTR
- PTR
- SRV
- SPF
- AAAA
- CAA
- DS
- TLSA
- SSHFP
- SVCB
- HTTPS
description: The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this
traffic policy instance.
required:
- Id
- HostedZoneId
- Name
- TTL
- State
- Message
- TrafficPolicyId
- TrafficPolicyVersion
- TrafficPolicyType
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/route-53/service/2013-04-01/route-53-2013-04-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)