openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 448 kB

JSON

{"openapi":"3.0.0","info":{"version":"2013-04-01","x-release":"v4","title":"Amazon Route 53","description":"Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service. You can use Route 53 to: <ul> <li> Register domain names. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-domain-registration.html\">How domain registration works</a>. </li> <li> Route internet traffic to the resources for your domain For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-dns-service.html\">How internet traffic is routed to your website or web application</a>. </li> <li> Check the health of your resources. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/welcome-health-checks.html\">How Route 53 checks the health of your resources</a>. </li> </ul>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"route53","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/route53-2013-04-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/route53/"},"servers":[{"url":"https://route53.amazonaws.com","variables":{},"description":"The general Route 53 multi-region endpoint"},{"url":"http://route53.us-gov.amazonaws.com","variables":{},"description":"The general Route 53 endpoint for AWS GovCloud (US) and AWS GovCloud (US-East)"},{"url":"https://route53.us-gov.amazonaws.com","variables":{},"description":"The general Route 53 endpoint for AWS GovCloud (US) and AWS GovCloud (US-East)"},{"url":"http://route53.amazonaws.com.cn","variables":{},"description":"The general Route 53 endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://route53.amazonaws.com.cn","variables":{},"description":"The general Route 53 endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/2013-04-01/keysigningkey/{HostedZoneId}/{Name}/activate":{"post":{"operationId":"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>.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ActivateKeySigningKeyResponse"}}}},"480":{"description":"ConcurrentModification","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ConcurrentModification"}}}},"481":{"description":"NoSuchKeySigningKey","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchKeySigningKey"}}}},"482":{"description":"InvalidKeySigningKeyStatus","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidKeySigningKeyStatus"}}}},"483":{"description":"InvalidSigningStatus","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidSigningStatus"}}}},"484":{"description":"InvalidKMSArn","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidKMSArn"}}}},"485":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[{"name":"HostedZoneId","in":"path","required":true,"description":"A unique string used to identify a hosted zone.","schema":{"type":"string","maxLength":32}},{"name":"Name","in":"path","required":true,"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.","schema":{"type":"string","minLength":3,"maxLength":128}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/2013-04-01/hostedzone/{Id}/associatevpc":{"post":{"operationId":"AssociateVPCWithHostedZone","description":"Associates an Amazon VPC with a private hosted zone. <important> 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. </important> <note> 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. </note> <note> When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. The following are the supported partitions: <ul> <li> <code>aws</code> - Amazon Web Services Regions </li> <li> <code>aws-cn</code> - China Regions </li> <li> <code>aws-us-gov</code> - Amazon Web Services GovCloud (US) Region </li> </ul> For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Access Management</a> in the Amazon Web Services General Reference. </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AssociateVPCWithHostedZoneResponse"}}}},"480":{"description":"NoSuchHostedZone","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchHostedZone"}}}},"481":{"description":"NotAuthorizedException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NotAuthorizedException"}}}},"482":{"description":"InvalidVPCId","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidVPCId"}}}},"483":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"484":{"description":"PublicZoneVPCAssociation","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/PublicZoneVPCAssociation"}}}},"485":{"description":"ConflictingDomainExists","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ConflictingDomainExists"}}}},"486":{"description":"LimitsExceeded","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/LimitsExceeded"}}}},"487":{"description":"PriorRequestNotComplete","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/PriorRequestNotComplete"}}}}},"parameters":[{"name":"Id","in":"path","required":true,"description":"The ID of the private hosted zone that you want to associate an Amazon VPC with. Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.","schema":{"type":"string","maxLength":32}}],"requestBody":{"required":true,"content":{"text/xml":{"schema":{"type":"object","required":["VPC"],"properties":{"VPC":{"description":"(Private hosted zones only) A complex type that contains information about an Amazon VPC. If you associate a private hosted zone with an Amazon VPC when you make a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateHostedZone.html\">CreateHostedZone</a> request, the following parameters are also required.","type":"object","properties":{"VPCRegion":{"allOf":[{"$ref":"#/components/schemas/VPCRegion"},{"description":"(Private hosted zones only) The region that an Amazon VPC was created in."}]},"VPCId":{"$ref":"#/components/schemas/VPCId"}}},"Comment":{"description":" Optional: A comment about the association request.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/2013-04-01/cidrcollection/{CidrCollectionId}":{"post":{"operationId":"ChangeCidrCollection","description":"Creates, changes, or deletes CIDR blocks within a collection. Contains authoritative IP information mapping blocks to one or multiple locations. A change request can update multiple locations in a collection at a time, which is helpful if you want to move one or more CIDR blocks from one location to another in one transaction, without downtime. Limits The max number of CIDR blocks included in the request is 1000. As a result, big updates require multiple API calls. PUT and DELETE_IF_EXISTS Use <code>ChangeCidrCollection</code> to perform the following actions: <ul> <li> <code>PUT</code>: Create a CIDR block within the specified collection. </li> <li> <code> DELETE_IF_EXISTS</code>: Delete an existing CIDR block from the collection. </li> </ul>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeCidrCollectionResponse"}}}},"480":{"description":"NoSuchCidrCollectionException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchCidrCollectionException"}}}},"481":{"description":"CidrCollectionVersionMismatchException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CidrCollectionVersionMismatchException"}}}},"482":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"483":{"description":"CidrBlockInUseException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CidrBlockInUseException"}}}},"484":{"description":"LimitsExceeded","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/LimitsExceeded"}}}},"485":{"description":"ConcurrentModification","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ConcurrentModification"}}}}},"parameters":[{"name":"CidrCollectionId","in":"path","required":true,"description":"The UUID of the CIDR collection to update.","schema":{"type":"string","pattern":"[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}"}}],"requestBody":{"required":true,"content":{"text/xml":{"schema":{"type":"object","required":["Changes"],"properties":{"CollectionVersion":{"description":"A sequential counter that Amazon Route 53 sets to 1 when you create a collection and increments it by 1 each time you update the collection. We recommend that you use <code>ListCidrCollection</code> to get the current value of <code>CollectionVersion</code> for the collection that you want to update, and then include that value with the change request. This prevents Route 53 from overwriting an intervening update: <ul> <li> If the value in the request matches the value of <code>CollectionVersion</code> in the collection, Route 53 updates the collection. </li> <li> If the value of <code>CollectionVersion</code> in the collection is greater than the value in the request, the collection was changed after you got the version number. Route 53 does not update the collection, and it returns a <code>CidrCollectionVersionMismatch</code> error. </li> </ul>","type":"integer","minimum":1},"Changes":{"description":" Information about changes to a CIDR collection.","type":"array","items":{"$ref":"#/components/schemas/CidrCollectionChange"},"minItems":1,"maxItems":1000}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteCidrCollection","description":"Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DeleteCidrCollectionResponse"}}}},"480":{"description":"NoSuchCidrCollectionException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchCidrCollectionException"}}}},"481":{"description":"CidrCollectionInUseException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CidrCollectionInUseException"}}}},"482":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"483":{"description":"ConcurrentModification","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ConcurrentModification"}}}}},"parameters":[{"name":"CidrCollectionId","in":"path","required":true,"description":"The UUID of the collection to delete.","schema":{"type":"string","pattern":"[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}"}}]},"get":{"operationId":"ListCidrLocations","description":"Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ListCidrLocationsResponse"}}}},"480":{"description":"NoSuchCidrCollectionException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchCidrCollectionException"}}}},"481":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[{"name":"CidrCollectionId","in":"path","required":true,"description":"The CIDR collection ID.","schema":{"type":"string","pattern":"[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}"}},{"name":"nexttoken","in":"query","required":false,"description":"An opaque pagination token to indicate where the service is to begin enumerating results. If no value is provided, the listing of results starts from the beginning.","schema":{"type":"string","maxLength":1024}},{"name":"maxresults","in":"query","required":false,"description":"The maximum number of CIDR collection locations to return in the response.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/2013-04-01/hostedzone/{Id}/rrset/":{"post":{"operationId":"ChangeResourceRecordSets","description":"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. Deleting Resource Record Sets To delete a resource record set, you must specify all the same values that you specified when you created it. Change Batches and Transactional Changes 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. 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. <note> 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. </note> Traffic Flow 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 Amazon Route 53 Developer Guide. Create, Delete, and Upsert Use <code>ChangeResourceRecordsSetsRequest</code> to perform the following actions: <ul> <li> <code>CREATE</code>: Creates a resource record set that has the specified values. </li> <li> <code>DELETE</code>: Deletes an existing resource record set that has the specified values. </li> <li> <code>UPSERT</code>: If a resource set exists Route 53 updates it with the values in the request. </li> </ul> Syntaxes for Creating, Updating, and Deleting Resource Record Sets 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. For an example for each type of resource record set, see \"Examples.\" 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>. Change Propagation to Route 53 DNS Servers When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. 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 managing the hosted zone within 60 seconds. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html\">GetChange</a>. Limits on ChangeResourceRecordSets Requests 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 Amazon Route 53 Developer Guide.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeResourceRecordSetsResponse"}}}},"480":{"description":"NoSuchHostedZone","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchHostedZone"}}}},"481":{"description":"NoSuchHealthCheck","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchHealthCheck"}}}},"482":{"description":"InvalidChangeBatch","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidChangeBatch"}}}},"483":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"484":{"description":"PriorRequestNotComplete","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/PriorRequestNotComplete"}}}}},"parameters":[{"name":"Id","in":"path","required":true,"description":"The ID of the hosted zone that contains the resource record sets that you want to change.","schema":{"type":"string","maxLength":32}}],"requestBody":{"required":true,"content":{"text/xml":{"schema":{"type":"object","required":["ChangeBatch"],"properties":{"ChangeBatch":{"description":"The information for a change request.","type":"object","properties":{"Comment":{"allOf":[{"$ref":"#/components/schemas/ResourceDescription"},{"description":" Optional: Any comments you want to include about a change batch request."}]},"Changes":{"allOf":[{"$ref":"#/components/schemas/Changes"},{"description":"Information about the changes to make to the record sets."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/2013-04-01/tags/{ResourceType}/{ResourceId}":{"post":{"operationId":"ChangeTagsForResource","description":"Adds, edits, or deletes tags for a health check or a hosted zone. 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 Billing and Cost Management User Guide.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeTagsForResourceResponse"}}}},"480":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"NoSuchHealthCheck","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchHealthCheck"}}}},"482":{"description":"NoSuchHostedZone","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchHostedZone"}}}},"483":{"description":"PriorRequestNotComplete","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/PriorRequestNotComplete"}}}},"484":{"description":"ThrottlingException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ResourceType","in":"path","required":true,"description":"The type of the resource. <ul> <li> The resource type for health checks is <code>healthcheck</code>. </li> <li> The resource type for hosted zones is <code>hostedzone</code>. </li> </ul>","schema":{"type":"string","enum":["healthcheck","hostedzone"]}},{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource for which you want to add, change, or delete tags.","schema":{"type":"string","maxLength":64}}],"requestBody":{"required":true,"content":{"text/xml":{"schema":{"type":"object","properties":{"AddTags":{"description":"A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit <code>Value</code> for. You can add a maximum of 10 tags to a health check or a hosted zone.","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/Tag"},{"xml":{"name":"Tag"}}]},"minItems":1,"maxItems":10},"RemoveTagKeys":{"description":"A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys.","type":"array","items":{"allOf":[{"$ref":"#/components/schemas/TagKey"},{"xml":{"name":"Key"}}]},"minItems":1,"maxItems":10}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListTagsForResource","description":"Lists tags for one health check or hosted zone. 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 Billing and Cost Management User Guide.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"481":{"description":"NoSuchHealthCheck","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchHealthCheck"}}}},"482":{"description":"NoSuchHostedZone","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchHostedZone"}}}},"483":{"description":"PriorRequestNotComplete","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/PriorRequestNotComplete"}}}},"484":{"description":"ThrottlingException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ResourceType","in":"path","required":true,"description":"The type of the resource. <ul> <li> The resource type for health checks is <code>healthcheck</code>. </li> <li> The resource type for hosted zones is <code>hostedzone</code>. </li> </ul>","schema":{"type":"string","enum":["healthcheck","hostedzone"]}},{"name":"ResourceId","in":"path","required":true,"description":"The ID of the resource for which you want to retrieve tags.","schema":{"type":"string","maxLength":64}}]}},"/2013-04-01/cidrcollection":{"post":{"operationId":"CreateCidrCollection","description":"Creates a CIDR collection in the current Amazon Web Services account.","responses":{"201":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CreateCidrCollectionResponse"}}}},"480":{"description":"LimitsExceeded","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/LimitsExceeded"}}}},"481":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}},"482":{"description":"CidrCollectionAlreadyExistsException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CidrCollectionAlreadyExistsException"}}}},"483":{"description":"ConcurrentModification","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ConcurrentModification"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"text/xml":{"schema":{"type":"object","required":["Name","CallerReference"],"properties":{"Name":{"description":"A unique identifier for the account that can be used to reference the collection from other API calls.","type":"string","pattern":"[0-9A-Za-z_\\-]+","minLength":1,"maxLength":64},"CallerReference":{"description":"A client-specific token that allows requests to be securely retried so that the intended outcome will only occur once, retries receive a similar response, and there are no additional edge cases to handle.","type":"string","pattern":"\\p{ASCII}+","minLength":1,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListCidrCollections","description":"Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ListCidrCollectionsResponse"}}}},"480":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[{"name":"nexttoken","in":"query","required":false,"description":"An opaque pagination token to indicate where the service is to begin enumerating results. If no value is provided, the listing of results starts from the beginning.","schema":{"type":"string","maxLength":1024}},{"name":"maxresults","in":"query","required":false,"description":"The maximum number of CIDR collections to return in the response.","schema":{"type":"string"}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}]}},"/2013-04-01/healthcheck":{"post":{"operationId":"CreateHealthCheck","description":"Creates a new health check. 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>. ELB Load Balancers 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. Private Hosted Zones You can associate health checks with failover resource record sets in a private hosted zone. Note the following: <ul> <li> 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. </li> <li> You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server. </li> <li> 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>. </li> </ul>","responses":{"201":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CreateHealthCheckResponse"}}}},"480":{"description":"TooManyHealthChecks","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyHealthChecks"}}}},"481":{"description":"HealthCheckAlreadyExists","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/HealthCheckAlreadyExists"}}}},"482":{"description":"InvalidInput","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidInput"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"text/xml":{"schema":{"type":"object","required":["CallerReference","HealthCheckConfig"],"properties":{"CallerReference":{"description":"A unique string that identifies the request and that allows you to retry a failed <code>CreateHealthCheck</code> request without the risk of creating two identical health checks: <ul> <li> If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check. </li> <li> If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> as a deleted health check, regardless of the settings, Route 53 returns a <code>HealthCheckAlreadyExists</code> error. </li> <li> If you send a <code>CreateHealthCheck</code> request with the same <code>CallerReference</code> as an existing health check but with different settings, Route 53 returns a <code>HealthCheckAlreadyExists</code> error. </li> <li> If you send a <code>CreateHealthCheck</code> request with a unique <code>CallerReference</code> but settings identical to an existing health check, Route 53 creates the health check. </li> </ul>","type":"string","minLength":1,"maxLength":64},"HealthCheckConfig":{"description":"A complex type that contains information about the health check.","type":"object","properties":{"IPAddress":{"allOf":[{"$ref":"#/components/schemas/IPAddress"},{"description":"The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for <code>IPAddress</code>, Route 53 sends a DNS request to resolve the domain name that you specify in <code>FullyQualifiedDomainName</code> at the interval that you specify in <code>RequestInterval</code>. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint. Use one of the following formats for the value of <code>IPAddress</code>: <ul> <li> IPv4 address: four values between 0 and 255, separated by periods (.), for example, <code>192.0.2.44</code>. </li> <li> IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>. You can also shorten IPv6 addresses as described in RFC 5952, for example, <code>2001:db8:85a3::abcd:1:2345</code>. </li> </ul> If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for <code>IPAddress</code>. This ensures that the IP address of your instance will never change. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-FullyQualifiedDomainName\">FullyQualifiedDomainName</a>. Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents: <ul> <li> <a href=\"https://tools.ietf.org/html/rfc5735\">RFC 5735, Special Use IPv4 Addresses</a> </li> <li> <a href=\"https://tools.ietf.org/html/rfc6598\">RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space</a> </li> <li> <a href=\"https://tools.ietf.org/html/rfc5156\">RFC 5156, Special-Use IPv6 Addresses</a> </li> </ul> When the value of <code>Type</code> is <code>CALCULATED</code> or <code>CLOUDWATCH_METRIC</code>, omit <code>IPAddress</code>."}]},"Port":{"allOf":[{"$ref":"#/components/schemas/Port"},{"description":"The port on the endpoint that you want Amazon Route 53 to perform health checks on. <note> Don't specify a value for <code>Port</code> when you specify a value for <code>Type</code> of <code>CLOUDWATCH_METRIC</code> or <code>CALCULATED</code>. </note>"}]},"Type":{"allOf":[{"$ref":"#/components/schemas/HealthCheckType"},{"description":"The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy. <important> You can't change the value of <code>Type</code> after you create a health check. </important> You can create the following types of health checks: <ul> <li> HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. </li> <li> HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. <important> If you specify <code>HTTPS</code> for the value of <code>Type</code>, the endpoint must support TLS v1.0 or later. </important> </li> <li> HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in <code>SearchString</code>. </li> <li> HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an <code>HTTPS</code> request and searches the first 5,120 bytes of the response body for the string that you specify in <code>SearchString</code>. </li> <li> TCP: Route 53 tries to establish a TCP connection. </li> <li> CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is <code>OK</code>, the health check is considered healthy. If the state is <code>ALARM</code>, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is <code>OK</code> or <code>ALARM</code>, the health check status depends on the setting for <code>InsufficientDataHealthStatus</code>: <code>Healthy</code>, <code>Unhealthy</code>, or <code>LastKnownStatus</code>. </li> <li> CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of <code>HealthThreshold</code>. </li> <li> RECOVERY_CONTROL: The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is <code>ON</code>, the health check is considered healthy. If the state is <code>OFF</code>, the health check is considered unhealthy. </li> </ul> For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html\">How Route 53 Determines Whether an Endpoint Is Healthy</a> in the Amazon Route 53 Developer Guide."}]},"ResourcePath":{"allOf":[{"$ref":"#/components/schemas/ResourcePath"},{"description":"The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, <code>/welcome.html?language=jp&login=y</code>. "}]},"FullyQualifiedDomainName":{"allOf":[{"$ref":"#/components/schemas/FullyQualifiedDomainName"},{"description":"Amazon Route 53 behavior depends on whether you specify a value for <code>IPAddress</code>. If you specify a value for <code>IPAddress</code>: Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of <code>FullyQualifiedDomainName</code> in the <code>Host</code> header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks. When Route 53 checks the health of an endpoint, here is how it constructs the <code>Host</code> header: <ul> <li> If you specify a value of <code>80</code> for <code>Port</code> and <code>HTTP</code> or <code>HTTP_STR_MATCH</code> for <code>Type</code>, Route 53 passes the value of <code>FullyQualifiedDomainName</code> to the endpoint in the Host header. </li> <li> If you specify a value of <code>443</code> for <code>Port</code> and <code>HTTPS</code> or <code>HTTPS_STR_MATCH</code> for <code>Type</code>, Route 53 passes the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>Host</code> header. </li> <li> If you specify another value for <code>Port</code> and any value except <code>TCP</code> for <code>Type</code>, Route 53 passes <code>FullyQualifiedDomainName:Port</code> to the endpoint in the <code>Host</code> header. </li> </ul> If you don't specify a value for <code>FullyQualifiedDomainName</code>, Route 53 substitutes the value of <code>IPAddress</code> in the <code>Host</code> header in each of the preceding cases. If you don't specify a value for <code>IPAddress</code>: Route 53 sends a DNS request to the domain that you specify for <code>FullyQualifiedDomainName</code> at the interval that you specify for <code>RequestInterval</code>. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint. <note> If you don't specify a value for <code>IPAddress</code>, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for <code>FullyQualifiedDomainName</code>, the health check fails with a \"DNS resolution failed\" error. </note> If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by <code>FullyQualifiedDomainName</code>, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of <code>FullyQualifiedDomainName</code>, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com). <important> In this configuration, if you create a health check for which the value of <code>FullyQualifiedDomainName</code> matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable. </important> In addition, if the value that you specify for <code>Type</code> is <code>HTTP</code>, <code>HTTPS</code>, <code>HTTP_STR_MATCH</code>, or <code>HTTPS_STR_MATCH</code>, Route 53 passes the value of <code>FullyQualifiedDomainName</code> in the <code>Host</code> header, as it does when you specify a value for <code>IPAddress</code>. If the value of <code>Type</code> is <code>TCP</code>, Route 53 doesn't pass a <code>Host</code> header."}]},"SearchString":{"allOf":[{"$ref":"#/components/schemas/SearchString"},{"description":"If the value of Type is <code>HTTP_STR_MATCH</code> or <code>HTTPS_STR_MATCH</code>, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. Route 53 considers case when searching for <code>SearchString</code> in the response body. "}]},"RequestInterval":{"allOf":[{"$ref":"#/components/schemas/RequestInterval"},{"description":"The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval. <important> You can't change the value of <code>RequestInterval</code> after you create a health check. </important> If you don't specify a value for <code>RequestInterval</code>, the default value is <code>30</code> seconds."}]},"FailureThreshold":{"allOf":[{"$ref":"#/components/schemas/FailureThreshold"},{"description":"The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html\">How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> in the Amazon Route 53 Developer Guide. If you don't specify a value for <code>FailureThreshold</code>, the default value is three health checks."}]},"MeasureLatency":{"allOf":[{"$ref":"#/components/schemas/MeasureLatency"},{"description":"Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console. <important> You can't change the value of <code>MeasureLatency</code> after you create a health check. </important>"}]},"Inverted":{"allOf":[{"$ref":"#/components/schemas/Inverted"},{"description":"Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy."}]},"Disabled":{"allOf":[{"$ref":"#/components/schemas/Disabled"},{"description":"Stops Route 53 from performing health checks. When you disable a health check, here's what happens: <ul> <li> Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource. </li> <li> Calculated health checks: Route 53 stops aggregating the status of the referenced health checks. </li> <li> Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics. </li> </ul> After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-Inverted\">Inverted</a>. Charges for a health check still apply when the health check is disabled. For more information, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>."}]},"HealthThreshold":{"allOf":[{"$ref":"#/components/schemas/HealthThreshold"},{"description":"The number of child health checks that are associated with a <code>CALCULATED</code> health check that Amazon Route 53 must consider healthy for the <code>CALCULATED</code> health check to be considered healthy. To specify the child health checks that you want to associate with a <code>CALCULATED</code> health check, use the <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_UpdateHealthCheck.html#Route53-UpdateHealthCheck-request-ChildHealthChecks\">ChildHealthChecks</a> element. Note the following: <ul> <li> If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy. </li> <li> If you specify <code>0</code>, Route 53 always considers this health check to be healthy. </li> </ul>"}]},"ChildHealthChecks":{"allOf":[{"$ref":"#/components/schemas/ChildHealthCheckList"},{"description":"(CALCULATED Health Checks Only) A complex type that contains one <code>ChildHealthCheck</code> element for each health check that you want to associate with a <code>CALCULATED</code> health check."}]},"EnableSNI":{"allOf":[{"$ref":"#/components/schemas/EnableSNI"},{"description":"Specify whether you want Amazon Route 53 to send the value of <code>FullyQualifiedDomainName</code> to the endpoint in the <code>client_hello</code> message during TLS negotiation. This allows the endpoint to respond to <code>HTTPS</code> health check requests with the applicable SSL/TLS certificate. Some endpoints require that <code>HTTPS</code> requests include the host name in the <code>client_hello</code> message. If you don't enable SNI, the status of the health check will be <code>SSL alert handshake_failure</code>. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in the <code>Common Name</code> field and possibly several more in the <code>Subject Alternative Names</code> field. One of the domain names in the certificate should match the value that you specify for <code>FullyQualifiedDomainName</code>. If the endpoint responds to the <code>client_hello</code> message with a certificate that does not include the domain name that you specified in <code>FullyQualifiedDomainName</code>, a health checker will retry the handshake. In the second attempt, the health checker will omit <code>FullyQualifiedDomainName</code> from the <code>client_hello</code> message."}]},"Regions":{"allOf":[{"$ref":"#/components/schemas/HealthCheckRegionList"},{"description":"A complex type that contains one <code>Region</code> element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint. If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values<