ActivateKeySigningKey

$result = $client->activateKeySigningKey([/* ... */]);
$promise = $client->activateKeySigningKeyAsync([/* ... */]);

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to ACTIVE.

Parameter Syntax

$result = $client->activateKeySigningKey([
    'HostedZoneId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

NoSuchKeySigningKey:

The specified key-signing key (KSK) doesn't exist.

InvalidKeySigningKeyStatus:

The key-signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

InvalidSigningStatus:

Your hosted zone status isn't valid for this operation. In the hosted zone, change the status to enable DNSSEC or disable DNSSEC.

InvalidKMSArn:

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.

InvalidInput:

The input is not valid.

AssociateVPCWithHostedZone

$result = $client->associateVPCWithHostedZone([/* ... */]);
$promise = $client->associateVPCWithHostedZoneAsync([/* ... */]);

Associates an Amazon VPC with a private hosted zone.

Parameter Syntax

$result = $client->associateVPCWithHostedZone([
    'Comment' => '<string>',
    'HostedZoneId' => '<string>', // REQUIRED
    'VPC' => [ // REQUIRED
        'VPCId' => '<string>',
        'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
    ],
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

NotAuthorizedException:

Associating the specified VPC with the specified hosted zone has not been authorized.

InvalidVPCId:

The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

InvalidInput:

The input is not valid.

PublicZoneVPCAssociation:

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't support associating a VPC with a public hosted zone.

ConflictingDomainExists:

The cause of this error depends on the operation that you're performing:

• Create a public hosted zone: Two hosted zones that have the same name or that have a parent/child relationship (example.com and test.example.com) can't have any common name servers. You tried to create a hosted zone that has the same name as an existing hosted zone or that's the parent or child of an existing hosted zone, and you specified a delegation set that shares one or more name servers with the existing hosted zone. For more information, see CreateReusableDelegationSet.

• Create a private hosted zone: A hosted zone with the specified name already exists and is already associated with the Amazon VPC that you specified.

• Associate VPCs with a private hosted zone: The VPC that you specified is already associated with another hosted zone that has the same name.

LimitsExceeded:

This operation can't be completed because the current account has reached the limit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support Center.

PriorRequestNotComplete:

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

Examples

Example 1: To associate a VPC with a hosted zone

The following example associates the VPC with ID vpc-1a2b3c4d with the hosted zone with ID Z3M3LMPEXAMPLE.

$result = $client->associateVPCWithHostedZone([
    'Comment' => '',
    'HostedZoneId' => 'Z3M3LMPEXAMPLE',
    'VPC' => [
        'VPCId' => 'vpc-1a2b3c4d',
        'VPCRegion' => 'us-east-2',
    ],
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => '',
        'Id' => '/change/C3HC6WDB2UANE2',
        'Status' => 'INSYNC',
        'SubmittedAt' => ,
    ],
]

ChangeCidrCollection

$result = $client->changeCidrCollection([/* ... */]);
$promise = $client->changeCidrCollectionAsync([/* ... */]);

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 ChangeCidrCollection to perform the following actions:

• PUT: Create a CIDR block within the specified collection.

• DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.

Parameter Syntax

$result = $client->changeCidrCollection([
    'Changes' => [ // REQUIRED
        [
            'Action' => 'PUT|DELETE_IF_EXISTS', // REQUIRED
            'CidrList' => ['<string>', ...], // REQUIRED
            'LocationName' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'CollectionVersion' => <integer>,
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Id' => '<string>',
]

Result Details

Errors

NoSuchCidrCollectionException:

The CIDR collection you specified, doesn't exist.

CidrCollectionVersionMismatchException:

The CIDR collection version you provided, doesn't match the one in the ListCidrCollections operation.

InvalidInput:

The input is not valid.

CidrBlockInUseException:

This CIDR block is already in use.

LimitsExceeded:

This operation can't be completed because the current account has reached the limit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support Center.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

ChangeResourceRecordSets

$result = $client->changeResourceRecordSets([/* ... */]);
$promise = $client->changeResourceRecordSetsAsync([/* ... */]);

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 ChangeResourceRecordSets 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 ChangeResourceRecordSetsRequest 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 CNAME 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 DELETE or the CREATE action fails, then the request is canceled, and the original CNAME record continues to exist.

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 Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.

Create, Delete, and Upsert

Use ChangeResourceRecordsSetsRequest to perform the following actions:

• CREATE: Creates a resource record set that has the specified values.

• DELETE: Deletes an existing resource record set that has the specified values.

• UPSERT: If a resource set doesn't exist, Route 53 creates it. If a resource set exists Route 53 updates it with the values in the request.

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

Change Propagation to Route 53 DNS Servers

When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers managing the hosted zone within 60 seconds. For more information, see GetChange.

Limits on ChangeResourceRecordSets Requests

For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

Parameter Syntax

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [ // REQUIRED
        'Changes' => [ // REQUIRED
            [
                'Action' => 'CREATE|DELETE|UPSERT', // REQUIRED
                'ResourceRecordSet' => [ // REQUIRED
                    'AliasTarget' => [
                        'DNSName' => '<string>', // REQUIRED
                        'EvaluateTargetHealth' => true || false, // REQUIRED
                        'HostedZoneId' => '<string>', // REQUIRED
                    ],
                    'CidrRoutingConfig' => [
                        'CollectionId' => '<string>', // REQUIRED
                        'LocationName' => '<string>', // REQUIRED
                    ],
                    'Failover' => 'PRIMARY|SECONDARY',
                    'GeoLocation' => [
                        'ContinentCode' => '<string>',
                        'CountryCode' => '<string>',
                        'SubdivisionCode' => '<string>',
                    ],
                    'GeoProximityLocation' => [
                        'AWSRegion' => '<string>',
                        'Bias' => <integer>,
                        'Coordinates' => [
                            'Latitude' => '<string>', // REQUIRED
                            'Longitude' => '<string>', // REQUIRED
                        ],
                        'LocalZoneGroup' => '<string>',
                    ],
                    'HealthCheckId' => '<string>',
                    'MultiValueAnswer' => true || false,
                    'Name' => '<string>', // REQUIRED
                    'Region' => 'us-east-1|us-east-2|us-west-1|us-west-2|ca-central-1|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|cn-north-1|cn-northwest-1|ap-east-1|me-south-1|me-central-1|ap-south-1|ap-south-2|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
                    'ResourceRecords' => [
                        [
                            'Value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'SetIdentifier' => '<string>',
                    'TTL' => <integer>,
                    'TrafficPolicyInstanceId' => '<string>',
                    'Type' => 'SOA|A|TXT|NS|CNAME|MX|NAPTR|PTR|SRV|SPF|AAAA|CAA|DS|TLSA|SSHFP|SVCB|HTTPS', // REQUIRED
                    'Weight' => <integer>,
                ],
            ],
            // ...
        ],
        'Comment' => '<string>',
    ],
    'HostedZoneId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

NoSuchHealthCheck:

No health check exists with the specified ID.

InvalidChangeBatch:

This exception contains a list of messages that might contain one or more error messages. Each error message indicates one error in the change batch.

InvalidInput:

The input is not valid.

PriorRequestNotComplete:

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

Examples

Example 1: To create a basic resource record set

The following example creates a resource record set that routes Internet traffic to a resource with an IP address of 192.0.2.44.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.44',
                        ],
                    ],
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'Web server for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE',
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'Web server for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 2: To create weighted resource record sets

The following example creates two weighted resource record sets. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'HealthCheckId' => 'abcdef11-2222-3333-4444-555555fedcba',
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.44',
                        ],
                    ],
                    'SetIdentifier' => 'Seattle data center',
                    'TTL' => 60,
                    'Type' => 'A',
                    'Weight' => 100,
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'HealthCheckId' => 'abcdef66-7777-8888-9999-000000fedcba',
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.45',
                        ],
                    ],
                    'SetIdentifier' => 'Portland data center',
                    'TTL' => 60,
                    'Type' => 'A',
                    'Weight' => 200,
                ],
            ],
        ],
        'Comment' => 'Web servers for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE',
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'Web servers for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 3: To create an alias resource record set

The following example creates an alias resource record set that routes traffic to a CloudFront distribution.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'd123rk29d0stfj.cloudfront.net',
                        'EvaluateTargetHealth' => ,
                        'HostedZoneId' => 'Z2FDTNDATAQYW2',
                    ],
                    'Name' => 'example.com',
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'CloudFront distribution for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE', // Depends on the type of resource that you want to route traffic to
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'CloudFront distribution for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 4: To create weighted alias resource record sets

The following example creates two weighted alias resource record sets that route traffic to ELB load balancers. The resource with a Weight of 100 will get 1/3rd of traffic (100/100+200), and the other resource will get the rest of the traffic for example.com.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-123456789.us-east-2.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z3AADJGX6KTTL2',
                    ],
                    'Name' => 'example.com',
                    'SetIdentifier' => 'Ohio region',
                    'Type' => 'A',
                    'Weight' => 100,
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-987654321.us-west-2.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z1H1FL5HABSF5',
                    ],
                    'Name' => 'example.com',
                    'SetIdentifier' => 'Oregon region',
                    'Type' => 'A',
                    'Weight' => 200,
                ],
            ],
        ],
        'Comment' => 'ELB load balancers for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE', // Depends on the type of resource that you want to route traffic to
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'ELB load balancers for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 5: To create latency resource record sets

The following example creates two latency resource record sets that route traffic to EC2 instances. Traffic for example.com is routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'HealthCheckId' => 'abcdef11-2222-3333-4444-555555fedcba',
                    'Name' => 'example.com',
                    'Region' => 'us-east-2',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.44',
                        ],
                    ],
                    'SetIdentifier' => 'Ohio region',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'HealthCheckId' => 'abcdef66-7777-8888-9999-000000fedcba',
                    'Name' => 'example.com',
                    'Region' => 'us-west-2',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.45',
                        ],
                    ],
                    'SetIdentifier' => 'Oregon region',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'EC2 instances for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE',
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'EC2 instances for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 6: To create latency alias resource record sets

The following example creates two latency alias resource record sets that route traffic for example.com to ELB load balancers. Requests are routed either to the Ohio region or the Oregon region, depending on the latency between the user and those regions.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-123456789.us-east-2.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z3AADJGX6KTTL2',
                    ],
                    'Name' => 'example.com',
                    'Region' => 'us-east-2',
                    'SetIdentifier' => 'Ohio region',
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-987654321.us-west-2.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z1H1FL5HABSF5',
                    ],
                    'Name' => 'example.com',
                    'Region' => 'us-west-2',
                    'SetIdentifier' => 'Oregon region',
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'ELB load balancers for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE', // Depends on the type of resource that you want to route traffic to
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'ELB load balancers for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 7: To create failover resource record sets

The following example creates primary and secondary failover resource record sets that route traffic to EC2 instances. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'Failover' => 'PRIMARY',
                    'HealthCheckId' => 'abcdef11-2222-3333-4444-555555fedcba',
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.44',
                        ],
                    ],
                    'SetIdentifier' => 'Ohio region',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'Failover' => 'SECONDARY',
                    'HealthCheckId' => 'abcdef66-7777-8888-9999-000000fedcba',
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.45',
                        ],
                    ],
                    'SetIdentifier' => 'Oregon region',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'Failover configuration for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE',
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'Failover configuration for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 8: To create failover alias resource record sets

The following example creates primary and secondary failover alias resource record sets that route traffic to ELB load balancers. Traffic is generally routed to the primary resource, in the Ohio region. If that resource is unavailable, traffic is routed to the secondary resource, in the Oregon region.

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-123456789.us-east-2.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z3AADJGX6KTTL2',
                    ],
                    'Failover' => 'PRIMARY',
                    'Name' => 'example.com',
                    'SetIdentifier' => 'Ohio region',
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-987654321.us-west-2.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z1H1FL5HABSF5',
                    ],
                    'Failover' => 'SECONDARY',
                    'Name' => 'example.com',
                    'SetIdentifier' => 'Oregon region',
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'Failover alias configuration for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE', // Depends on the type of resource that you want to route traffic to
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'Failover alias configuration for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 9: To create geolocation resource record sets

The following example creates four geolocation resource record sets that use IPv4 addresses to route traffic to resources such as web servers running on EC2 instances. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'GeoLocation' => [
                        'ContinentCode' => 'NA',
                    ],
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.44',
                        ],
                    ],
                    'SetIdentifier' => 'North America',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'GeoLocation' => [
                        'ContinentCode' => 'SA',
                    ],
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.45',
                        ],
                    ],
                    'SetIdentifier' => 'South America',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'GeoLocation' => [
                        'ContinentCode' => 'EU',
                    ],
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.46',
                        ],
                    ],
                    'SetIdentifier' => 'Europe',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'GeoLocation' => [
                        'CountryCode' => '*',
                    ],
                    'Name' => 'example.com',
                    'ResourceRecords' => [
                        [
                            'Value' => '192.0.2.47',
                        ],
                    ],
                    'SetIdentifier' => 'Other locations',
                    'TTL' => 60,
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'Geolocation configuration for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE',
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'Geolocation configuration for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

Example 10: To create geolocation alias resource record sets

The following example creates four geolocation alias resource record sets that route traffic to ELB load balancers. Traffic is routed to one of four IP addresses, for North America (NA), for South America (SA), for Europe (EU), and for all other locations (*).

$result = $client->changeResourceRecordSets([
    'ChangeBatch' => [
        'Changes' => [
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-123456789.us-east-2.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z3AADJGX6KTTL2',
                    ],
                    'GeoLocation' => [
                        'ContinentCode' => 'NA',
                    ],
                    'Name' => 'example.com',
                    'SetIdentifier' => 'North America',
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-234567890.sa-east-1.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z2P70J7HTTTPLU',
                    ],
                    'GeoLocation' => [
                        'ContinentCode' => 'SA',
                    ],
                    'Name' => 'example.com',
                    'SetIdentifier' => 'South America',
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-234567890.eu-central-1.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z215JYRZR1TBD5',
                    ],
                    'GeoLocation' => [
                        'ContinentCode' => 'EU',
                    ],
                    'Name' => 'example.com',
                    'SetIdentifier' => 'Europe',
                    'Type' => 'A',
                ],
            ],
            [
                'Action' => 'CREATE',
                'ResourceRecordSet' => [
                    'AliasTarget' => [
                        'DNSName' => 'example-com-234567890.ap-southeast-1.elb.amazonaws.com ',
                        'EvaluateTargetHealth' => 1,
                        'HostedZoneId' => 'Z1LMS91P8CMLE5',
                    ],
                    'GeoLocation' => [
                        'CountryCode' => '*',
                    ],
                    'Name' => 'example.com',
                    'SetIdentifier' => 'Other locations',
                    'Type' => 'A',
                ],
            ],
        ],
        'Comment' => 'Geolocation alias configuration for example.com',
    ],
    'HostedZoneId' => 'Z3M3LMPEXAMPLE', // Depends on the type of resource that you want to route traffic to
]);

Result syntax:

[
    'ChangeInfo' => [
        'Comment' => 'Geolocation alias configuration for example.com',
        'Id' => '/change/C2682N5HXP0BZ4',
        'Status' => 'PENDING',
        'SubmittedAt' => ,
    ],
]

ChangeTagsForResource

$result = $client->changeTagsForResource([/* ... */]);
$promise = $client->changeTagsForResourceAsync([/* ... */]);

Adds, edits, or deletes tags for a health check or a hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.

Parameter Syntax

$result = $client->changeTagsForResource([
    'AddTags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'RemoveTagKeys' => ['<string>', ...],
    'ResourceId' => '<string>', // REQUIRED
    'ResourceType' => 'healthcheck|hostedzone', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInput:

The input is not valid.

NoSuchHealthCheck:

No health check exists with the specified ID.

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

PriorRequestNotComplete:

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

ThrottlingException:

The limit on the number of requests per second was exceeded.

Examples

Example 1: To add or remove tags from a hosted zone or health check

The following example adds two tags and removes one tag from the hosted zone with ID Z3M3LMPEXAMPLE.

$result = $client->changeTagsForResource([
    'AddTags' => [
        [
            'Key' => 'apex',
            'Value' => '3874',
        ],
        [
            'Key' => 'acme',
            'Value' => '4938',
        ],
    ],
    'RemoveTagKeys' => [
        'Nadir',
    ],
    'ResourceId' => 'Z3M3LMPEXAMPLE',
    'ResourceType' => 'hostedzone', // Valid values are healthcheck and hostedzone.
]);

Result syntax:

[
]

CreateCidrCollection

$result = $client->createCidrCollection([/* ... */]);
$promise = $client->createCidrCollectionAsync([/* ... */]);

Creates a CIDR collection in the current Amazon Web Services account.

Parameter Syntax

$result = $client->createCidrCollection([
    'CallerReference' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Collection' => [
        'Arn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'Version' => <integer>,
    ],
    'Location' => '<string>',
]

Result Details

Errors

LimitsExceeded:

This operation can't be completed because the current account has reached the limit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support Center.

InvalidInput:

The input is not valid.

CidrCollectionAlreadyExistsException:

A CIDR collection with this name and a different caller reference already exists in this account.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

CreateHealthCheck

$result = $client->createHealthCheck([/* ... */]);
$promise = $client->createHealthCheckAsync([/* ... */]);

Creates a new health check.

For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

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:

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

• You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.

• 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 StatusCheckFailed 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 Amazon CloudWatch User Guide.

Parameter Syntax

$result = $client->createHealthCheck([
    'CallerReference' => '<string>', // REQUIRED
    'HealthCheckConfig' => [ // REQUIRED
        'AlarmIdentifier' => [
            'Name' => '<string>', // REQUIRED
            'Region' => 'us-east-1|us-east-2|us-west-1|us-west-2|ca-central-1|eu-central-1|eu-central-2|eu-west-1|eu-west-2|eu-west-3|ap-east-1|me-south-1|me-central-1|ap-south-1|ap-south-2|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|cn-northwest-1|cn-north-1|af-south-1|eu-south-1|eu-south-2|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5', // REQUIRED
        ],
        'ChildHealthChecks' => ['<string>', ...],
        'Disabled' => true || false,
        'EnableSNI' => true || false,
        'FailureThreshold' => <integer>,
        'FullyQualifiedDomainName' => '<string>',
        'HealthThreshold' => <integer>,
        'IPAddress' => '<string>',
        'InsufficientDataHealthStatus' => 'Healthy|Unhealthy|LastKnownStatus',
        'Inverted' => true || false,
        'MeasureLatency' => true || false,
        'Port' => <integer>,
        'Regions' => ['<string>', ...],
        'RequestInterval' => <integer>,
        'ResourcePath' => '<string>',
        'RoutingControlArn' => '<string>',
        'SearchString' => '<string>',
        'Type' => 'HTTP|HTTPS|HTTP_STR_MATCH|HTTPS_STR_MATCH|TCP|CALCULATED|CLOUDWATCH_METRIC|RECOVERY_CONTROL', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'HealthCheck' => [
        'CallerReference' => '<string>',
        'CloudWatchAlarmConfiguration' => [
            'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
            'Dimensions' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'EvaluationPeriods' => <integer>,
            'MetricName' => '<string>',
            'Namespace' => '<string>',
            'Period' => <integer>,
            'Statistic' => 'Average|Sum|SampleCount|Maximum|Minimum',
            'Threshold' => <float>,
        ],
        'HealthCheckConfig' => [
            'AlarmIdentifier' => [
                'Name' => '<string>',
                'Region' => 'us-east-1|us-east-2|us-west-1|us-west-2|ca-central-1|eu-central-1|eu-central-2|eu-west-1|eu-west-2|eu-west-3|ap-east-1|me-south-1|me-central-1|ap-south-1|ap-south-2|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|cn-northwest-1|cn-north-1|af-south-1|eu-south-1|eu-south-2|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
            ],
            'ChildHealthChecks' => ['<string>', ...],
            'Disabled' => true || false,
            'EnableSNI' => true || false,
            'FailureThreshold' => <integer>,
            'FullyQualifiedDomainName' => '<string>',
            'HealthThreshold' => <integer>,
            'IPAddress' => '<string>',
            'InsufficientDataHealthStatus' => 'Healthy|Unhealthy|LastKnownStatus',
            'Inverted' => true || false,
            'MeasureLatency' => true || false,
            'Port' => <integer>,
            'Regions' => ['<string>', ...],
            'RequestInterval' => <integer>,
            'ResourcePath' => '<string>',
            'RoutingControlArn' => '<string>',
            'SearchString' => '<string>',
            'Type' => 'HTTP|HTTPS|HTTP_STR_MATCH|HTTPS_STR_MATCH|TCP|CALCULATED|CLOUDWATCH_METRIC|RECOVERY_CONTROL',
        ],
        'HealthCheckVersion' => <integer>,
        'Id' => '<string>',
        'LinkedService' => [
            'Description' => '<string>',
            'ServicePrincipal' => '<string>',
        ],
    ],
    'Location' => '<string>',
]

Result Details

Errors

TooManyHealthChecks:

This health check can't be created because the current account has reached the limit on the number of active health checks.

For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support Center.

You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support Center.

HealthCheckAlreadyExists:

The health check you're attempting to create already exists. Amazon Route 53 returns this error when you submit a request that has the following values:

• The same value for CallerReference as an existing health check, and one or more values that differ from the existing health check that has the same caller reference.

• The same value for CallerReference as a health check that you created and later deleted, regardless of the other settings in the request.

InvalidInput:

The input is not valid.

CreateHostedZone

$result = $client->createHostedZone([/* ... */]);
$promise = $client->createHostedZoneAsync([/* ... */]);

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

For more information about charges for hosted zones, see Amazon Route 53 Pricing.

Note the following:

• You can't create a hosted zone for a top-level domain (TLD) such as .com.

• 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 NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

  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 DelegationSetId element.

• 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 Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. 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 INSYNC.

The CreateHostedZone request requires the caller to have an ec2:DescribeVpcs permission.

Parameter Syntax

$result = $client->createHostedZone([
    'CallerReference' => '<string>', // REQUIRED
    'DelegationSetId' => '<string>',
    'HostedZoneConfig' => [
        'Comment' => '<string>',
        'PrivateZone' => true || false,
    ],
    'Name' => '<string>', // REQUIRED
    'VPC' => [
        'VPCId' => '<string>',
        'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
    ],
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
    'DelegationSet' => [
        'CallerReference' => '<string>',
        'Id' => '<string>',
        'NameServers' => ['<string>', ...],
    ],
    'HostedZone' => [
        'CallerReference' => '<string>',
        'Config' => [
            'Comment' => '<string>',
            'PrivateZone' => true || false,
        ],
        'Id' => '<string>',
        'LinkedService' => [
            'Description' => '<string>',
            'ServicePrincipal' => '<string>',
        ],
        'Name' => '<string>',
        'ResourceRecordSetCount' => <integer>,
    ],
    'Location' => '<string>',
    'VPC' => [
        'VPCId' => '<string>',
        'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
    ],
]

Result Details

Errors

InvalidDomainName:

The specified domain name is not valid.

HostedZoneAlreadyExists:

The hosted zone you're trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.

TooManyHostedZones:

This operation can't be completed either because the current account has reached the limit on the number of hosted zones or because you've reached the limit on the number of hosted zones that can be associated with a reusable delegation set.

For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.

To get the current limit on hosted zones that can be associated with a reusable delegation set, see GetReusableDelegationSetLimit.

To request a higher limit, create a case with the Amazon Web Services Support Center.

InvalidVPCId:

The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

InvalidInput:

The input is not valid.

DelegationSetNotAvailable:

You can create a hosted zone that has the same name as an existing hosted zone (example.com is common), but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon Route 53 has reached that limit. If you own the domain name and Route 53 generates this error, contact Customer Support.

ConflictingDomainExists:

The cause of this error depends on the operation that you're performing:

• Create a public hosted zone: Two hosted zones that have the same name or that have a parent/child relationship (example.com and test.example.com) can't have any common name servers. You tried to create a hosted zone that has the same name as an existing hosted zone or that's the parent or child of an existing hosted zone, and you specified a delegation set that shares one or more name servers with the existing hosted zone. For more information, see CreateReusableDelegationSet.

• Create a private hosted zone: A hosted zone with the specified name already exists and is already associated with the Amazon VPC that you specified.

• Associate VPCs with a private hosted zone: The VPC that you specified is already associated with another hosted zone that has the same name.

NoSuchDelegationSet:

A reusable delegation set with the specified ID does not exist.

DelegationSetNotReusable:

A reusable delegation set with the specified ID does not exist.

CreateKeySigningKey

$result = $client->createKeySigningKey([/* ... */]);
$promise = $client->createKeySigningKeyAsync([/* ... */]);

Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.

Parameter Syntax

$result = $client->createKeySigningKey([
    'CallerReference' => '<string>', // REQUIRED
    'HostedZoneId' => '<string>', // REQUIRED
    'KeyManagementServiceArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Status' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
    'KeySigningKey' => [
        'CreatedDate' => <DateTime>,
        'DNSKEYRecord' => '<string>',
        'DSRecord' => '<string>',
        'DigestAlgorithmMnemonic' => '<string>',
        'DigestAlgorithmType' => <integer>,
        'DigestValue' => '<string>',
        'Flag' => <integer>,
        'KeyTag' => <integer>,
        'KmsArn' => '<string>',
        'LastModifiedDate' => <DateTime>,
        'Name' => '<string>',
        'PublicKey' => '<string>',
        'SigningAlgorithmMnemonic' => '<string>',
        'SigningAlgorithmType' => <integer>,
        'Status' => '<string>',
        'StatusMessage' => '<string>',
    ],
    'Location' => '<string>',
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidArgument:

Parameter name is not valid.

InvalidInput:

The input is not valid.

InvalidKMSArn:

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.

InvalidKeySigningKeyStatus:

The key-signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

InvalidSigningStatus:

Your hosted zone status isn't valid for this operation. In the hosted zone, change the status to enable DNSSEC or disable DNSSEC.

InvalidKeySigningKeyName:

The key-signing key (KSK) name that you specified isn't a valid name.

KeySigningKeyAlreadyExists:

You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.

TooManyKeySigningKeys:

You've reached the limit for the number of key-signing keys (KSKs). Remove at least one KSK, and then try again.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

CreateQueryLoggingConfig

$result = $client->createQueryLoggingConfig([/* ... */]);
$promise = $client->createQueryLoggingConfigAsync([/* ... */]);

Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

• Route 53 edge location that responded to the DNS query

• Domain or subdomain that was requested

• DNS record type, such as A or AAAA

• DNS response code, such as NoError or ServFail

Log Group and Resource Policy

Before you create a query logging configuration, perform the following operations.

If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:

   • You must create the log group in the us-east-1 region.

   • You must use the same Amazon Web Services account to create the log group and the hosted zone that you want to configure query logging for.

   • When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

     /aws/route53/hosted zone name

     In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated Amazon Web Services resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.

2. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. You must create the CloudWatch Logs resource policy in the us-east-1 region. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:

   arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*

   To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values:

   • For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID.

   • For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111.

   For more information, see The confused deputy problem in the Amazon Web Services IAM User Guide.

   You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the Amazon Web Services SDKs, or the CLI.

Log Streams and Edge Locations

When Route 53 finishes creating the configuration for DNS query logging, it does the following:

• Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.

• Begins to send query logs to the applicable log stream.

The name of each log stream is in the following format:

hosted zone ID/edge location code

The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see "The Route 53 Global Network" on the Route 53 Product Details page.

Queries That Are Logged

Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.

Log File Format

For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.

Pricing

For information about charges for query logs, see Amazon CloudWatch Pricing.

How to Stop Logging

If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.

Parameter Syntax

$result = $client->createQueryLoggingConfig([
    'CloudWatchLogsLogGroupArn' => '<string>', // REQUIRED
    'HostedZoneId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Location' => '<string>',
    'QueryLoggingConfig' => [
        'CloudWatchLogsLogGroupArn' => '<string>',
        'HostedZoneId' => '<string>',
        'Id' => '<string>',
    ],
]

Result Details

Errors

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

NoSuchCloudWatchLogsLogGroup:

There is no CloudWatch Logs log group with the specified ARN.

InvalidInput:

The input is not valid.

QueryLoggingConfigAlreadyExists:

You can create only one query logging configuration for a hosted zone, and a query logging configuration already exists for this hosted zone.

InsufficientCloudWatchLogsResourcePolicy:

Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes include the following:

• There is no resource policy that specifies the log group ARN in the value for Resource.

• The resource policy that includes the log group ARN in the value for Resource doesn't have the necessary permissions.

• The resource policy hasn't finished propagating yet.

• The Key management service (KMS) key you specified doesn’t exist or it can’t be used with the log group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.

• The Key management service (KMS) key you specified is marked as disabled for the log group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.

CreateReusableDelegationSet

$result = $client->createReusableDelegationSet([/* ... */]);
$promise = $client->createReusableDelegationSetAsync([/* ... */]);

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones that were created by the same Amazon Web Services account.

You can also create a reusable delegation set that uses the four name servers that are associated with an existing hosted zone. Specify the hosted zone ID in the CreateReusableDelegationSet request.

For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.

The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:

1. Create a reusable delegation set.

2. Recreate hosted zones, and reduce the TTL to 60 seconds or less.

3. Recreate resource record sets in the new hosted zones.

4. Change the registrar's name servers to use the name servers for the new hosted zones.

5. Monitor traffic for the website or application.

6. Change TTLs back to their original values.

If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:

• For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.

• For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.

• For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.

Parameter Syntax

$result = $client->createReusableDelegationSet([
    'CallerReference' => '<string>', // REQUIRED
    'HostedZoneId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DelegationSet' => [
        'CallerReference' => '<string>',
        'Id' => '<string>',
        'NameServers' => ['<string>', ...],
    ],
    'Location' => '<string>',
]

Result Details

Errors

DelegationSetAlreadyCreated:

A delegation set with the same owner and caller reference combination has already been created.

LimitsExceeded:

This operation can't be completed because the current account has reached the limit on the resource you are trying to create. To request a higher limit, create a case with the Amazon Web Services Support Center.

HostedZoneNotFound:

The specified HostedZone can't be found.

InvalidArgument:

Parameter name is not valid.

InvalidInput:

The input is not valid.

DelegationSetNotAvailable:

You can create a hosted zone that has the same name as an existing hosted zone (example.com is common), but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon Route 53 has reached that limit. If you own the domain name and Route 53 generates this error, contact Customer Support.

DelegationSetAlreadyReusable:

The specified delegation set has already been marked as reusable.

CreateTrafficPolicy

$result = $client->createTrafficPolicy([/* ... */]);
$promise = $client->createTrafficPolicyAsync([/* ... */]);

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

Parameter Syntax

$result = $client->createTrafficPolicy([
    'Comment' => '<string>',
    'Document' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Location' => '<string>',
    'TrafficPolicy' => [
        'Comment' => '<string>',
        'Document' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'Type' => 'SOA|A|TXT|NS|CNAME|MX|NAPTR|PTR|SRV|SPF|AAAA|CAA|DS|TLSA|SSHFP|SVCB|HTTPS',
        'Version' => <integer>,
    ],
]

Result Details

Errors

InvalidInput:

The input is not valid.

TooManyTrafficPolicies:

This traffic policy can't be created because the current account has reached the limit on the number of traffic policies.

For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

To get the current limit for an account, see GetAccountLimit.

To request a higher limit, create a case with the Amazon Web Services Support Center.

TrafficPolicyAlreadyExists:

A traffic policy that has the same value for Name already exists.

InvalidTrafficPolicyDocument:

The format of the traffic policy document that you specified in the Document element is not valid.

CreateTrafficPolicyInstance

$result = $client->createTrafficPolicyInstance([/* ... */]);
$promise = $client->createTrafficPolicyInstanceAsync([/* ... */]);

Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

Parameter Syntax

$result = $client->createTrafficPolicyInstance([
    'HostedZoneId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'TTL' => <integer>, // REQUIRED
    'TrafficPolicyId' => '<string>', // REQUIRED
    'TrafficPolicyVersion' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Location' => '<string>',
    'TrafficPolicyInstance' => [
        'HostedZoneId' => '<string>',
        'Id' => '<string>',
        'Message' => '<string>',
        'Name' => '<string>',
        'State' => '<string>',
        'TTL' => <integer>,
        'TrafficPolicyId' => '<string>',
        'TrafficPolicyType' => 'SOA|A|TXT|NS|CNAME|MX|NAPTR|PTR|SRV|SPF|AAAA|CAA|DS|TLSA|SSHFP|SVCB|HTTPS',
        'TrafficPolicyVersion' => <integer>,
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidInput:

The input is not valid.

TooManyTrafficPolicyInstances:

This traffic policy instance can't be created because the current account has reached the limit on the number of traffic policy instances.

For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

For information about how to get the current limit for an account, see GetAccountLimit.

To request a higher limit, create a case with the Amazon Web Services Support Center.

NoSuchTrafficPolicy:

No traffic policy exists with the specified ID.

TrafficPolicyInstanceAlreadyExists:

There is already a traffic policy instance with the specified ID.

CreateTrafficPolicyVersion

$result = $client->createTrafficPolicyVersion([/* ... */]);
$promise = $client->createTrafficPolicyVersionAsync([/* ... */]);

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

Parameter Syntax

$result = $client->createTrafficPolicyVersion([
    'Comment' => '<string>',
    'Document' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Location' => '<string>',
    'TrafficPolicy' => [
        'Comment' => '<string>',
        'Document' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'Type' => 'SOA|A|TXT|NS|CNAME|MX|NAPTR|PTR|SRV|SPF|AAAA|CAA|DS|TLSA|SSHFP|SVCB|HTTPS',
        'Version' => <integer>,
    ],
]

Result Details

Errors

NoSuchTrafficPolicy:

No traffic policy exists with the specified ID.

InvalidInput:

The input is not valid.

TooManyTrafficPolicyVersionsForCurrentPolicy:

This traffic policy version can't be created because you've reached the limit of 1000 on the number of versions that you can create for the current traffic policy.

To create more traffic policy versions, you can use GetTrafficPolicy to get the traffic policy document for a specified traffic policy version, and then use CreateTrafficPolicy to create a new traffic policy using the traffic policy document.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

InvalidTrafficPolicyDocument:

The format of the traffic policy document that you specified in the Document element is not valid.

CreateVPCAssociationAuthorization

$result = $client->createVPCAssociationAuthorization([/* ... */]);
$promise = $client->createVPCAssociationAuthorizationAsync([/* ... */]);

Authorizes the Amazon Web Services account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

Parameter Syntax

$result = $client->createVPCAssociationAuthorization([
    'HostedZoneId' => '<string>', // REQUIRED
    'VPC' => [ // REQUIRED
        'VPCId' => '<string>',
        'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
    ],
]);

Parameter Details

Result Syntax

[
    'HostedZoneId' => '<string>',
    'VPC' => [
        'VPCId' => '<string>',
        'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
    ],
]

Result Details

Errors

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

TooManyVPCAssociationAuthorizations:

You've created the maximum number of authorizations that can be created for the specified hosted zone. To authorize another VPC to be associated with the hosted zone, submit a DeleteVPCAssociationAuthorization request to remove an existing authorization. To get a list of existing authorizations, submit a ListVPCAssociationAuthorizations request.

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidVPCId:

The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

InvalidInput:

The input is not valid.

DeactivateKeySigningKey

$result = $client->deactivateKeySigningKey([/* ... */]);
$promise = $client->deactivateKeySigningKeyAsync([/* ... */]);

Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC. This operation changes the KSK status to INACTIVE.

Parameter Syntax

$result = $client->deactivateKeySigningKey([
    'HostedZoneId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

NoSuchKeySigningKey:

The specified key-signing key (KSK) doesn't exist.

InvalidKeySigningKeyStatus:

The key-signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

InvalidSigningStatus:

Your hosted zone status isn't valid for this operation. In the hosted zone, change the status to enable DNSSEC or disable DNSSEC.

KeySigningKeyInUse:

The key-signing key (KSK) that you specified can't be deactivated because it's the only KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable another KSK.

KeySigningKeyInParentDSRecord:

The key-signing key (KSK) is specified in a parent DS record.

InvalidInput:

The input is not valid.

DeleteCidrCollection

$result = $client->deleteCidrCollection([/* ... */]);
$promise = $client->deleteCidrCollectionAsync([/* ... */]);

Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.

Parameter Syntax

$result = $client->deleteCidrCollection([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NoSuchCidrCollectionException:

The CIDR collection you specified, doesn't exist.

CidrCollectionInUseException:

This CIDR collection is in use, and isn't empty.

InvalidInput:

The input is not valid.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

DeleteHealthCheck

$result = $client->deleteHealthCheck([/* ... */]);
$promise = $client->deleteHealthCheckAsync([/* ... */]);

Deletes a health check.

If you're using Cloud Map and you configured Cloud Map to create a Route 53 health check when you register an instance, you can't use the Route 53 DeleteHealthCheck command to delete the health check. The health check is deleted automatically when you deregister the instance; there can be a delay of several hours before the health check is deleted from Route 53.

Parameter Syntax

$result = $client->deleteHealthCheck([
    'HealthCheckId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NoSuchHealthCheck:

No health check exists with the specified ID.

HealthCheckInUse:

This error code is not in use.

InvalidInput:

The input is not valid.

DeleteHostedZone

$result = $client->deleteHostedZone([/* ... */]);
$promise = $client->deleteHostedZoneAsync([/* ... */]);

Deletes a hosted zone.

If the hosted zone was created by another service, such as Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.)

If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.

If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on "free DNS service."

You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.

To verify that the hosted zone has been deleted, do one of the following:

• Use the GetHostedZone action to request information about the hosted zone.

• Use the ListHostedZones action to get a list of the hosted zones associated with the current Amazon Web Services account.

Parameter Syntax

$result = $client->deleteHostedZone([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

HostedZoneNotEmpty:

The hosted zone contains resource records that are not SOA or NS records.

PriorRequestNotComplete:

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

InvalidInput:

The input is not valid.

InvalidDomainName:

The specified domain name is not valid.

DeleteKeySigningKey

$result = $client->deleteKeySigningKey([/* ... */]);
$promise = $client->deleteKeySigningKeyAsync([/* ... */]);

Deletes a key-signing key (KSK). Before you can delete a KSK, you must deactivate it. The KSK must be deactivated before you can delete it regardless of whether the hosted zone is enabled for DNSSEC signing.

You can use DeactivateKeySigningKey to deactivate the key before you delete it.

Use GetDNSSEC to verify that the KSK is in an INACTIVE status.

Parameter Syntax

$result = $client->deleteKeySigningKey([
    'HostedZoneId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

NoSuchKeySigningKey:

The specified key-signing key (KSK) doesn't exist.

InvalidKeySigningKeyStatus:

The key-signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

InvalidSigningStatus:

Your hosted zone status isn't valid for this operation. In the hosted zone, change the status to enable DNSSEC or disable DNSSEC.

InvalidKMSArn:

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.

InvalidInput:

The input is not valid.

DeleteQueryLoggingConfig

$result = $client->deleteQueryLoggingConfig([/* ... */]);
$promise = $client->deleteQueryLoggingConfigAsync([/* ... */]);

Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.

For more information about DNS query logs, see CreateQueryLoggingConfig.

Parameter Syntax

$result = $client->deleteQueryLoggingConfig([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

NoSuchQueryLoggingConfig:

There is no DNS query logging configuration with the specified ID.

InvalidInput:

The input is not valid.

DeleteReusableDelegationSet

$result = $client->deleteReusableDelegationSet([/* ... */]);
$promise = $client->deleteReusableDelegationSetAsync([/* ... */]);

Deletes a reusable delegation set.

To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.

Parameter Syntax

$result = $client->deleteReusableDelegationSet([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NoSuchDelegationSet:

A reusable delegation set with the specified ID does not exist.

DelegationSetInUse:

The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.

DelegationSetNotReusable:

A reusable delegation set with the specified ID does not exist.

InvalidInput:

The input is not valid.

DeleteTrafficPolicy

$result = $client->deleteTrafficPolicy([/* ... */]);
$promise = $client->deleteTrafficPolicyAsync([/* ... */]);

Deletes a traffic policy.

When you delete a traffic policy, Route 53 sets a flag on the policy to indicate that it has been deleted. However, Route 53 never fully deletes the traffic policy. Note the following:

• Deleted traffic policies aren't listed if you run ListTrafficPolicies.

• There's no way to get a list of deleted policies.

• If you retain the ID of the policy, you can get information about the policy, including the traffic policy document, by running GetTrafficPolicy.

Parameter Syntax

$result = $client->deleteTrafficPolicy([
    'Id' => '<string>', // REQUIRED
    'Version' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NoSuchTrafficPolicy:

No traffic policy exists with the specified ID.

InvalidInput:

The input is not valid.

TrafficPolicyInUse:

One or more traffic policy instances were created by using the specified traffic policy.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

DeleteTrafficPolicyInstance

$result = $client->deleteTrafficPolicyInstance([/* ... */]);
$promise = $client->deleteTrafficPolicyInstanceAsync([/* ... */]);

Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

Parameter Syntax

$result = $client->deleteTrafficPolicyInstance([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NoSuchTrafficPolicyInstance:

No traffic policy instance exists with the specified ID.

InvalidInput:

The input is not valid.

PriorRequestNotComplete:

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

DeleteVPCAssociationAuthorization

$result = $client->deleteVPCAssociationAuthorization([/* ... */]);
$promise = $client->deleteVPCAssociationAuthorizationAsync([/* ... */]);

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.

Parameter Syntax

$result = $client->deleteVPCAssociationAuthorization([
    'HostedZoneId' => '<string>', // REQUIRED
    'VPC' => [ // REQUIRED
        'VPCId' => '<string>',
        'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

VPCAssociationAuthorizationNotFound:

The VPC that you specified is not authorized to be associated with the hosted zone.

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidVPCId:

The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

InvalidInput:

The input is not valid.

DisableHostedZoneDNSSEC

$result = $client->disableHostedZoneDNSSEC([/* ... */]);
$promise = $client->disableHostedZoneDNSSECAsync([/* ... */]);

Disables DNSSEC signing in a specific hosted zone. This action does not deactivate any key-signing keys (KSKs) that are active in the hosted zone.

Parameter Syntax

$result = $client->disableHostedZoneDNSSEC([
    'HostedZoneId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidArgument:

Parameter name is not valid.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

KeySigningKeyInParentDSRecord:

The key-signing key (KSK) is specified in a parent DS record.

DNSSECNotFound:

The hosted zone doesn't have any DNSSEC resources.

InvalidKeySigningKeyStatus:

The key-signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

InvalidKMSArn:

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.

InvalidInput:

The input is not valid.

DisassociateVPCFromHostedZone

$result = $client->disassociateVPCFromHostedZone([/* ... */]);
$promise = $client->disassociateVPCFromHostedZoneAsync([/* ... */]);

Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone. Note the following:

• You can't disassociate the last Amazon VPC from a private hosted zone.

• You can't convert a private hosted zone into a public hosted zone.

• You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the Amazon VPC.

• Some services, such as Cloud Map and Amazon Elastic File System (Amazon EFS) automatically create hosted zones and associate VPCs with the hosted zones. A service can create a hosted zone using your account or using its own account. You can disassociate a VPC from a hosted zone only if the service created the hosted zone using your account.

  When you run DisassociateVPCFromHostedZone, if the hosted zone has a value for OwningAccount, you can use DisassociateVPCFromHostedZone. If the hosted zone has a value for OwningService, you can't use DisassociateVPCFromHostedZone.

Parameter Syntax

$result = $client->disassociateVPCFromHostedZone([
    'Comment' => '<string>',
    'HostedZoneId' => '<string>', // REQUIRED
    'VPC' => [ // REQUIRED
        'VPCId' => '<string>',
        'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
    ],
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidVPCId:

The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

VPCAssociationNotFound:

The specified VPC and hosted zone are not currently associated.

LastVPCAssociation:

The VPC that you're trying to disassociate from the private hosted zone is the last VPC that is associated with the hosted zone. Amazon Route 53 doesn't support disassociating the last VPC from a hosted zone.

InvalidInput:

The input is not valid.

EnableHostedZoneDNSSEC

$result = $client->enableHostedZoneDNSSEC([/* ... */]);
$promise = $client->enableHostedZoneDNSSECAsync([/* ... */]);

Enables DNSSEC signing in a specific hosted zone.

Parameter Syntax

$result = $client->enableHostedZoneDNSSEC([
    'HostedZoneId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidArgument:

Parameter name is not valid.

ConcurrentModification:

Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

KeySigningKeyWithActiveStatusNotFound:

A key-signing key (KSK) with ACTIVE status wasn't found.

InvalidKMSArn:

The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.

HostedZonePartiallyDelegated:

The hosted zone nameservers don't match the parent nameservers. The hosted zone and parent must have the same nameservers.

DNSSECNotFound:

The hosted zone doesn't have any DNSSEC resources.

InvalidKeySigningKeyStatus:

The key-signing key (KSK) status isn't valid or another KSK has the status INTERNAL_FAILURE.

InvalidInput:

The input is not valid.

GetAccountLimit

$result = $client->getAccountLimit([/* ... */]);
$promise = $client->getAccountLimitAsync([/* ... */]);

Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.

For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

Parameter Syntax

$result = $client->getAccountLimit([
    'Type' => 'MAX_HEALTH_CHECKS_BY_OWNER|MAX_HOSTED_ZONES_BY_OWNER|MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER|MAX_REUSABLE_DELEGATION_SETS_BY_OWNER|MAX_TRAFFIC_POLICIES_BY_OWNER', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Count' => <integer>,
    'Limit' => [
        'Type' => 'MAX_HEALTH_CHECKS_BY_OWNER|MAX_HOSTED_ZONES_BY_OWNER|MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER|MAX_REUSABLE_DELEGATION_SETS_BY_OWNER|MAX_TRAFFIC_POLICIES_BY_OWNER',
        'Value' => <integer>,
    ],
]

Result Details

Errors

InvalidInput:

The input is not valid.

GetChange

$result = $client->getChange([/* ... */]);
$promise = $client->getChangeAsync([/* ... */]);

Returns the current status of a change batch request. The status is one of the following values:

• PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers managing the hosted zone. This is the initial status of all change batch requests.

• INSYNC indicates that the changes have propagated to all Route 53 DNS servers managing the hosted zone.

Parameter Syntax

$result = $client->getChange([
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChangeInfo' => [
        'Comment' => '<string>',
        'Id' => '<string>',
        'Status' => 'PENDING|INSYNC',
        'SubmittedAt' => <DateTime>,
    ],
]

Result Details

Errors

NoSuchChange:

A change with the specified change ID does not exist.

InvalidInput:

The input is not valid.

GetCheckerIpRanges

$result = $client->getCheckerIpRanges([/* ... */]);
$promise = $client->getCheckerIpRangesAsync([/* ... */]);

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

Parameter Syntax

$result = $client->getCheckerIpRanges([
]);

Parameter Details

Result Syntax

[
    'CheckerIpRanges' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

GetDNSSEC

$result = $client->getDNSSEC([/* ... */]);
$promise = $client->getDNSSECAsync([/* ... */]);

Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.

Parameter Syntax

$result = $client->getDNSSEC([
    'HostedZoneId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'KeySigningKeys' => [
        [
            'CreatedDate' => <DateTime>,
            'DNSKEYRecord' => '<string>',
            'DSRecord' => '<string>',
            'DigestAlgorithmMnemonic' => '<string>',
            'DigestAlgorithmType' => <integer>,
            'DigestValue' => '<string>',
            'Flag' => <integer>,
            'KeyTag' => <integer>,
            'KmsArn' => '<string>',
            'LastModifiedDate' => <DateTime>,
            'Name' => '<string>',
            'PublicKey' => '<string>',
            'SigningAlgorithmMnemonic' => '<string>',
            'SigningAlgorithmType' => <integer>,
            'Status' => '<string>',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'Status' => [
        'ServeSignature' => '<string>',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Errors

NoSuchHostedZone:

No hosted zone exists with the ID that you specified.

InvalidArgument:

Parameter name is not valid.

InvalidInput:

The input is not valid.

GetGeoLocation

$result = $client->getGeoLocation([/* ... */]);
$promise = $client->getGeoLocationAsync([/* ... */]);

Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.

Use the following syntax to determine whether a continent is supported for geolocation:

GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent

Use the following syntax to determine whether a country is supported for geolocation:

GET /2013-04-01/geolocation?countrycode=two-character country code

Use the following syntax to determine whether a subdivision of a country is supported for geolocation:

GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code

Parameter Syntax

$result = $client->getGeoLocation([
    'ContinentCode' => '<string>',
    'CountryCode' => '<string>',
    'SubdivisionCode' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GeoLocationDetails' => [
        'ContinentCode' => '<string>',
        'ContinentName' => '<string>',
        'CountryCode' => '<string>',
        'CountryName' => '<string>',
        'SubdivisionCode' => '<string>',
        'SubdivisionName' => '<string>',
    ],
]

Result Details

Errors

NoSuchGeoLocation:

Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the GeoLocation data type.

InvalidInput:

The input is not valid.

GetHealthCheck

$result = $client->getHealthCheck([/* ... */]);
$promise = $client->getHealthCheckAsync([/* ... */]);

Gets information about a specified health check.

Parameter Syntax

$result = $client->getHealthCheck([
    'HealthCheckId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HealthCheck' => [
        'CallerReference' => '<string>',
        'CloudWatchAlarmConfiguration' => [
            'ComparisonOperator' => 'GreaterThanOrEqualToThreshold|GreaterThanThreshold|LessThanThreshold|LessThanOrEqualToThreshold',
            'Dimensions' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'EvaluationPeriods' => <integer>,
            'MetricName' => '<string>',
            'Namespace' => '<string>',
            'Period' => <integer>,
            'Statistic' => 'Average|Sum|SampleCount|Maximum|Minimum',
            'Threshold' => <float>,
        ],
        'HealthCheckConfig' => [
            'AlarmIdentifier' => [
                'Name' => '<string>',
                'Region' => 'us-east-1|us-east-2|us-west-1|us-west-2|ca-central-1|eu-central-1|eu-central-2|eu-west-1|eu-west-2|eu-west-3|ap-east-1|me-south-1|me-central-1|ap-south-1|ap-south-2|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|cn-northwest-1|cn-north-1|af-south-1|eu-south-1|eu-south-2|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
            ],
            'ChildHealthChecks' => ['<string>', ...],
            'Disabled' => true || false,
            'EnableSNI' => true || false,
            'FailureThreshold' => <integer>,
            'FullyQualifiedDomainName' => '<string>',
            'HealthThreshold' => <integer>,
            'IPAddress' => '<string>',
            'InsufficientDataHealthStatus' => 'Healthy|Unhealthy|LastKnownStatus',
            'Inverted' => true || false,
            'MeasureLatency' => true || false,
            'Port' => <integer>,
            'Regions' => ['<string>', ...],
            'RequestInterval' => <integer>,
            'ResourcePath' => '<string>',
            'RoutingControlArn' => '<string>',
            'SearchString' => '<string>',
            'Type' => 'HTTP|HTTPS|HTTP_STR_MATCH|HTTPS_STR_MATCH|TCP|CALCULATED|CLOUDWATCH_METRIC|RECOVERY_CONTROL',
        ],
        'HealthCheckVersion' => <integer>,
        'Id' => '<string>',
        'LinkedService' => [
            'Description' => '<string>',
            'ServicePrincipal' => '<string>',
        ],
    ],
]

Result Details

Errors

NoSuchHealthCheck:

No health check exists with the specified ID.

InvalidInput:

The input is not valid.

IncompatibleVersion:

The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.

GetHealthCheckCount

$result = $client->getHealthCheckCount([/* ... */]);
$promise = $client->getHealthCheckCountAsync([/* ... */]);

Retrieves the number of health checks that are associated with the current Amazon Web Services account.

Parameter Syntax

$result = $client->getHealthCheckCount([
]);

Parameter Details

Result Syntax

[
    'HealthCheckCount' => <integer>,
]

Result Details

Errors

There are no errors described for this operation.

GetHealthCheckLastFailureReason

$result = $client->getHealthCheckLastFailureReason([/* ... */]);
$promise = $client->getHealthCheckLastFailureReasonAsync([/* ... */]);

Gets the reason that a specified health check failed most recently.

Parameter Syntax

$result = $client->getHealthCheckLastFailureReason([
    'HealthCheckId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HealthCheckObservations' => [
        [
            'IPAddress' => '<string>',
            'Region' => 'us-east-1|us-west-1|us-west-2|eu-west-1|ap-southeast-1|ap-southeast-2|ap-northeast-1|sa-east-1',
            'StatusReport' => [
                'CheckedTime' => <DateTime>,
                'Status' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

NoSuchHealthCheck:

No health check exists with the specified ID.

InvalidInput:

The input is not valid.

GetHealthCheckStatus

$result = $client->getHealthCheckStatus([/* ... */]);
$promise = $client->getHealthCheckStatusAsync([/* ... */]);

Gets status of a specified health check.

Parameter Syntax

$result = $client->getHealthCheckStatus([
    'HealthCheckId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'HealthCheckObservations' => [
        [
            'IPAddress' => '<string>',
            'Region' => 'us-east-1|us-west-1|us-west-2|eu-west-1|ap-southeast-1|ap-southeast-2|ap-northeast-1|sa-east-1',
            'StatusReport' => [
                'CheckedTime' => <DateTime>,
                'Status' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

NoSuchHealthCheck:

No health check exists with the specified ID.

InvalidInput:

The input is not valid.

GetHostedZone

$result = $client->getHostedZone([/* ... */]);
$promise = $client->getHostedZoneAsync([/* ... */]);

Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

returns the VPCs associated with the specified hosted zone and does not reflect the VPC associations by Route 53 Profiles. To get the associations to a Profile, call the ListProfileAssociations API.

$result = $client->getHostedZone([
    'Id' => '<string>', // REQUIRED
]);

[
    'DelegationSet' => [
        'CallerReference' => '<string>',
        'Id' => '<string>',
        'NameServers' => ['<string>', ...],
    ],
    'HostedZone' => [
        'CallerReference' => '<string>',
        'Config' => [
            'Comment' => '<string>',
            'PrivateZone' => true || false,
        ],
        'Id' => '<string>',
        'LinkedService' => [
            'Description' => '<string>',
            'ServicePrincipal' => '<string>',
        ],
        'Name' => '<string>',
        'ResourceRecordSetCount' => <integer>,
    ],
    'VPCs' => [
        [
            'VPCId' => '<string>',
            'VPCRegion' => 'us-east-1|us-east-2|us-west-1|us-west-2|eu-west-1|eu-west-2|eu-west-3|eu-central-1|eu-central-2|ap-east-1|me-south-1|us-gov-west-1|us-gov-east-1|us-iso-east-1|us-iso-west-1|us-isob-east-1|me-central-1|ap-southeast-1|ap-southeast-2|ap-southeast-3|ap-south-1|ap-south-2|ap-northeast-1|ap-northeast-2|ap-northeast-3|eu-north-1|sa-east-1|ca-central-1|cn-north-1|cn-northwest-1|af-south-1|eu-south-1|eu-south-2|ap-southeast-4|il-central-1|ca-west-1|ap-southeast-5',
        ],
        // ...
    ],
]

$result = $client->getHostedZone([
    'Id' => 'Z3M3LMPEXAMPLE',
]);

[
    'DelegationSet' => [
        'NameServers' => [
            'ns-2048.awsdns-64.com',
            'ns-2049.awsdns-65.net',
            'ns-2050.awsdns-66.org',
            'ns-2051.awsdns-67.co.uk',
        ],
    ],
    'HostedZone' => [
        'CallerReference' => 'C741617D-04E4-F8DE-B9D7-0D150FC61C2E',
        'Config' => [
            'PrivateZone' => ,
        ],
        'Id' => '/hostedzone/Z3M3LMPEXAMPLE',
        'Name' => 'myawsbucket.com.',
        'ResourceRecordSetCount' => 8,
    ],
]