@itentialopensource/adapter-amazon_route53
Version:
This adapter integrates with system described as: Amazon Route53.
1,318 lines • 480 kB
YAML
openapi: 3.0.0
info:
title: Amazon Route 53
description: Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
contact:
name: Mike Ralphson
url: https://github.com/mermade/aws2openapi
email: mike.ralphson@gmail.com
version: '2013-04-01'
servers:
- url: https://route53.amazonaws.com
description: The general Route 53 multi-region endpoint
variables: {}
- url: http://route53.us-gov.amazonaws.com
description: The general Route 53 endpoint for AWS GovCloud (US) and AWS GovCloud (US-East)
variables: {}
- url: https://route53.us-gov.amazonaws.com
description: The general Route 53 endpoint for AWS GovCloud (US) and AWS GovCloud (US-East)
variables: {}
- url: http://route53.amazonaws.com.cn
description: The general Route 53 endpoint for China (Beijing) and China (Ningxia)
variables: {}
- url: https://route53.amazonaws.com.cn
description: The general Route 53 endpoint for China (Beijing) and China (Ningxia)
variables: {}
paths:
/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate:
post:
summary: ActivateKeySigningKey
description: Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to <code>ACTIVE</code>.
operationId: ActivateKeySigningKey
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: HostedZoneId
in: path
description: A unique string used to identify a hosted zone.
required: true
style: simple
schema:
maxLength: 32
type: string
- name: Name
in: path
description: A string used to identify a key-signing key (KSK). <code>Name</code> can include numbers, letters, and underscores (_). <code>Name</code> must be unique for each key-signing key in the same hosted zone.
required: true
style: simple
schema:
maxLength: 128
minLength: 3
type: string
responses:
'200':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ActivateKeySigningKeyResponse'
- xml:
name: ActivateKeySigningKeyResponse
attribute: false
wrapped: false
'480':
description: ConcurrentModification
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: NoSuchKeySigningKey
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: InvalidKeySigningKeyStatus
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
'483':
description: InvalidSigningStatus
headers: {}
content:
text/xml:
schema:
xml:
name: response483
attribute: false
wrapped: false
'484':
description: InvalidKMSArn
headers: {}
content:
text/xml:
schema:
xml:
name: response484
attribute: false
wrapped: false
'485':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response485
attribute: false
wrapped: false
deprecated: false
/2013-04-01/hostedzone/{Id}/associatevpc:
post:
summary: AssociateVPCWithHostedZone
description: <p>Associates an Amazon VPC with a private hosted zone. </p> <important> <p>To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.</p> </important> <note> <p>If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a <code>CreateVPCAssociationAuthorization</code> request. Then the account that created the VPC must submit an <code>AssociateVPCWithHostedZone</code> request.</p> </note>
operationId: AssociateVPCWithHostedZone
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Id
in: path
description: <p>The ID of the private hosted zone that you want to associate an Amazon VPC with.</p> <p>Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.</p>
required: true
style: simple
schema:
maxLength: 32
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: text/xml
requestBody:
description: ''
content:
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/HostedzoneAssociatevpc201341Request'
- xml:
name: HostedzoneAssociatevpc201341Request
attribute: false
wrapped: false
required: true
responses:
'200':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/AssociateVPCWithHostedZoneResponse'
- description: A complex type that contains the response information for the <code>AssociateVPCWithHostedZone</code> request.
xml:
name: AssociateVPCWithHostedZoneResponse
attribute: false
wrapped: false
'480':
description: NoSuchHostedZone
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: NotAuthorizedException
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: InvalidVPCId
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
'483':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response483
attribute: false
wrapped: false
'484':
description: PublicZoneVPCAssociation
headers: {}
content:
text/xml:
schema:
xml:
name: response484
attribute: false
wrapped: false
'485':
description: ConflictingDomainExists
headers: {}
content:
text/xml:
schema:
xml:
name: response485
attribute: false
wrapped: false
'486':
description: LimitsExceeded
headers: {}
content:
text/xml:
schema:
xml:
name: response486
attribute: false
wrapped: false
'487':
description: PriorRequestNotComplete
headers: {}
content:
text/xml:
schema:
xml:
name: response487
attribute: false
wrapped: false
deprecated: false
/2013-04-01/hostedzone/{Id}/rrset/:
post:
summary: ChangeResourceRecordSets
description: "<p>Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use <code>ChangeResourceRecordSets</code> to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.</p> <p> <b>Deleting Resource Record Sets</b> </p> <p>To delete a resource record set, you must specify all the same values that you specified when you created it.</p> <p> <b>Change Batches and Transactional Changes</b> </p> <p>The request body must include a document with a <code>ChangeResourceRecordSetsRequest</code> element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone. </p> <p>For example, suppose a change batch request contains two changes: it deletes the <code>CNAME</code> resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the <code>DELETE</code> or the <code>CREATE</code> action fails, then the request is canceled, and the original <code>CNAME</code> record continues to exist.</p> <note> <p>If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an <code>InvalidChangeBatch</code> error.</p> </note> <p> <b>Traffic Flow</b> </p> <p>To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html\">Using Traffic Flow to Route DNS Traffic</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p> <b>Create, Delete, and Upsert</b> </p> <p>Use <code>ChangeResourceRecordsSetsRequest</code> to perform the following actions:</p> <ul> <li> <p> <code>CREATE</code>: Creates a resource record set that has the specified values.</p> </li> <li> <p> <code>DELETE</code>: Deletes an existing resource record set that has the specified values.</p> </li> <li> <p> <code>UPSERT</code>: If a resource record set does not already exist, Amazon Web Services creates it. If a resource set does exist, Route 53 updates it with the values in the request. </p> </li> </ul> <p> <b>Syntaxes for Creating, Updating, and Deleting Resource Record Sets</b> </p> <p>The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. </p> <p>For an example for each type of resource record set, see \"Examples.\"</p> <p>Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using <code>ChangeResourceRecordSets</code>. </p> <p> <b>Change Propagation to Route 53 DNS Servers</b> </p> <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, <code>GetChange</code> returns a status of <code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html\">GetChange</a>.</p> <p> <b>Limits on ChangeResourceRecordSets Requests</b> </p> <p>For information about the limits on a <code>ChangeResourceRecordSets</code> request, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html\">Limits</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>"
operationId: ChangeResourceRecordSets
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Id
in: path
description: The ID of the hosted zone that contains the resource record sets that you want to change.
required: true
style: simple
schema:
maxLength: 32
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: text/xml
requestBody:
description: ''
content:
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/HostedzoneRrset201341Request'
- xml:
name: HostedzoneRrset201341Request
attribute: false
wrapped: false
required: true
responses:
'200':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ChangeResourceRecordSetsResponse'
- description: A complex type containing the response for the request.
xml:
name: ChangeResourceRecordSetsResponse
attribute: false
wrapped: false
'480':
description: NoSuchHostedZone
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: NoSuchHealthCheck
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: InvalidChangeBatch
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
'483':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response483
attribute: false
wrapped: false
'484':
description: PriorRequestNotComplete
headers: {}
content:
text/xml:
schema:
xml:
name: response484
attribute: false
wrapped: false
deprecated: false
/2013-04-01/tags/{ResourceType}/{ResourceId}:
post:
summary: ChangeTagsForResource
description: <p>Adds, edits, or deletes tags for a health check or a hosted zone.</p> <p>For information about using tags for cost allocation, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>Billing and Cost Management User Guide</i>.</p>
operationId: ChangeTagsForResource
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ResourceType
in: path
description: <p>The type of the resource.</p> <ul> <li> <p>The resource type for health checks is <code>healthcheck</code>.</p> </li> <li> <p>The resource type for hosted zones is <code>hostedzone</code>.</p> </li> </ul>
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/TagResourceType'
- description: <p>The type of the resource.</p> <ul> <li> <p>The resource type for health checks is <code>healthcheck</code>.</p> </li> <li> <p>The resource type for hosted zones is <code>hostedzone</code>.</p> </li> </ul>
example: healthcheck
- name: ResourceId
in: path
description: The ID of the resource for which you want to add, change, or delete tags.
required: true
style: simple
schema:
maxLength: 64
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: text/xml
requestBody:
description: ''
content:
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Tags201341Request'
- xml:
name: Tags201341Request
attribute: false
wrapped: false
required: true
responses:
'200':
description: Success
headers: {}
content:
text/xml:
schema:
type: object
description: Empty response for the request.
xml:
name: response200
attribute: false
wrapped: false
'480':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: NoSuchHealthCheck
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: NoSuchHostedZone
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
'483':
description: PriorRequestNotComplete
headers: {}
content:
text/xml:
schema:
xml:
name: response483
attribute: false
wrapped: false
'484':
description: ThrottlingException
headers: {}
content:
text/xml:
schema:
xml:
name: response484
attribute: false
wrapped: false
deprecated: false
get:
summary: ListTagsForResource
description: <p>Lists tags for one health check or hosted zone. </p> <p>For information about using tags for cost allocation, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>Billing and Cost Management User Guide</i>.</p>
operationId: ListTagsForResource
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ResourceType
in: path
description: <p>The type of the resource.</p> <ul> <li> <p>The resource type for health checks is <code>healthcheck</code>.</p> </li> <li> <p>The resource type for hosted zones is <code>hostedzone</code>.</p> </li> </ul>
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/TagResourceType'
- description: <p>The type of the resource.</p> <ul> <li> <p>The resource type for health checks is <code>healthcheck</code>.</p> </li> <li> <p>The resource type for hosted zones is <code>hostedzone</code>.</p> </li> </ul>
example: healthcheck
- name: ResourceId
in: path
description: The ID of the resource for which you want to retrieve tags.
required: true
style: simple
schema:
maxLength: 64
type: string
responses:
'200':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ListTagsForResourceResponse'
- description: A complex type that contains information about the health checks or hosted zones for which you want to list tags.
xml:
name: ListTagsForResourceResponse
attribute: false
wrapped: false
'480':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: NoSuchHealthCheck
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: NoSuchHostedZone
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
'483':
description: PriorRequestNotComplete
headers: {}
content:
text/xml:
schema:
xml:
name: response483
attribute: false
wrapped: false
'484':
description: ThrottlingException
headers: {}
content:
text/xml:
schema:
xml:
name: response484
attribute: false
wrapped: false
deprecated: false
/2013-04-01/healthcheck:
post:
summary: CreateHealthCheck
description: <p>Creates a new health check.</p> <p>For information about adding health checks to resource record sets, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResourceRecordSet.html#Route53-Type-ResourceRecordSet-HealthCheckId">HealthCheckId</a> in <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html">ChangeResourceRecordSets</a>. </p> <p> <b>ELB Load Balancers</b> </p> <p>If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.</p> <p> <b>Private Hosted Zones</b> </p> <p>You can associate health checks with failover resource record sets in a private hosted zone. Note the following:</p> <ul> <li> <p>Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.</p> </li> <li> <p>You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.</p> </li> <li> <p>You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 <code>StatusCheckFailed</code> metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>.</p> </li> </ul>
operationId: CreateHealthCheck
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: text/xml
requestBody:
description: ''
content:
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Healthcheck201341Request'
- xml:
name: Healthcheck201341Request
attribute: false
wrapped: false
required: true
responses:
'201':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/CreateHealthCheckResponse'
- description: A complex type containing the response information for the new health check.
xml:
name: CreateHealthCheckResponse
attribute: false
wrapped: false
'480':
description: TooManyHealthChecks
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: HealthCheckAlreadyExists
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
deprecated: false
get:
summary: ListHealthChecks
description: 'Retrieve a list of the health checks that are associated with the current Amazon Web Services account. '
operationId: ListHealthChecks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: marker
in: query
description: <p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more health checks. To get another group, submit another <code>ListHealthChecks</code> request. </p> <p>For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more health checks to get.</p>
style: form
explode: true
schema:
maxLength: 64
type: string
- name: maxitems
in: query
description: The maximum number of health checks that you want <code>ListHealthChecks</code> to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set <code>MaxItems</code> to a value greater than 100, Route 53 returns only the first 100 health checks.
style: form
explode: true
schema:
type: string
- name: MaxItems
in: query
description: Pagination limit
style: form
explode: true
schema:
type: string
- name: Marker
in: query
description: Pagination token
style: form
explode: true
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ListHealthChecksResponse'
- description: A complex type that contains the response to a <code>ListHealthChecks</code> request.
xml:
name: ListHealthChecksResponse
attribute: false
wrapped: false
'480':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: IncompatibleVersion
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
deprecated: false
/2013-04-01/hostedzone:
post:
summary: CreateHostedZone
description: <p>Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs). </p> <important> <p>You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.</p> </important> <p>For more information about charges for hosted zones, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53 Pricing</a>.</p> <p>Note the following:</p> <ul> <li> <p>You can't create a hosted zone for a top-level domain (TLD) such as .com.</p> </li> <li> <p>For public hosted zones, Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/SOA-NSrecords.html">NS and SOA Records that Route 53 Creates for a Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the <code>DelegationSetId</code> element.</p> </li> <li> <p>If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/MigratingDNS.html">Migrating DNS Service for an Existing Domain to Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide</i>. </p> </li> </ul> <p>When you submit a <code>CreateHostedZone</code> request, the initial status of the hosted zone is <code>PENDING</code>. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to <code>INSYNC</code>.</p> <p>The <code>CreateHostedZone</code> request requires the caller to have an <code>ec2:DescribeVpcs</code> permission.</p>
operationId: CreateHostedZone
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/Content-Type'
- example: text/xml
requestBody:
description: ''
content:
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Hostedzone201341Request'
- xml:
name: Hostedzone201341Request
attribute: false
wrapped: false
required: true
responses:
'201':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/CreateHostedZoneResponse'
- description: A complex type containing the response information for the hosted zone.
xml:
name: CreateHostedZoneResponse
attribute: false
wrapped: false
'480':
description: InvalidDomainName
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: HostedZoneAlreadyExists
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: TooManyHostedZones
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
'483':
description: InvalidVPCId
headers: {}
content:
text/xml:
schema:
xml:
name: response483
attribute: false
wrapped: false
'484':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response484
attribute: false
wrapped: false
'485':
description: DelegationSetNotAvailable
headers: {}
content:
text/xml:
schema:
xml:
name: response485
attribute: false
wrapped: false
'486':
description: ConflictingDomainExists
headers: {}
content:
text/xml:
schema:
xml:
name: response486
attribute: false
wrapped: false
'487':
description: NoSuchDelegationSet
headers: {}
content:
text/xml:
schema:
xml:
name: response487
attribute: false
wrapped: false
'488':
description: DelegationSetNotReusable
headers: {}
content:
text/xml:
schema:
xml:
name: response488
attribute: false
wrapped: false
deprecated: false
get:
summary: ListHostedZones
description: <p>Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a <code>HostedZones</code> child element for each hosted zone.</p> <p>Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the <code>maxitems</code> parameter to list them in groups of up to 100.</p>
operationId: ListHostedZones
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: marker
in: query
description: <p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more hosted zones. To get more hosted zones, submit another <code>ListHostedZones</code> request. </p> <p>For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more hosted zones to get.</p>
style: form
explode: true
schema:
maxLength: 64
type: string
- name: maxitems
in: query
description: (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than <code>maxitems</code> hosted zones, the value of <code>IsTruncated</code> in the response is <code>true</code>, and the value of <code>NextMarker</code> is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.
style: form
explode: true
schema:
type: string
- name: delegationsetid
in: query
description: If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.
style: form
explode: true
schema:
maxLength: 32
type: string
- name: MaxItems
in: query
description: Pagination limit
style: form
explode: true
schema:
type: string
- name: Marker
in: query
description: Pagination token
style: form
explode: true
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ListHostedZonesResponse'
- xml:
name: ListHostedZonesResponse
attribute: false
wrapped: false
'480':
description: InvalidInput
headers: {}
content:
text/xml:
schema:
xml:
name: response480
attribute: false
wrapped: false
'481':
description: NoSuchDelegationSet
headers: {}
content:
text/xml:
schema:
xml:
name: response481
attribute: false
wrapped: false
'482':
description: DelegationSetNotReusable
headers: {}
content:
text/xml:
schema:
xml:
name: response482
attribute: false
wrapped: false
deprecated: false
/2013-04-01/keysigningkey:
post:
summary: CreateKeySigningKey
description: Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
operationId: CreateKeySigningKey
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Secur