change_resource_record_sets async ¶

async def change_resource_record_sets(
    self,
    hosted_zone_id: "capo_route_53.types.resource_id.ResourceId",
    change_batch: "capo_route_53.types.change_batch.ChangeBatch",
    *,
    config_overrides: Optional[AsyncRoute53ClientConfig] = None,
) -> "capo_route_53.types.change_resource_record_sets_response.ChangeResourceRecordSetsResponse":
    """<p>Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use <code>ChangeResourceRecordSets</code> to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.</p> <p> <b>Deleting Resource Record Sets</b> </p> <p>To delete a resource record set, you must specify all the same values that you specified when you created it.</p> <p> <b>Change Batches and Transactional Changes</b> </p> <p>The request body must include a document with a <code>ChangeResourceRecordSetsRequest</code> element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. Route 53 validates the changes in the request and then either makes all or none of the changes in the change batch request. This ensures that DNS routing isn't adversely affected by partial changes to the resource record sets in a hosted zone. </p> <p>For example, suppose a change batch request contains two changes: it deletes the <code>CNAME</code> resource record set for www.example.com and creates an alias resource record set for www.example.com. If validation for both records succeeds, Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If validation for either the <code>DELETE</code> or the <code>CREATE</code> action fails, then the request is canceled, and the original <code>CNAME</code> record continues to exist.</p> <note> <p>If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an <code>InvalidChangeBatch</code> error.</p> </note> <p> <b>Traffic Flow</b> </p> <p>To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/traffic-flow.html">Using Traffic Flow to Route DNS Traffic</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p> <b>Create, Delete, and Upsert</b> </p> <p>Use <code>ChangeResourceRecordsSetsRequest</code> to perform the following actions:</p> <ul> <li> <p> <code>CREATE</code>: Creates a resource record set that has the specified values.</p> </li> <li> <p> <code>DELETE</code>: Deletes an existing resource record set that has the specified values.</p> </li> <li> <p> <code>UPSERT</code>: If a resource set doesn't exist, Route 53 creates it. If a resource set exists Route 53 updates it with the values in the request. </p> </li> </ul> <p> <b>Syntaxes for Creating, Updating, and Deleting Resource Record Sets</b> </p> <p>The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax. </p> <p>For an example for each type of resource record set, see "Examples."</p> <p>Don't refer to the syntax in the "Parameter Syntax" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using <code>ChangeResourceRecordSets</code>. </p> <p> <b>Change Propagation to Route 53 DNS Servers</b> </p> <p>When you submit a <code>ChangeResourceRecordSets</code> request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While your changes are propagating, <code>GetChange</code> returns a status of <code>PENDING</code>. When propagation is complete, <code>GetChange</code> returns a status of <code>INSYNC</code>. Changes generally propagate to all Route 53 name servers managing the hosted zone within 60 seconds. For more information, see <a href="https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html">GetChange</a>.</p> <p> <b>Limits on ChangeResourceRecordSets Requests</b> </p> <p>For information about the limits on a <code>ChangeResourceRecordSets</code> request, see <a href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html">Limits</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>

    Args:
        hosted_zone_id: <p>The ID of the hosted zone that contains the resource record sets that you want to change.</p>
        change_batch: <p>A complex type that contains an optional comment and the <code>Changes</code> element.</p>

    Raises:
        capo_route_53.errors.invalid_change_batch.InvalidChangeBatch: <p>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.</p>
        capo_route_53.errors.invalid_input.InvalidInput: <p>The input is not valid.</p>
        capo_route_53.errors.no_such_health_check.NoSuchHealthCheck: <p>No health check exists with the specified ID.</p>
        capo_route_53.errors.no_such_hosted_zone.NoSuchHostedZone: <p>No hosted zone exists with the ID that you specified.</p>
        capo_route_53.errors.prior_request_not_complete.PriorRequestNotComplete: <p>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 <code>HTTP 400 error</code> (<code>Bad request</code>). 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.</p>
        capo_route_53.errors.UnknownServiceError: The service returned an error code this client does not model.

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

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'CloudFront distribution for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'AliasTarget': {'HostedZoneId': 'Z2FDTNDATAQYW2', 'DNSName': 'd123rk29d0stfj.cloudfront.net', 'EvaluateTargetHealth': False}}}]})
        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.

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'Failover alias configuration for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Ohio region', 'Failover': 'PRIMARY', 'AliasTarget': {'HostedZoneId': 'Z3AADJGX6KTTL2', 'DNSName': 'example-com-123456789.us-east-2.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Oregon region', 'Failover': 'SECONDARY', 'AliasTarget': {'HostedZoneId': 'Z1H1FL5HABSF5', 'DNSName': 'example-com-987654321.us-west-2.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}]})
        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.

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'Failover configuration for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Ohio region', 'Failover': 'PRIMARY', 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.44'}], 'HealthCheckId': 'abcdef11-2222-3333-4444-555555fedcba'}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Oregon region', 'Failover': 'SECONDARY', 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.45'}], 'HealthCheckId': 'abcdef66-7777-8888-9999-000000fedcba'}}]})
        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 (*).

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'Geolocation alias configuration for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'North America', 'GeoLocation': {'ContinentCode': 'NA'}, 'AliasTarget': {'HostedZoneId': 'Z3AADJGX6KTTL2', 'DNSName': 'example-com-123456789.us-east-2.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'South America', 'GeoLocation': {'ContinentCode': 'SA'}, 'AliasTarget': {'HostedZoneId': 'Z2P70J7HTTTPLU', 'DNSName': 'example-com-234567890.sa-east-1.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Europe', 'GeoLocation': {'ContinentCode': 'EU'}, 'AliasTarget': {'HostedZoneId': 'Z215JYRZR1TBD5', 'DNSName': 'example-com-234567890.eu-central-1.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Other locations', 'GeoLocation': {'CountryCode': '*'}, 'AliasTarget': {'HostedZoneId': 'Z1LMS91P8CMLE5', 'DNSName': 'example-com-234567890.ap-southeast-1.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}]})
        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 (*).

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'Geolocation configuration for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'North America', 'GeoLocation': {'ContinentCode': 'NA'}, 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.44'}]}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'South America', 'GeoLocation': {'ContinentCode': 'SA'}, 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.45'}]}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Europe', 'GeoLocation': {'ContinentCode': 'EU'}, 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.46'}]}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Other locations', 'GeoLocation': {'CountryCode': '*'}, 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.47'}]}}]})
        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.

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'ELB load balancers for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Ohio region', 'Region': 'us-east-2', 'AliasTarget': {'HostedZoneId': 'Z3AADJGX6KTTL2', 'DNSName': 'example-com-123456789.us-east-2.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Oregon region', 'Region': 'us-west-2', 'AliasTarget': {'HostedZoneId': 'Z1H1FL5HABSF5', 'DNSName': 'example-com-987654321.us-west-2.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}]})
        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.

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'EC2 instances for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Ohio region', 'Region': 'us-east-2', 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.44'}], 'HealthCheckId': 'abcdef11-2222-3333-4444-555555fedcba'}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Oregon region', 'Region': 'us-west-2', 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.45'}], 'HealthCheckId': 'abcdef66-7777-8888-9999-000000fedcba'}}]})
        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.

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'Web server for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.44'}]}}]})
        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.

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'ELB load balancers for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Ohio region', 'Weight': 100, 'AliasTarget': {'HostedZoneId': 'Z3AADJGX6KTTL2', 'DNSName': 'example-com-123456789.us-east-2.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Oregon region', 'Weight': 200, 'AliasTarget': {'HostedZoneId': 'Z1H1FL5HABSF5', 'DNSName': 'example-com-987654321.us-west-2.elb.amazonaws.com ', 'EvaluateTargetHealth': True}}}]})
        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.

        >>> await client.change_resource_record_sets(hosted_zone_id='Z3M3LMPEXAMPLE', change_batch={'Comment': 'Web servers for example.com', 'Changes': [{'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Seattle data center', 'Weight': 100, 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.44'}], 'HealthCheckId': 'abcdef11-2222-3333-4444-555555fedcba'}}, {'Action': 'CREATE', 'ResourceRecordSet': {'Name': 'example.com', 'Type': 'A', 'SetIdentifier': 'Portland data center', 'Weight': 200, 'TTL': 60, 'ResourceRecords': [{'Value': '192.0.2.45'}], 'HealthCheckId': 'abcdef66-7777-8888-9999-000000fedcba'}}]})
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_route_53.types.change_resource_record_sets_request.ChangeResourceRecordSetsRequest]",
    ) -> AsyncOperationResponse[
        "capo_route_53.types.change_resource_record_sets_response.ChangeResourceRecordSetsResponse"
    ]:
        import capo_route_53._operations.aws_dns_v20130401.change_resource_record_sets

        (
            output,
            http_response,
        ) = await capo_route_53._operations.aws_dns_v20130401.change_resource_record_sets.async_change_resource_record_sets(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ChangeResourceRecordSets")
    )
    input_: capo_route_53.types.change_resource_record_sets_request.ChangeResourceRecordSetsRequest = {
        "hosted_zone_id": hosted_zone_id,
        "change_batch": change_batch,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output