Interface Route53AsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.
You can use Route 53 to:
-
Register domain names.
For more information, see How domain registration works.
-
Route internet traffic to the resources for your domain
For more information, see How internet traffic is routed to your website or web application.
-
Check the health of your resources.
For more information, see How Route 53 checks the health of your resources.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionactivateKeySigningKey(Consumer<ActivateKeySigningKeyRequest.Builder> activateKeySigningKeyRequest) Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC.activateKeySigningKey(ActivateKeySigningKeyRequest activateKeySigningKeyRequest) Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC.associateVPCWithHostedZone(Consumer<AssociateVpcWithHostedZoneRequest.Builder> associateVpcWithHostedZoneRequest) Associates an Amazon VPC with a private hosted zone.associateVPCWithHostedZone(AssociateVpcWithHostedZoneRequest associateVpcWithHostedZoneRequest) Associates an Amazon VPC with a private hosted zone.static Route53AsyncClientBuilderbuilder()Create a builder that can be used to configure and create aRoute53AsyncClient.changeCidrCollection(Consumer<ChangeCidrCollectionRequest.Builder> changeCidrCollectionRequest) Creates, changes, or deletes CIDR blocks within a collection.changeCidrCollection(ChangeCidrCollectionRequest changeCidrCollectionRequest) Creates, changes, or deletes CIDR blocks within a collection.changeResourceRecordSets(Consumer<ChangeResourceRecordSetsRequest.Builder> changeResourceRecordSetsRequest) Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name.changeResourceRecordSets(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest) Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name.changeTagsForResource(Consumer<ChangeTagsForResourceRequest.Builder> changeTagsForResourceRequest) Adds, edits, or deletes tags for a health check or a hosted zone.changeTagsForResource(ChangeTagsForResourceRequest changeTagsForResourceRequest) Adds, edits, or deletes tags for a health check or a hosted zone.static Route53AsyncClientcreate()Create aRoute53AsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createCidrCollection(Consumer<CreateCidrCollectionRequest.Builder> createCidrCollectionRequest) Creates a CIDR collection in the current Amazon Web Services account.createCidrCollection(CreateCidrCollectionRequest createCidrCollectionRequest) Creates a CIDR collection in the current Amazon Web Services account.createHealthCheck(Consumer<CreateHealthCheckRequest.Builder> createHealthCheckRequest) Creates a new health check.createHealthCheck(CreateHealthCheckRequest createHealthCheckRequest) Creates a new health check.createHostedZone(Consumer<CreateHostedZoneRequest.Builder> createHostedZoneRequest) Creates a new public or private hosted zone.createHostedZone(CreateHostedZoneRequest createHostedZoneRequest) Creates a new public or private hosted zone.createKeySigningKey(Consumer<CreateKeySigningKeyRequest.Builder> createKeySigningKeyRequest) Creates a new key-signing key (KSK) associated with a hosted zone.createKeySigningKey(CreateKeySigningKeyRequest createKeySigningKeyRequest) Creates a new key-signing key (KSK) associated with a hosted zone.createQueryLoggingConfig(Consumer<CreateQueryLoggingConfigRequest.Builder> createQueryLoggingConfigRequest) Creates a configuration for DNS query logging.createQueryLoggingConfig(CreateQueryLoggingConfigRequest createQueryLoggingConfigRequest) Creates a configuration for DNS query logging.createReusableDelegationSet(Consumer<CreateReusableDelegationSetRequest.Builder> createReusableDelegationSetRequest) 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.createReusableDelegationSet(CreateReusableDelegationSetRequest createReusableDelegationSetRequest) 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.createTrafficPolicy(Consumer<CreateTrafficPolicyRequest.Builder> createTrafficPolicyRequest) 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).createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest) 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).createTrafficPolicyInstance(Consumer<CreateTrafficPolicyInstanceRequest.Builder> createTrafficPolicyInstanceRequest) Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version.createTrafficPolicyInstance(CreateTrafficPolicyInstanceRequest createTrafficPolicyInstanceRequest) Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version.createTrafficPolicyVersion(Consumer<CreateTrafficPolicyVersionRequest.Builder> createTrafficPolicyVersionRequest) Creates a new version of an existing traffic policy.createTrafficPolicyVersion(CreateTrafficPolicyVersionRequest createTrafficPolicyVersionRequest) Creates a new version of an existing traffic policy.createVPCAssociationAuthorization(Consumer<CreateVpcAssociationAuthorizationRequest.Builder> createVpcAssociationAuthorizationRequest) Authorizes the Amazon Web Services account that created a specified VPC to submit anAssociateVPCWithHostedZonerequest to associate the VPC with a specified hosted zone that was created by a different account.createVPCAssociationAuthorization(CreateVpcAssociationAuthorizationRequest createVpcAssociationAuthorizationRequest) Authorizes the Amazon Web Services account that created a specified VPC to submit anAssociateVPCWithHostedZonerequest to associate the VPC with a specified hosted zone that was created by a different account.deactivateKeySigningKey(Consumer<DeactivateKeySigningKeyRequest.Builder> deactivateKeySigningKeyRequest) Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.deactivateKeySigningKey(DeactivateKeySigningKeyRequest deactivateKeySigningKeyRequest) Deactivates a key-signing key (KSK) so that it will not be used for signing by DNSSEC.deleteCidrCollection(Consumer<DeleteCidrCollectionRequest.Builder> deleteCidrCollectionRequest) Deletes a CIDR collection in the current Amazon Web Services account.deleteCidrCollection(DeleteCidrCollectionRequest deleteCidrCollectionRequest) Deletes a CIDR collection in the current Amazon Web Services account.deleteHealthCheck(Consumer<DeleteHealthCheckRequest.Builder> deleteHealthCheckRequest) Deletes a health check.deleteHealthCheck(DeleteHealthCheckRequest deleteHealthCheckRequest) Deletes a health check.deleteHostedZone(Consumer<DeleteHostedZoneRequest.Builder> deleteHostedZoneRequest) Deletes a hosted zone.deleteHostedZone(DeleteHostedZoneRequest deleteHostedZoneRequest) Deletes a hosted zone.deleteKeySigningKey(Consumer<DeleteKeySigningKeyRequest.Builder> deleteKeySigningKeyRequest) Deletes a key-signing key (KSK).deleteKeySigningKey(DeleteKeySigningKeyRequest deleteKeySigningKeyRequest) Deletes a key-signing key (KSK).deleteQueryLoggingConfig(Consumer<DeleteQueryLoggingConfigRequest.Builder> deleteQueryLoggingConfigRequest) Deletes a configuration for DNS query logging.deleteQueryLoggingConfig(DeleteQueryLoggingConfigRequest deleteQueryLoggingConfigRequest) Deletes a configuration for DNS query logging.deleteReusableDelegationSet(Consumer<DeleteReusableDelegationSetRequest.Builder> deleteReusableDelegationSetRequest) Deletes a reusable delegation set.deleteReusableDelegationSet(DeleteReusableDelegationSetRequest deleteReusableDelegationSetRequest) Deletes a reusable delegation set.deleteTrafficPolicy(Consumer<DeleteTrafficPolicyRequest.Builder> deleteTrafficPolicyRequest) Deletes a traffic policy.deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest) Deletes a traffic policy.deleteTrafficPolicyInstance(Consumer<DeleteTrafficPolicyInstanceRequest.Builder> deleteTrafficPolicyInstanceRequest) Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.deleteTrafficPolicyInstance(DeleteTrafficPolicyInstanceRequest deleteTrafficPolicyInstanceRequest) Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.deleteVPCAssociationAuthorization(Consumer<DeleteVpcAssociationAuthorizationRequest.Builder> deleteVpcAssociationAuthorizationRequest) Removes authorization to submit anAssociateVPCWithHostedZonerequest to associate a specified VPC with a hosted zone that was created by a different account.deleteVPCAssociationAuthorization(DeleteVpcAssociationAuthorizationRequest deleteVpcAssociationAuthorizationRequest) Removes authorization to submit anAssociateVPCWithHostedZonerequest to associate a specified VPC with a hosted zone that was created by a different account.disableHostedZoneDNSSEC(Consumer<DisableHostedZoneDnssecRequest.Builder> disableHostedZoneDnssecRequest) Disables DNSSEC signing in a specific hosted zone.disableHostedZoneDNSSEC(DisableHostedZoneDnssecRequest disableHostedZoneDnssecRequest) Disables DNSSEC signing in a specific hosted zone.disassociateVPCFromHostedZone(Consumer<DisassociateVpcFromHostedZoneRequest.Builder> disassociateVpcFromHostedZoneRequest) Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone.disassociateVPCFromHostedZone(DisassociateVpcFromHostedZoneRequest disassociateVpcFromHostedZoneRequest) Disassociates an Amazon Virtual Private Cloud (Amazon VPC) from an Amazon Route 53 private hosted zone.enableHostedZoneDNSSEC(Consumer<EnableHostedZoneDnssecRequest.Builder> enableHostedZoneDnssecRequest) Enables DNSSEC signing in a specific hosted zone.enableHostedZoneDNSSEC(EnableHostedZoneDnssecRequest enableHostedZoneDnssecRequest) Enables DNSSEC signing in a specific hosted zone.default CompletableFuture<GetAccountLimitResponse> getAccountLimit(Consumer<GetAccountLimitRequest.Builder> getAccountLimitRequest) Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.default CompletableFuture<GetAccountLimitResponse> getAccountLimit(GetAccountLimitRequest getAccountLimitRequest) Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.default CompletableFuture<GetChangeResponse> getChange(Consumer<GetChangeRequest.Builder> getChangeRequest) Returns the current status of a change batch request.default CompletableFuture<GetChangeResponse> getChange(GetChangeRequest getChangeRequest) Returns the current status of a change batch request.Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.getCheckerIpRanges(Consumer<GetCheckerIpRangesRequest.Builder> getCheckerIpRangesRequest) Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.getCheckerIpRanges(GetCheckerIpRangesRequest getCheckerIpRangesRequest) Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.default CompletableFuture<GetDnssecResponse> getDNSSEC(Consumer<GetDnssecRequest.Builder> getDnssecRequest) Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.default CompletableFuture<GetDnssecResponse> getDNSSEC(GetDnssecRequest getDnssecRequest) Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.default CompletableFuture<GetGeoLocationResponse> Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.default CompletableFuture<GetGeoLocationResponse> getGeoLocation(Consumer<GetGeoLocationRequest.Builder> getGeoLocationRequest) Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.default CompletableFuture<GetGeoLocationResponse> getGeoLocation(GetGeoLocationRequest getGeoLocationRequest) Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.default CompletableFuture<GetHealthCheckResponse> getHealthCheck(Consumer<GetHealthCheckRequest.Builder> getHealthCheckRequest) Gets information about a specified health check.default CompletableFuture<GetHealthCheckResponse> getHealthCheck(GetHealthCheckRequest getHealthCheckRequest) Gets information about a specified health check.Retrieves the number of health checks that are associated with the current Amazon Web Services account.getHealthCheckCount(Consumer<GetHealthCheckCountRequest.Builder> getHealthCheckCountRequest) Retrieves the number of health checks that are associated with the current Amazon Web Services account.getHealthCheckCount(GetHealthCheckCountRequest getHealthCheckCountRequest) Retrieves the number of health checks that are associated with the current Amazon Web Services account.getHealthCheckLastFailureReason(Consumer<GetHealthCheckLastFailureReasonRequest.Builder> getHealthCheckLastFailureReasonRequest) Gets the reason that a specified health check failed most recently.getHealthCheckLastFailureReason(GetHealthCheckLastFailureReasonRequest getHealthCheckLastFailureReasonRequest) Gets the reason that a specified health check failed most recently.getHealthCheckStatus(Consumer<GetHealthCheckStatusRequest.Builder> getHealthCheckStatusRequest) Gets status of a specified health check.getHealthCheckStatus(GetHealthCheckStatusRequest getHealthCheckStatusRequest) Gets status of a specified health check.default CompletableFuture<GetHostedZoneResponse> getHostedZone(Consumer<GetHostedZoneRequest.Builder> getHostedZoneRequest) Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.default CompletableFuture<GetHostedZoneResponse> getHostedZone(GetHostedZoneRequest getHostedZoneRequest) Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.getHostedZoneCount(Consumer<GetHostedZoneCountRequest.Builder> getHostedZoneCountRequest) Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.getHostedZoneCount(GetHostedZoneCountRequest getHostedZoneCountRequest) Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.getHostedZoneLimit(Consumer<GetHostedZoneLimitRequest.Builder> getHostedZoneLimitRequest) Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.getHostedZoneLimit(GetHostedZoneLimitRequest getHostedZoneLimitRequest) Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.getQueryLoggingConfig(Consumer<GetQueryLoggingConfigRequest.Builder> getQueryLoggingConfigRequest) Gets information about a specified configuration for DNS query logging.getQueryLoggingConfig(GetQueryLoggingConfigRequest getQueryLoggingConfigRequest) Gets information about a specified configuration for DNS query logging.getReusableDelegationSet(Consumer<GetReusableDelegationSetRequest.Builder> getReusableDelegationSetRequest) Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.getReusableDelegationSet(GetReusableDelegationSetRequest getReusableDelegationSetRequest) Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.getReusableDelegationSetLimit(Consumer<GetReusableDelegationSetLimitRequest.Builder> getReusableDelegationSetLimitRequest) Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.getReusableDelegationSetLimit(GetReusableDelegationSetLimitRequest getReusableDelegationSetLimitRequest) Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.getTrafficPolicy(Consumer<GetTrafficPolicyRequest.Builder> getTrafficPolicyRequest) Gets information about a specific traffic policy version.getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest) Gets information about a specific traffic policy version.getTrafficPolicyInstance(Consumer<GetTrafficPolicyInstanceRequest.Builder> getTrafficPolicyInstanceRequest) Gets information about a specified traffic policy instance.getTrafficPolicyInstance(GetTrafficPolicyInstanceRequest getTrafficPolicyInstanceRequest) Gets information about a specified traffic policy instance.Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.getTrafficPolicyInstanceCount(Consumer<GetTrafficPolicyInstanceCountRequest.Builder> getTrafficPolicyInstanceCountRequest) Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.getTrafficPolicyInstanceCount(GetTrafficPolicyInstanceCountRequest getTrafficPolicyInstanceCountRequest) Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.default CompletableFuture<ListCidrBlocksResponse> listCidrBlocks(Consumer<ListCidrBlocksRequest.Builder> listCidrBlocksRequest) Returns a paginated list of location objects and their CIDR blocks.default CompletableFuture<ListCidrBlocksResponse> listCidrBlocks(ListCidrBlocksRequest listCidrBlocksRequest) Returns a paginated list of location objects and their CIDR blocks.default ListCidrBlocksPublisherlistCidrBlocksPaginator(Consumer<ListCidrBlocksRequest.Builder> listCidrBlocksRequest) This is a variant oflistCidrBlocks(software.amazon.awssdk.services.route53.model.ListCidrBlocksRequest)operation.default ListCidrBlocksPublisherlistCidrBlocksPaginator(ListCidrBlocksRequest listCidrBlocksRequest) This is a variant oflistCidrBlocks(software.amazon.awssdk.services.route53.model.ListCidrBlocksRequest)operation.listCidrCollections(Consumer<ListCidrCollectionsRequest.Builder> listCidrCollectionsRequest) Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).listCidrCollections(ListCidrCollectionsRequest listCidrCollectionsRequest) Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).default ListCidrCollectionsPublisherlistCidrCollectionsPaginator(Consumer<ListCidrCollectionsRequest.Builder> listCidrCollectionsRequest) This is a variant oflistCidrCollections(software.amazon.awssdk.services.route53.model.ListCidrCollectionsRequest)operation.default ListCidrCollectionsPublisherlistCidrCollectionsPaginator(ListCidrCollectionsRequest listCidrCollectionsRequest) This is a variant oflistCidrCollections(software.amazon.awssdk.services.route53.model.ListCidrCollectionsRequest)operation.listCidrLocations(Consumer<ListCidrLocationsRequest.Builder> listCidrLocationsRequest) Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).listCidrLocations(ListCidrLocationsRequest listCidrLocationsRequest) Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).default ListCidrLocationsPublisherlistCidrLocationsPaginator(Consumer<ListCidrLocationsRequest.Builder> listCidrLocationsRequest) This is a variant oflistCidrLocations(software.amazon.awssdk.services.route53.model.ListCidrLocationsRequest)operation.default ListCidrLocationsPublisherlistCidrLocationsPaginator(ListCidrLocationsRequest listCidrLocationsRequest) This is a variant oflistCidrLocations(software.amazon.awssdk.services.route53.model.ListCidrLocationsRequest)operation.Retrieves a list of supported geographic locations.listGeoLocations(Consumer<ListGeoLocationsRequest.Builder> listGeoLocationsRequest) Retrieves a list of supported geographic locations.listGeoLocations(ListGeoLocationsRequest listGeoLocationsRequest) Retrieves a list of supported geographic locations.Retrieve a list of the health checks that are associated with the current Amazon Web Services account.listHealthChecks(Consumer<ListHealthChecksRequest.Builder> listHealthChecksRequest) Retrieve a list of the health checks that are associated with the current Amazon Web Services account.listHealthChecks(ListHealthChecksRequest listHealthChecksRequest) Retrieve a list of the health checks that are associated with the current Amazon Web Services account.default ListHealthChecksPublisherThis is a variant oflistHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation.default ListHealthChecksPublisherlistHealthChecksPaginator(Consumer<ListHealthChecksRequest.Builder> listHealthChecksRequest) This is a variant oflistHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation.default ListHealthChecksPublisherlistHealthChecksPaginator(ListHealthChecksRequest listHealthChecksRequest) This is a variant oflistHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation.default CompletableFuture<ListHostedZonesResponse> Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account.default CompletableFuture<ListHostedZonesResponse> listHostedZones(Consumer<ListHostedZonesRequest.Builder> listHostedZonesRequest) Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account.default CompletableFuture<ListHostedZonesResponse> listHostedZones(ListHostedZonesRequest listHostedZonesRequest) Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account.Retrieves a list of your hosted zones in lexicographic order.listHostedZonesByName(Consumer<ListHostedZonesByNameRequest.Builder> listHostedZonesByNameRequest) Retrieves a list of your hosted zones in lexicographic order.listHostedZonesByName(ListHostedZonesByNameRequest listHostedZonesByNameRequest) Retrieves a list of your hosted zones in lexicographic order.listHostedZonesByVPC(Consumer<ListHostedZonesByVpcRequest.Builder> listHostedZonesByVpcRequest) Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones.listHostedZonesByVPC(ListHostedZonesByVpcRequest listHostedZonesByVpcRequest) Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones.default ListHostedZonesPublisherThis is a variant oflistHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation.default ListHostedZonesPublisherlistHostedZonesPaginator(Consumer<ListHostedZonesRequest.Builder> listHostedZonesRequest) This is a variant oflistHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation.default ListHostedZonesPublisherlistHostedZonesPaginator(ListHostedZonesRequest listHostedZonesRequest) This is a variant oflistHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation.Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.listQueryLoggingConfigs(Consumer<ListQueryLoggingConfigsRequest.Builder> listQueryLoggingConfigsRequest) Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.listQueryLoggingConfigs(ListQueryLoggingConfigsRequest listQueryLoggingConfigsRequest) Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.default ListQueryLoggingConfigsPublisherThis is a variant oflistQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation.default ListQueryLoggingConfigsPublisherlistQueryLoggingConfigsPaginator(Consumer<ListQueryLoggingConfigsRequest.Builder> listQueryLoggingConfigsRequest) This is a variant oflistQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation.default ListQueryLoggingConfigsPublisherlistQueryLoggingConfigsPaginator(ListQueryLoggingConfigsRequest listQueryLoggingConfigsRequest) This is a variant oflistQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation.listResourceRecordSets(Consumer<ListResourceRecordSetsRequest.Builder> listResourceRecordSetsRequest) Lists the resource record sets in a specified hosted zone.listResourceRecordSets(ListResourceRecordSetsRequest listResourceRecordSetsRequest) Lists the resource record sets in a specified hosted zone.default ListResourceRecordSetsPublisherlistResourceRecordSetsPaginator(Consumer<ListResourceRecordSetsRequest.Builder> listResourceRecordSetsRequest) This is a variant oflistResourceRecordSets(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsRequest)operation.default ListResourceRecordSetsPublisherlistResourceRecordSetsPaginator(ListResourceRecordSetsRequest listResourceRecordSetsRequest) This is a variant oflistResourceRecordSets(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsRequest)operation.Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.listReusableDelegationSets(Consumer<ListReusableDelegationSetsRequest.Builder> listReusableDelegationSetsRequest) Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.listReusableDelegationSets(ListReusableDelegationSetsRequest listReusableDelegationSetsRequest) Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags for one health check or hosted zone.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags for one health check or hosted zone.listTagsForResources(Consumer<ListTagsForResourcesRequest.Builder> listTagsForResourcesRequest) Lists tags for up to 10 health checks or hosted zones.listTagsForResources(ListTagsForResourcesRequest listTagsForResourcesRequest) Lists tags for up to 10 health checks or hosted zones.Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account.listTrafficPolicies(Consumer<ListTrafficPoliciesRequest.Builder> listTrafficPoliciesRequest) Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account.listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest) Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account.Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.listTrafficPolicyInstances(Consumer<ListTrafficPolicyInstancesRequest.Builder> listTrafficPolicyInstancesRequest) Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.listTrafficPolicyInstances(ListTrafficPolicyInstancesRequest listTrafficPolicyInstancesRequest) Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.listTrafficPolicyInstancesByHostedZone(Consumer<ListTrafficPolicyInstancesByHostedZoneRequest.Builder> listTrafficPolicyInstancesByHostedZoneRequest) Gets information about the traffic policy instances that you created in a specified hosted zone.listTrafficPolicyInstancesByHostedZone(ListTrafficPolicyInstancesByHostedZoneRequest listTrafficPolicyInstancesByHostedZoneRequest) Gets information about the traffic policy instances that you created in a specified hosted zone.listTrafficPolicyInstancesByPolicy(Consumer<ListTrafficPolicyInstancesByPolicyRequest.Builder> listTrafficPolicyInstancesByPolicyRequest) Gets information about the traffic policy instances that you created by using a specify traffic policy version.listTrafficPolicyInstancesByPolicy(ListTrafficPolicyInstancesByPolicyRequest listTrafficPolicyInstancesByPolicyRequest) Gets information about the traffic policy instances that you created by using a specify traffic policy version.listTrafficPolicyVersions(Consumer<ListTrafficPolicyVersionsRequest.Builder> listTrafficPolicyVersionsRequest) Gets information about all of the versions for a specified traffic policy.listTrafficPolicyVersions(ListTrafficPolicyVersionsRequest listTrafficPolicyVersionsRequest) Gets information about all of the versions for a specified traffic policy.listVPCAssociationAuthorizations(Consumer<ListVpcAssociationAuthorizationsRequest.Builder> listVpcAssociationAuthorizationsRequest) Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or moreCreateVPCAssociationAuthorizationrequests.listVPCAssociationAuthorizations(ListVpcAssociationAuthorizationsRequest listVpcAssociationAuthorizationsRequest) Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or moreCreateVPCAssociationAuthorizationrequests.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<TestDnsAnswerResponse> testDNSAnswer(Consumer<TestDnsAnswerRequest.Builder> testDnsAnswerRequest) Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type.default CompletableFuture<TestDnsAnswerResponse> testDNSAnswer(TestDnsAnswerRequest testDnsAnswerRequest) Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type.updateHealthCheck(Consumer<UpdateHealthCheckRequest.Builder> updateHealthCheckRequest) Updates an existing health check.updateHealthCheck(UpdateHealthCheckRequest updateHealthCheckRequest) Updates an existing health check.updateHostedZoneComment(Consumer<UpdateHostedZoneCommentRequest.Builder> updateHostedZoneCommentRequest) Updates the comment for a specified hosted zone.updateHostedZoneComment(UpdateHostedZoneCommentRequest updateHostedZoneCommentRequest) Updates the comment for a specified hosted zone.updateTrafficPolicyComment(Consumer<UpdateTrafficPolicyCommentRequest.Builder> updateTrafficPolicyCommentRequest) Updates the comment for a specified traffic policy version.updateTrafficPolicyComment(UpdateTrafficPolicyCommentRequest updateTrafficPolicyCommentRequest) Updates the comment for a specified traffic policy version.updateTrafficPolicyInstance(Consumer<UpdateTrafficPolicyInstanceRequest.Builder> updateTrafficPolicyInstanceRequest) updateTrafficPolicyInstance(UpdateTrafficPolicyInstanceRequest updateTrafficPolicyInstanceRequest) default Route53AsyncWaiterwaiter()Create an instance ofRoute53AsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
activateKeySigningKey
default CompletableFuture<ActivateKeySigningKeyResponse> activateKeySigningKey(ActivateKeySigningKeyRequest activateKeySigningKeyRequest) Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to
ACTIVE.- Parameters:
activateKeySigningKeyRequest-- Returns:
- A Java Future containing the result of the ActivateKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchKeySigningKeyException The specified key-signing key (KSK) doesn't exist.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
activateKeySigningKey
default CompletableFuture<ActivateKeySigningKeyResponse> activateKeySigningKey(Consumer<ActivateKeySigningKeyRequest.Builder> activateKeySigningKeyRequest) Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC. This operation changes the KSK status to
ACTIVE.
This is a convenience which creates an instance of the
ActivateKeySigningKeyRequest.Builderavoiding the need to create one manually viaActivateKeySigningKeyRequest.builder()- Parameters:
activateKeySigningKeyRequest- AConsumerthat will call methods onActivateKeySigningKeyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ActivateKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchKeySigningKeyException The specified key-signing key (KSK) doesn't exist.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateVPCWithHostedZone
default CompletableFuture<AssociateVpcWithHostedZoneResponse> associateVPCWithHostedZone(AssociateVpcWithHostedZoneRequest associateVpcWithHostedZoneRequest) Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a
CreateVPCAssociationAuthorizationrequest. Then the account that created the VPC must submit anAssociateVPCWithHostedZonerequest.When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
- Parameters:
associateVpcWithHostedZoneRequest- A complex type that contains information about the request to associate a VPC with a private hosted zone.- Returns:
- A Java Future containing the result of the AssociateVPCWithHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- NotAuthorizedException Associating the specified VPC with the specified hosted zone has not been authorized.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- PublicZoneVpcAssociationException 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.
- ConflictingDomainExistsException 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.
-
- LimitsExceededException 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.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
associateVPCWithHostedZone
default CompletableFuture<AssociateVpcWithHostedZoneResponse> associateVPCWithHostedZone(Consumer<AssociateVpcWithHostedZoneRequest.Builder> associateVpcWithHostedZoneRequest) Associates an Amazon VPC with a private hosted zone.
To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.
If you want to associate a VPC that was created by using one Amazon Web Services account with a private hosted zone that was created by using a different account, the Amazon Web Services account that created the private hosted zone must first submit a
CreateVPCAssociationAuthorizationrequest. Then the account that created the VPC must submit anAssociateVPCWithHostedZonerequest.When granting access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
This is a convenience which creates an instance of the
AssociateVpcWithHostedZoneRequest.Builderavoiding the need to create one manually viaAssociateVpcWithHostedZoneRequest.builder()- Parameters:
associateVpcWithHostedZoneRequest- AConsumerthat will call methods onAssociateVpcWithHostedZoneRequest.Builderto create a request. A complex type that contains information about the request to associate a VPC with a private hosted zone.- Returns:
- A Java Future containing the result of the AssociateVPCWithHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- NotAuthorizedException Associating the specified VPC with the specified hosted zone has not been authorized.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- PublicZoneVpcAssociationException 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.
- ConflictingDomainExistsException 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.
-
- LimitsExceededException 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.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
changeCidrCollection
default CompletableFuture<ChangeCidrCollectionResponse> changeCidrCollection(ChangeCidrCollectionRequest changeCidrCollectionRequest) 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
ChangeCidrCollectionto perform the following actions:-
PUT: Create a CIDR block within the specified collection. -
DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.
- Parameters:
changeCidrCollectionRequest-- Returns:
- A Java Future containing the result of the ChangeCidrCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- CidrCollectionVersionMismatchException The CIDR collection version you provided, doesn't match the
one in the
ListCidrCollectionsoperation. - InvalidInputException The input is not valid.
- CidrBlockInUseException This CIDR block is already in use.
- LimitsExceededException 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.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
changeCidrCollection
default CompletableFuture<ChangeCidrCollectionResponse> changeCidrCollection(Consumer<ChangeCidrCollectionRequest.Builder> changeCidrCollectionRequest) 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
ChangeCidrCollectionto perform the following actions:-
PUT: Create a CIDR block within the specified collection. -
DELETE_IF_EXISTS: Delete an existing CIDR block from the collection.
This is a convenience which creates an instance of the
ChangeCidrCollectionRequest.Builderavoiding the need to create one manually viaChangeCidrCollectionRequest.builder()- Parameters:
changeCidrCollectionRequest- AConsumerthat will call methods onChangeCidrCollectionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ChangeCidrCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- CidrCollectionVersionMismatchException The CIDR collection version you provided, doesn't match the
one in the
ListCidrCollectionsoperation. - InvalidInputException The input is not valid.
- CidrBlockInUseException This CIDR block is already in use.
- LimitsExceededException 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.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
changeResourceRecordSets
default CompletableFuture<ChangeResourceRecordSetsResponse> changeResourceRecordSets(ChangeResourceRecordSetsRequest changeResourceRecordSetsRequest) 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
ChangeResourceRecordSetsto 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
ChangeResourceRecordSetsRequestelement. 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
CNAMEresource 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 theDELETEor theCREATEaction fails, then the request is canceled, and the originalCNAMErecord continues to exist.If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an
InvalidChangeBatcherror.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
ChangeResourceRecordsSetsRequestto 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
ChangeResourceRecordSetsrequest, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While your changes are propagating,GetChangereturns a status ofPENDING. When propagation is complete,GetChangereturns a status ofINSYNC. 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
ChangeResourceRecordSetsrequest, see Limits in the Amazon Route 53 Developer Guide.- Parameters:
changeResourceRecordSetsRequest- A complex type that contains change information for the resource record set.- Returns:
- A Java Future containing the result of the ChangeResourceRecordSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidChangeBatchException 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.
- InvalidInputException The input is not valid.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
changeResourceRecordSets
default CompletableFuture<ChangeResourceRecordSetsResponse> changeResourceRecordSets(Consumer<ChangeResourceRecordSetsRequest.Builder> changeResourceRecordSetsRequest) 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
ChangeResourceRecordSetsto 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
ChangeResourceRecordSetsRequestelement. 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
CNAMEresource 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 theDELETEor theCREATEaction fails, then the request is canceled, and the originalCNAMErecord continues to exist.If you try to delete the same resource record set more than once in a single change batch, Route 53 returns an
InvalidChangeBatcherror.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
ChangeResourceRecordsSetsRequestto 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
ChangeResourceRecordSetsrequest, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers managing the hosted zone. While your changes are propagating,GetChangereturns a status ofPENDING. When propagation is complete,GetChangereturns a status ofINSYNC. 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
ChangeResourceRecordSetsrequest, see Limits in the Amazon Route 53 Developer Guide.
This is a convenience which creates an instance of the
ChangeResourceRecordSetsRequest.Builderavoiding the need to create one manually viaChangeResourceRecordSetsRequest.builder()- Parameters:
changeResourceRecordSetsRequest- AConsumerthat will call methods onChangeResourceRecordSetsRequest.Builderto create a request. A complex type that contains change information for the resource record set.- Returns:
- A Java Future containing the result of the ChangeResourceRecordSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidChangeBatchException 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.
- InvalidInputException The input is not valid.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
changeTagsForResource
default CompletableFuture<ChangeTagsForResourceResponse> changeTagsForResource(ChangeTagsForResourceRequest changeTagsForResourceRequest) 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.
- Parameters:
changeTagsForResourceRequest- A complex type that contains information about the tags that you want to add, edit, or delete.- Returns:
- A Java Future containing the result of the ChangeTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchHealthCheckException No health check exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- PriorRequestNotCompleteException 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
changeTagsForResource
default CompletableFuture<ChangeTagsForResourceResponse> changeTagsForResource(Consumer<ChangeTagsForResourceRequest.Builder> changeTagsForResourceRequest) 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.
This is a convenience which creates an instance of the
ChangeTagsForResourceRequest.Builderavoiding the need to create one manually viaChangeTagsForResourceRequest.builder()- Parameters:
changeTagsForResourceRequest- AConsumerthat will call methods onChangeTagsForResourceRequest.Builderto create a request. A complex type that contains information about the tags that you want to add, edit, or delete.- Returns:
- A Java Future containing the result of the ChangeTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchHealthCheckException No health check exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- PriorRequestNotCompleteException 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCidrCollection
default CompletableFuture<CreateCidrCollectionResponse> createCidrCollection(CreateCidrCollectionRequest createCidrCollectionRequest) Creates a CIDR collection in the current Amazon Web Services account.
- Parameters:
createCidrCollectionRequest-- Returns:
- A Java Future containing the result of the CreateCidrCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitsExceededException 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.
- InvalidInputException The input is not valid.
- CidrCollectionAlreadyExistsException A CIDR collection with this name and a different caller reference already exists in this account.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCidrCollection
default CompletableFuture<CreateCidrCollectionResponse> createCidrCollection(Consumer<CreateCidrCollectionRequest.Builder> createCidrCollectionRequest) Creates a CIDR collection in the current Amazon Web Services account.
This is a convenience which creates an instance of the
CreateCidrCollectionRequest.Builderavoiding the need to create one manually viaCreateCidrCollectionRequest.builder()- Parameters:
createCidrCollectionRequest- AConsumerthat will call methods onCreateCidrCollectionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateCidrCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitsExceededException 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.
- InvalidInputException The input is not valid.
- CidrCollectionAlreadyExistsException A CIDR collection with this name and a different caller reference already exists in this account.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHealthCheck
default CompletableFuture<CreateHealthCheckResponse> createHealthCheck(CreateHealthCheckRequest createHealthCheckRequest) 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
StatusCheckFailedmetric, 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.
- Parameters:
createHealthCheckRequest- A complex type that contains the health check request information.- Returns:
- A Java Future containing the result of the CreateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- TooManyHealthChecksException 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.
- HealthCheckAlreadyExistsException 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
CallerReferenceas 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
CallerReferenceas a health check that you created and later deleted, regardless of the other settings in the request.
-
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TooManyHealthChecksException This health check can't be created because the current account has
reached the limit on the number of active health checks.
- See Also:
-
-
createHealthCheck
default CompletableFuture<CreateHealthCheckResponse> createHealthCheck(Consumer<CreateHealthCheckRequest.Builder> createHealthCheckRequest) 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
StatusCheckFailedmetric, 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.
This is a convenience which creates an instance of the
CreateHealthCheckRequest.Builderavoiding the need to create one manually viaCreateHealthCheckRequest.builder()- Parameters:
createHealthCheckRequest- AConsumerthat will call methods onCreateHealthCheckRequest.Builderto create a request. A complex type that contains the health check request information.- Returns:
- A Java Future containing the result of the CreateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- TooManyHealthChecksException 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.
- HealthCheckAlreadyExistsException 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
CallerReferenceas 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
CallerReferenceas a health check that you created and later deleted, regardless of the other settings in the request.
-
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- TooManyHealthChecksException This health check can't be created because the current account has
reached the limit on the number of active health checks.
- See Also:
-
-
createHostedZone
default CompletableFuture<CreateHostedZoneResponse> createHostedZone(CreateHostedZoneRequest createHostedZoneRequest) 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).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
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
DelegationSetIdelement. -
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
CreateHostedZonerequest, the initial status of the hosted zone isPENDING. 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 toINSYNC.The
CreateHostedZonerequest requires the caller to have anec2:DescribeVpcspermission.When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
- Parameters:
createHostedZoneRequest- A complex type that contains information about the request to create a public or private hosted zone.- Returns:
- A Java Future containing the result of the CreateHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidDomainNameException The specified domain name is not valid.
- HostedZoneAlreadyExistsException 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. - TooManyHostedZonesException 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.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- DelegationSetNotAvailableException 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.
- ConflictingDomainExistsException 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.
-
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createHostedZone
default CompletableFuture<CreateHostedZoneResponse> createHostedZone(Consumer<CreateHostedZoneRequest.Builder> createHostedZoneRequest) 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).
You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.
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
DelegationSetIdelement. -
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
CreateHostedZonerequest, the initial status of the hosted zone isPENDING. 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 toINSYNC.The
CreateHostedZonerequest requires the caller to have anec2:DescribeVpcspermission.When creating private hosted zones, the Amazon VPC must belong to the same partition where the hosted zone is created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
This is a convenience which creates an instance of the
CreateHostedZoneRequest.Builderavoiding the need to create one manually viaCreateHostedZoneRequest.builder()- Parameters:
createHostedZoneRequest- AConsumerthat will call methods onCreateHostedZoneRequest.Builderto create a request. A complex type that contains information about the request to create a public or private hosted zone.- Returns:
- A Java Future containing the result of the CreateHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidDomainNameException The specified domain name is not valid.
- HostedZoneAlreadyExistsException 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. - TooManyHostedZonesException 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.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- DelegationSetNotAvailableException 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.
- ConflictingDomainExistsException 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.
-
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createKeySigningKey
default CompletableFuture<CreateKeySigningKeyResponse> createKeySigningKey(CreateKeySigningKeyRequest createKeySigningKeyRequest) Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
- Parameters:
createKeySigningKeyRequest-- Returns:
- A Java Future containing the result of the CreateKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- InvalidInputException The input is not valid.
- InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - InvalidKeySigningKeyNameException The key-signing key (KSK) name that you specified isn't a valid name.
- KeySigningKeyAlreadyExistsException You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.
- TooManyKeySigningKeysException You've reached the limit for the number of key-signing keys (KSKs). Remove at least one KSK, and then try again.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKeySigningKey
default CompletableFuture<CreateKeySigningKeyResponse> createKeySigningKey(Consumer<CreateKeySigningKeyRequest.Builder> createKeySigningKeyRequest) Creates a new key-signing key (KSK) associated with a hosted zone. You can only have two KSKs per hosted zone.
This is a convenience which creates an instance of the
CreateKeySigningKeyRequest.Builderavoiding the need to create one manually viaCreateKeySigningKeyRequest.builder()- Parameters:
createKeySigningKeyRequest- AConsumerthat will call methods onCreateKeySigningKeyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- InvalidInputException The input is not valid.
- InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - InvalidKeySigningKeyNameException The key-signing key (KSK) name that you specified isn't a valid name.
- KeySigningKeyAlreadyExistsException You've already created a key-signing key (KSK) with this name or with the same customer managed key ARN.
- TooManyKeySigningKeysException You've reached the limit for the number of key-signing keys (KSKs). Remove at least one KSK, and then try again.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createQueryLoggingConfig
default CompletableFuture<CreateQueryLoggingConfigResponse> createQueryLoggingConfig(CreateQueryLoggingConfigRequest createQueryLoggingConfigRequest) 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
NoErrororServFail
- 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.
-
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 nameIn 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.
-
-
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 codeThe 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.
- Parameters:
createQueryLoggingConfigRequest-- Returns:
- A Java Future containing the result of the CreateQueryLoggingConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- NoSuchCloudWatchLogsLogGroupException There is no CloudWatch Logs log group with the specified ARN.
- InvalidInputException The input is not valid.
- QueryLoggingConfigAlreadyExistsException You can create only one query logging configuration for a hosted zone, and a query logging configuration already exists for this hosted zone.
- InsufficientCloudWatchLogsResourcePolicyException 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
Resourcedoesn'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.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createQueryLoggingConfig
default CompletableFuture<CreateQueryLoggingConfigResponse> createQueryLoggingConfig(Consumer<CreateQueryLoggingConfigRequest.Builder> createQueryLoggingConfigRequest) 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
NoErrororServFail
- 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.
-
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 nameIn 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.
-
-
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 codeThe 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.
This is a convenience which creates an instance of the
CreateQueryLoggingConfigRequest.Builderavoiding the need to create one manually viaCreateQueryLoggingConfigRequest.builder()- Parameters:
createQueryLoggingConfigRequest- AConsumerthat will call methods onCreateQueryLoggingConfigRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateQueryLoggingConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- NoSuchCloudWatchLogsLogGroupException There is no CloudWatch Logs log group with the specified ARN.
- InvalidInputException The input is not valid.
- QueryLoggingConfigAlreadyExistsException You can create only one query logging configuration for a hosted zone, and a query logging configuration already exists for this hosted zone.
- InsufficientCloudWatchLogsResourcePolicyException 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
Resourcedoesn'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.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createReusableDelegationSet
default CompletableFuture<CreateReusableDelegationSetResponse> createReusableDelegationSet(CreateReusableDelegationSetRequest createReusableDelegationSetRequest) 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
CreateReusableDelegationSetrequest.You can't associate a reusable delegation set with a private hosted zone.
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:
-
Create a reusable delegation set.
-
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
-
Recreate resource record sets in the new hosted zones.
-
Change the registrar's name servers to use the name servers for the new hosted zones.
-
Monitor traffic for the website or application.
-
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.
- Parameters:
createReusableDelegationSetRequest-- Returns:
- A Java Future containing the result of the CreateReusableDelegationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- DelegationSetAlreadyCreatedException A delegation set with the same owner and caller reference combination has already been created.
- LimitsExceededException 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.
- HostedZoneNotFoundException The specified HostedZone can't be found.
- InvalidArgumentException Parameter name is not valid.
- InvalidInputException The input is not valid.
- DelegationSetNotAvailableException 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.
- DelegationSetAlreadyReusableException The specified delegation set has already been marked as reusable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createReusableDelegationSet
default CompletableFuture<CreateReusableDelegationSetResponse> createReusableDelegationSet(Consumer<CreateReusableDelegationSetRequest.Builder> createReusableDelegationSetRequest) 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
CreateReusableDelegationSetrequest.You can't associate a reusable delegation set with a private hosted zone.
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:
-
Create a reusable delegation set.
-
Recreate hosted zones, and reduce the TTL to 60 seconds or less.
-
Recreate resource record sets in the new hosted zones.
-
Change the registrar's name servers to use the name servers for the new hosted zones.
-
Monitor traffic for the website or application.
-
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.
This is a convenience which creates an instance of the
CreateReusableDelegationSetRequest.Builderavoiding the need to create one manually viaCreateReusableDelegationSetRequest.builder()- Parameters:
createReusableDelegationSetRequest- AConsumerthat will call methods onCreateReusableDelegationSetRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateReusableDelegationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- DelegationSetAlreadyCreatedException A delegation set with the same owner and caller reference combination has already been created.
- LimitsExceededException 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.
- HostedZoneNotFoundException The specified HostedZone can't be found.
- InvalidArgumentException Parameter name is not valid.
- InvalidInputException The input is not valid.
- DelegationSetNotAvailableException 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.
- DelegationSetAlreadyReusableException The specified delegation set has already been marked as reusable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createTrafficPolicy
default CompletableFuture<CreateTrafficPolicyResponse> createTrafficPolicy(CreateTrafficPolicyRequest createTrafficPolicyRequest) 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).
- Parameters:
createTrafficPolicyRequest- A complex type that contains information about the traffic policy that you want to create.- Returns:
- A Java Future containing the result of the CreateTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- TooManyTrafficPoliciesException 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.
- TrafficPolicyAlreadyExistsException A traffic policy that has the same value for
Namealready exists. - InvalidTrafficPolicyDocumentException The format of the traffic policy document that you specified in
the
Documentelement is not valid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrafficPolicy
default CompletableFuture<CreateTrafficPolicyResponse> createTrafficPolicy(Consumer<CreateTrafficPolicyRequest.Builder> createTrafficPolicyRequest) 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).
This is a convenience which creates an instance of the
CreateTrafficPolicyRequest.Builderavoiding the need to create one manually viaCreateTrafficPolicyRequest.builder()- Parameters:
createTrafficPolicyRequest- AConsumerthat will call methods onCreateTrafficPolicyRequest.Builderto create a request. A complex type that contains information about the traffic policy that you want to create.- Returns:
- A Java Future containing the result of the CreateTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- TooManyTrafficPoliciesException 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.
- TrafficPolicyAlreadyExistsException A traffic policy that has the same value for
Namealready exists. - InvalidTrafficPolicyDocumentException The format of the traffic policy document that you specified in
the
Documentelement is not valid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrafficPolicyInstance
default CompletableFuture<CreateTrafficPolicyInstanceResponse> createTrafficPolicyInstance(CreateTrafficPolicyInstanceRequest createTrafficPolicyInstanceRequest) Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition,
CreateTrafficPolicyInstanceassociates 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 thatCreateTrafficPolicyInstancecreated.After you submit an
CreateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. UseGetTrafficPolicyInstancewith theidof new traffic policy instance to confirm that theCreateTrafficPolicyInstancerequest completed successfully. For more information, see theStateresponse element.- Parameters:
createTrafficPolicyInstanceRequest- A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.- Returns:
- A Java Future containing the result of the CreateTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- TooManyTrafficPolicyInstancesException 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.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- TrafficPolicyInstanceAlreadyExistsException There is already a traffic policy instance with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrafficPolicyInstance
default CompletableFuture<CreateTrafficPolicyInstanceResponse> createTrafficPolicyInstance(Consumer<CreateTrafficPolicyInstanceRequest.Builder> createTrafficPolicyInstanceRequest) Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition,
CreateTrafficPolicyInstanceassociates 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 thatCreateTrafficPolicyInstancecreated.After you submit an
CreateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. UseGetTrafficPolicyInstancewith theidof new traffic policy instance to confirm that theCreateTrafficPolicyInstancerequest completed successfully. For more information, see theStateresponse element.
This is a convenience which creates an instance of the
CreateTrafficPolicyInstanceRequest.Builderavoiding the need to create one manually viaCreateTrafficPolicyInstanceRequest.builder()- Parameters:
createTrafficPolicyInstanceRequest- AConsumerthat will call methods onCreateTrafficPolicyInstanceRequest.Builderto create a request. A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.- Returns:
- A Java Future containing the result of the CreateTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- TooManyTrafficPolicyInstancesException 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.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- TrafficPolicyInstanceAlreadyExistsException There is already a traffic policy instance with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrafficPolicyVersion
default CompletableFuture<CreateTrafficPolicyVersionResponse> createTrafficPolicyVersion(CreateTrafficPolicyVersionRequest createTrafficPolicyVersionRequest) 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.
- Parameters:
createTrafficPolicyVersionRequest- A complex type that contains information about the traffic policy that you want to create a new version for.- Returns:
- A Java Future containing the result of the CreateTrafficPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- InvalidInputException The input is not valid.
- TooManyTrafficPolicyVersionsForCurrentPolicyException 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.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- InvalidTrafficPolicyDocumentException The format of the traffic policy document that you specified in
the
Documentelement is not valid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTrafficPolicyVersion
default CompletableFuture<CreateTrafficPolicyVersionResponse> createTrafficPolicyVersion(Consumer<CreateTrafficPolicyVersionRequest.Builder> createTrafficPolicyVersionRequest) 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.
This is a convenience which creates an instance of the
CreateTrafficPolicyVersionRequest.Builderavoiding the need to create one manually viaCreateTrafficPolicyVersionRequest.builder()- Parameters:
createTrafficPolicyVersionRequest- AConsumerthat will call methods onCreateTrafficPolicyVersionRequest.Builderto create a request. A complex type that contains information about the traffic policy that you want to create a new version for.- Returns:
- A Java Future containing the result of the CreateTrafficPolicyVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- InvalidInputException The input is not valid.
- TooManyTrafficPolicyVersionsForCurrentPolicyException 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.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- InvalidTrafficPolicyDocumentException The format of the traffic policy document that you specified in
the
Documentelement is not valid. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVPCAssociationAuthorization
default CompletableFuture<CreateVpcAssociationAuthorizationResponse> createVPCAssociationAuthorization(CreateVpcAssociationAuthorizationRequest createVpcAssociationAuthorizationRequest) Authorizes the Amazon Web Services account that created a specified VPC to submit an
AssociateVPCWithHostedZonerequest to associate the VPC with a specified hosted zone that was created by a different account. To submit aCreateVPCAssociationAuthorizationrequest, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit anAssociateVPCWithHostedZonerequest.If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.
- Parameters:
createVpcAssociationAuthorizationRequest- A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts.- Returns:
- A Java Future containing the result of the CreateVPCAssociationAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- TooManyVpcAssociationAuthorizationsException 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
DeleteVPCAssociationAuthorizationrequest to remove an existing authorization. To get a list of existing authorizations, submit aListVPCAssociationAuthorizationsrequest. - NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVPCAssociationAuthorization
default CompletableFuture<CreateVpcAssociationAuthorizationResponse> createVPCAssociationAuthorization(Consumer<CreateVpcAssociationAuthorizationRequest.Builder> createVpcAssociationAuthorizationRequest) Authorizes the Amazon Web Services account that created a specified VPC to submit an
AssociateVPCWithHostedZonerequest to associate the VPC with a specified hosted zone that was created by a different account. To submit aCreateVPCAssociationAuthorizationrequest, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit anAssociateVPCWithHostedZonerequest.If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.
This is a convenience which creates an instance of the
CreateVpcAssociationAuthorizationRequest.Builderavoiding the need to create one manually viaCreateVpcAssociationAuthorizationRequest.builder()- Parameters:
createVpcAssociationAuthorizationRequest- AConsumerthat will call methods onCreateVpcAssociationAuthorizationRequest.Builderto create a request. A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts.- Returns:
- A Java Future containing the result of the CreateVPCAssociationAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- TooManyVpcAssociationAuthorizationsException 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
DeleteVPCAssociationAuthorizationrequest to remove an existing authorization. To get a list of existing authorizations, submit aListVPCAssociationAuthorizationsrequest. - NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deactivateKeySigningKey
default CompletableFuture<DeactivateKeySigningKeyResponse> deactivateKeySigningKey(DeactivateKeySigningKeyRequest deactivateKeySigningKeyRequest) 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.- Parameters:
deactivateKeySigningKeyRequest-- Returns:
- A Java Future containing the result of the DeactivateKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchKeySigningKeyException The specified key-signing key (KSK) doesn't exist.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - KeySigningKeyInUseException 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.
- KeySigningKeyInParentDsRecordException The key-signing key (KSK) is specified in a parent DS record.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deactivateKeySigningKey
default CompletableFuture<DeactivateKeySigningKeyResponse> deactivateKeySigningKey(Consumer<DeactivateKeySigningKeyRequest.Builder> deactivateKeySigningKeyRequest) 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.
This is a convenience which creates an instance of the
DeactivateKeySigningKeyRequest.Builderavoiding the need to create one manually viaDeactivateKeySigningKeyRequest.builder()- Parameters:
deactivateKeySigningKeyRequest- AConsumerthat will call methods onDeactivateKeySigningKeyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeactivateKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchKeySigningKeyException The specified key-signing key (KSK) doesn't exist.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - KeySigningKeyInUseException 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.
- KeySigningKeyInParentDsRecordException The key-signing key (KSK) is specified in a parent DS record.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCidrCollection
default CompletableFuture<DeleteCidrCollectionResponse> deleteCidrCollection(DeleteCidrCollectionRequest deleteCidrCollectionRequest) Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.
- Parameters:
deleteCidrCollectionRequest-- Returns:
- A Java Future containing the result of the DeleteCidrCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- CidrCollectionInUseException This CIDR collection is in use, and isn't empty.
- InvalidInputException The input is not valid.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCidrCollection
default CompletableFuture<DeleteCidrCollectionResponse> deleteCidrCollection(Consumer<DeleteCidrCollectionRequest.Builder> deleteCidrCollectionRequest) Deletes a CIDR collection in the current Amazon Web Services account. The collection must be empty before it can be deleted.
This is a convenience which creates an instance of the
DeleteCidrCollectionRequest.Builderavoiding the need to create one manually viaDeleteCidrCollectionRequest.builder()- Parameters:
deleteCidrCollectionRequest- AConsumerthat will call methods onDeleteCidrCollectionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteCidrCollection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- CidrCollectionInUseException This CIDR collection is in use, and isn't empty.
- InvalidInputException The input is not valid.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHealthCheck
default CompletableFuture<DeleteHealthCheckResponse> deleteHealthCheck(DeleteHealthCheckRequest deleteHealthCheckRequest) Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
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
DeleteHealthCheckcommand 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.- Parameters:
deleteHealthCheckRequest- This action deletes a health check.- Returns:
- A Java Future containing the result of the DeleteHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHealthCheck
default CompletableFuture<DeleteHealthCheckResponse> deleteHealthCheck(Consumer<DeleteHealthCheckRequest.Builder> deleteHealthCheckRequest) Deletes a health check.
Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.
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
DeleteHealthCheckcommand 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.
This is a convenience which creates an instance of the
DeleteHealthCheckRequest.Builderavoiding the need to create one manually viaDeleteHealthCheckRequest.builder()- Parameters:
deleteHealthCheckRequest- AConsumerthat will call methods onDeleteHealthCheckRequest.Builderto create a request. This action deletes a health check.- Returns:
- A Java Future containing the result of the DeleteHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHostedZone
default CompletableFuture<DeleteHostedZoneResponse> deleteHostedZone(DeleteHostedZoneRequest deleteHostedZoneRequest) 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 delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name.
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
HostedZoneNotEmptyerror. 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
GetHostedZoneaction to request information about the hosted zone. -
Use the
ListHostedZonesaction to get a list of the hosted zones associated with the current Amazon Web Services account.
- Parameters:
deleteHostedZoneRequest- A request to delete a hosted zone.- Returns:
- A Java Future containing the result of the DeleteHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- HostedZoneNotEmptyException The hosted zone contains resource records that are not SOA or NS records.
- PriorRequestNotCompleteException 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. - InvalidInputException The input is not valid.
- InvalidDomainNameException The specified domain name is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteHostedZone
default CompletableFuture<DeleteHostedZoneResponse> deleteHostedZone(Consumer<DeleteHostedZoneRequest.Builder> deleteHostedZoneRequest) 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 delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name.
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
HostedZoneNotEmptyerror. 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
GetHostedZoneaction to request information about the hosted zone. -
Use the
ListHostedZonesaction to get a list of the hosted zones associated with the current Amazon Web Services account.
This is a convenience which creates an instance of the
DeleteHostedZoneRequest.Builderavoiding the need to create one manually viaDeleteHostedZoneRequest.builder()- Parameters:
deleteHostedZoneRequest- AConsumerthat will call methods onDeleteHostedZoneRequest.Builderto create a request. A request to delete a hosted zone.- Returns:
- A Java Future containing the result of the DeleteHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- HostedZoneNotEmptyException The hosted zone contains resource records that are not SOA or NS records.
- PriorRequestNotCompleteException 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. - InvalidInputException The input is not valid.
- InvalidDomainNameException The specified domain name is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteKeySigningKey
default CompletableFuture<DeleteKeySigningKeyResponse> deleteKeySigningKey(DeleteKeySigningKeyRequest deleteKeySigningKeyRequest) 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
INACTIVEstatus.- Parameters:
deleteKeySigningKeyRequest-- Returns:
- A Java Future containing the result of the DeleteKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchKeySigningKeyException The specified key-signing key (KSK) doesn't exist.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKeySigningKey
default CompletableFuture<DeleteKeySigningKeyResponse> deleteKeySigningKey(Consumer<DeleteKeySigningKeyRequest.Builder> deleteKeySigningKeyRequest) 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
INACTIVEstatus.
This is a convenience which creates an instance of the
DeleteKeySigningKeyRequest.Builderavoiding the need to create one manually viaDeleteKeySigningKeyRequest.builder()- Parameters:
deleteKeySigningKeyRequest- AConsumerthat will call methods onDeleteKeySigningKeyRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteKeySigningKey operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchKeySigningKeyException The specified key-signing key (KSK) doesn't exist.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidSigningStatusException Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable
DNSSECor disableDNSSEC. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteQueryLoggingConfig
default CompletableFuture<DeleteQueryLoggingConfigResponse> deleteQueryLoggingConfig(DeleteQueryLoggingConfigRequest deleteQueryLoggingConfigRequest) 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.
- Parameters:
deleteQueryLoggingConfigRequest-- Returns:
- A Java Future containing the result of the DeleteQueryLoggingConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchQueryLoggingConfigException There is no DNS query logging configuration with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteQueryLoggingConfig
default CompletableFuture<DeleteQueryLoggingConfigResponse> deleteQueryLoggingConfig(Consumer<DeleteQueryLoggingConfigRequest.Builder> deleteQueryLoggingConfigRequest) 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.
This is a convenience which creates an instance of the
DeleteQueryLoggingConfigRequest.Builderavoiding the need to create one manually viaDeleteQueryLoggingConfigRequest.builder()- Parameters:
deleteQueryLoggingConfigRequest- AConsumerthat will call methods onDeleteQueryLoggingConfigRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteQueryLoggingConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- NoSuchQueryLoggingConfigException There is no DNS query logging configuration with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReusableDelegationSet
default CompletableFuture<DeleteReusableDelegationSetResponse> deleteReusableDelegationSet(DeleteReusableDelegationSetRequest deleteReusableDelegationSetRequest) Deletes a reusable delegation set.
You can delete a reusable delegation set only if it isn't associated with any hosted zones.
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.
- Parameters:
deleteReusableDelegationSetRequest- A request to delete a reusable delegation set.- Returns:
- A Java Future containing the result of the DeleteReusableDelegationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetInUseException The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteReusableDelegationSet
default CompletableFuture<DeleteReusableDelegationSetResponse> deleteReusableDelegationSet(Consumer<DeleteReusableDelegationSetRequest.Builder> deleteReusableDelegationSetRequest) Deletes a reusable delegation set.
You can delete a reusable delegation set only if it isn't associated with any hosted zones.
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.
This is a convenience which creates an instance of the
DeleteReusableDelegationSetRequest.Builderavoiding the need to create one manually viaDeleteReusableDelegationSetRequest.builder()- Parameters:
deleteReusableDelegationSetRequest- AConsumerthat will call methods onDeleteReusableDelegationSetRequest.Builderto create a request. A request to delete a reusable delegation set.- Returns:
- A Java Future containing the result of the DeleteReusableDelegationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetInUseException The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTrafficPolicy
default CompletableFuture<DeleteTrafficPolicyResponse> deleteTrafficPolicy(DeleteTrafficPolicyRequest deleteTrafficPolicyRequest) 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.
- Parameters:
deleteTrafficPolicyRequest- A request to delete a specified traffic policy version.- Returns:
- A Java Future containing the result of the DeleteTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- InvalidInputException The input is not valid.
- TrafficPolicyInUseException One or more traffic policy instances were created by using the specified traffic policy.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteTrafficPolicy
default CompletableFuture<DeleteTrafficPolicyResponse> deleteTrafficPolicy(Consumer<DeleteTrafficPolicyRequest.Builder> deleteTrafficPolicyRequest) 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.
This is a convenience which creates an instance of the
DeleteTrafficPolicyRequest.Builderavoiding the need to create one manually viaDeleteTrafficPolicyRequest.builder()- Parameters:
deleteTrafficPolicyRequest- AConsumerthat will call methods onDeleteTrafficPolicyRequest.Builderto create a request. A request to delete a specified traffic policy version.- Returns:
- A Java Future containing the result of the DeleteTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- InvalidInputException The input is not valid.
- TrafficPolicyInUseException One or more traffic policy instances were created by using the specified traffic policy.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteTrafficPolicyInstance
default CompletableFuture<DeleteTrafficPolicyInstanceResponse> deleteTrafficPolicyInstance(DeleteTrafficPolicyInstanceRequest deleteTrafficPolicyInstanceRequest) Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
In the Route 53 console, traffic policy instances are known as policy records.
- Parameters:
deleteTrafficPolicyInstanceRequest- A request to delete a specified traffic policy instance.- Returns:
- A Java Future containing the result of the DeleteTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- InvalidInputException The input is not valid.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTrafficPolicyInstance
default CompletableFuture<DeleteTrafficPolicyInstanceResponse> deleteTrafficPolicyInstance(Consumer<DeleteTrafficPolicyInstanceRequest.Builder> deleteTrafficPolicyInstanceRequest) Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.
In the Route 53 console, traffic policy instances are known as policy records.
This is a convenience which creates an instance of the
DeleteTrafficPolicyInstanceRequest.Builderavoiding the need to create one manually viaDeleteTrafficPolicyInstanceRequest.builder()- Parameters:
deleteTrafficPolicyInstanceRequest- AConsumerthat will call methods onDeleteTrafficPolicyInstanceRequest.Builderto create a request. A request to delete a specified traffic policy instance.- Returns:
- A Java Future containing the result of the DeleteTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- InvalidInputException The input is not valid.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVPCAssociationAuthorization
default CompletableFuture<DeleteVpcAssociationAuthorizationResponse> deleteVPCAssociationAuthorization(DeleteVpcAssociationAuthorizationRequest deleteVpcAssociationAuthorizationRequest) Removes authorization to submit an
AssociateVPCWithHostedZonerequest 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 aDeleteVPCAssociationAuthorizationrequest.Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone,
DeleteVPCAssociationAuthorizationwon't disassociate the VPC from the hosted zone. If you want to delete an existing association, useDisassociateVPCFromHostedZone.- Parameters:
deleteVpcAssociationAuthorizationRequest- A complex type that contains information about the request to remove authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account.- Returns:
- A Java Future containing the result of the DeleteVPCAssociationAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- VpcAssociationAuthorizationNotFoundException The VPC that you specified is not authorized to be associated with the hosted zone.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVPCAssociationAuthorization
default CompletableFuture<DeleteVpcAssociationAuthorizationResponse> deleteVPCAssociationAuthorization(Consumer<DeleteVpcAssociationAuthorizationRequest.Builder> deleteVpcAssociationAuthorizationRequest) Removes authorization to submit an
AssociateVPCWithHostedZonerequest 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 aDeleteVPCAssociationAuthorizationrequest.Sending this request only prevents the Amazon Web Services account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone,
DeleteVPCAssociationAuthorizationwon't disassociate the VPC from the hosted zone. If you want to delete an existing association, useDisassociateVPCFromHostedZone.
This is a convenience which creates an instance of the
DeleteVpcAssociationAuthorizationRequest.Builderavoiding the need to create one manually viaDeleteVpcAssociationAuthorizationRequest.builder()- Parameters:
deleteVpcAssociationAuthorizationRequest- AConsumerthat will call methods onDeleteVpcAssociationAuthorizationRequest.Builderto create a request. A complex type that contains information about the request to remove authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account.- Returns:
- A Java Future containing the result of the DeleteVPCAssociationAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- VpcAssociationAuthorizationNotFoundException The VPC that you specified is not authorized to be associated with the hosted zone.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableHostedZoneDNSSEC
default CompletableFuture<DisableHostedZoneDnssecResponse> disableHostedZoneDNSSEC(DisableHostedZoneDnssecRequest disableHostedZoneDnssecRequest) 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.
- Parameters:
disableHostedZoneDnssecRequest-- Returns:
- A Java Future containing the result of the DisableHostedZoneDNSSEC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- KeySigningKeyInParentDsRecordException The key-signing key (KSK) is specified in a parent DS record.
- DnssecNotFoundException The hosted zone doesn't have any DNSSEC resources.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableHostedZoneDNSSEC
default CompletableFuture<DisableHostedZoneDnssecResponse> disableHostedZoneDNSSEC(Consumer<DisableHostedZoneDnssecRequest.Builder> disableHostedZoneDnssecRequest) 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.
This is a convenience which creates an instance of the
DisableHostedZoneDnssecRequest.Builderavoiding the need to create one manually viaDisableHostedZoneDnssecRequest.builder()- Parameters:
disableHostedZoneDnssecRequest- AConsumerthat will call methods onDisableHostedZoneDnssecRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisableHostedZoneDNSSEC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- KeySigningKeyInParentDsRecordException The key-signing key (KSK) is specified in a parent DS record.
- DnssecNotFoundException The hosted zone doesn't have any DNSSEC resources.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateVPCFromHostedZone
default CompletableFuture<DisassociateVpcFromHostedZoneResponse> disassociateVPCFromHostedZone(DisassociateVpcFromHostedZoneRequest disassociateVpcFromHostedZoneRequest) 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
DisassociateVPCFromHostedZonerequest 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 useDisassociateVPCFromHostedZone. If the hosted zone has a value forOwningService, you can't useDisassociateVPCFromHostedZone.
When revoking access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
- Parameters:
disassociateVpcFromHostedZoneRequest- A complex type that contains information about the VPC that you want to disassociate from a specified private hosted zone.- Returns:
- A Java Future containing the result of the DisassociateVPCFromHostedZone operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- VpcAssociationNotFoundException The specified VPC and hosted zone are not currently associated.
- LastVpcAssociationException 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.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
disassociateVPCFromHostedZone
default CompletableFuture<DisassociateVpcFromHostedZoneResponse> disassociateVPCFromHostedZone(Consumer<DisassociateVpcFromHostedZoneRequest.Builder> disassociateVpcFromHostedZoneRequest) 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
DisassociateVPCFromHostedZonerequest 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 useDisassociateVPCFromHostedZone. If the hosted zone has a value forOwningService, you can't useDisassociateVPCFromHostedZone.
When revoking access, the hosted zone and the Amazon VPC must belong to the same partition. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
This is a convenience which creates an instance of the
DisassociateVpcFromHostedZoneRequest.Builderavoiding the need to create one manually viaDisassociateVpcFromHostedZoneRequest.builder()- Parameters:
disassociateVpcFromHostedZoneRequest- AConsumerthat will call methods onDisassociateVpcFromHostedZoneRequest.Builderto create a request. A complex type that contains information about the VPC that you want to disassociate from a specified private hosted zone.- Returns:
- A Java Future containing the result of the DisassociateVPCFromHostedZone operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidVpcIdException The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
- VpcAssociationNotFoundException The specified VPC and hosted zone are not currently associated.
- LastVpcAssociationException 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.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
enableHostedZoneDNSSEC
default CompletableFuture<EnableHostedZoneDnssecResponse> enableHostedZoneDNSSEC(EnableHostedZoneDnssecRequest enableHostedZoneDnssecRequest) Enables DNSSEC signing in a specific hosted zone.
- Parameters:
enableHostedZoneDnssecRequest-- Returns:
- A Java Future containing the result of the EnableHostedZoneDNSSEC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- KeySigningKeyWithActiveStatusNotFoundException A key-signing key (KSK) with
ACTIVEstatus wasn't found. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- HostedZonePartiallyDelegatedException The hosted zone nameservers don't match the parent nameservers. The hosted zone and parent must have the same nameservers.
- DnssecNotFoundException The hosted zone doesn't have any DNSSEC resources.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableHostedZoneDNSSEC
default CompletableFuture<EnableHostedZoneDnssecResponse> enableHostedZoneDNSSEC(Consumer<EnableHostedZoneDnssecRequest.Builder> enableHostedZoneDnssecRequest) Enables DNSSEC signing in a specific hosted zone.
This is a convenience which creates an instance of the
EnableHostedZoneDnssecRequest.Builderavoiding the need to create one manually viaEnableHostedZoneDnssecRequest.builder()- Parameters:
enableHostedZoneDnssecRequest- AConsumerthat will call methods onEnableHostedZoneDnssecRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the EnableHostedZoneDNSSEC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- KeySigningKeyWithActiveStatusNotFoundException A key-signing key (KSK) with
ACTIVEstatus wasn't found. - InvalidKmsArnException The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
- HostedZonePartiallyDelegatedException The hosted zone nameservers don't match the parent nameservers. The hosted zone and parent must have the same nameservers.
- DnssecNotFoundException The hosted zone doesn't have any DNSSEC resources.
- InvalidKeySigningKeyStatusException The key-signing key (KSK) status isn't valid or another KSK has
the status
INTERNAL_FAILURE. - InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountLimit
default CompletableFuture<GetAccountLimitResponse> getAccountLimit(GetAccountLimitRequest getAccountLimitRequest) 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.
You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.
- Parameters:
getAccountLimitRequest- A complex type that contains information about the request to create a hosted zone.- Returns:
- A Java Future containing the result of the GetAccountLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccountLimit
default CompletableFuture<GetAccountLimitResponse> getAccountLimit(Consumer<GetAccountLimitRequest.Builder> getAccountLimitRequest) 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.
You can also view account limits in Amazon Web Services Trusted Advisor. Sign in to the Amazon Web Services Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.
This is a convenience which creates an instance of the
GetAccountLimitRequest.Builderavoiding the need to create one manually viaGetAccountLimitRequest.builder()- Parameters:
getAccountLimitRequest- AConsumerthat will call methods onGetAccountLimitRequest.Builderto create a request. A complex type that contains information about the request to create a hosted zone.- Returns:
- A Java Future containing the result of the GetAccountLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChange
Returns the current status of a change batch request. The status is one of the following values:
-
PENDINGindicates 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. -
INSYNCindicates that the changes have propagated to all Route 53 DNS servers managing the hosted zone.
- Parameters:
getChangeRequest- The input for a GetChange request.- Returns:
- A Java Future containing the result of the GetChange operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchChangeException A change with the specified change ID does not exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getChange
default CompletableFuture<GetChangeResponse> getChange(Consumer<GetChangeRequest.Builder> getChangeRequest) Returns the current status of a change batch request. The status is one of the following values:
-
PENDINGindicates 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. -
INSYNCindicates that the changes have propagated to all Route 53 DNS servers managing the hosted zone.
This is a convenience which creates an instance of the
GetChangeRequest.Builderavoiding the need to create one manually viaGetChangeRequest.builder()- Parameters:
getChangeRequest- AConsumerthat will call methods onGetChangeRequest.Builderto create a request. The input for a GetChange request.- Returns:
- A Java Future containing the result of the GetChange operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchChangeException A change with the specified change ID does not exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getCheckerIpRanges
default CompletableFuture<GetCheckerIpRangesResponse> getCheckerIpRanges(GetCheckerIpRangesRequest getCheckerIpRangesRequest) Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRangesstill works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.- Parameters:
getCheckerIpRangesRequest- Empty request.- Returns:
- A Java Future containing the result of the GetCheckerIpRanges operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCheckerIpRanges
default CompletableFuture<GetCheckerIpRangesResponse> getCheckerIpRanges(Consumer<GetCheckerIpRangesRequest.Builder> getCheckerIpRangesRequest) Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRangesstill works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.
This is a convenience which creates an instance of the
GetCheckerIpRangesRequest.Builderavoiding the need to create one manually viaGetCheckerIpRangesRequest.builder()- Parameters:
getCheckerIpRangesRequest- AConsumerthat will call methods onGetCheckerIpRangesRequest.Builderto create a request. Empty request.- Returns:
- A Java Future containing the result of the GetCheckerIpRanges operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCheckerIpRanges
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
GetCheckerIpRangesstill works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all Amazon Web Services services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.- Returns:
- A Java Future containing the result of the GetCheckerIpRanges operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDNSSEC
Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
- Parameters:
getDnssecRequest-- Returns:
- A Java Future containing the result of the GetDNSSEC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDNSSEC
default CompletableFuture<GetDnssecResponse> getDNSSEC(Consumer<GetDnssecRequest.Builder> getDnssecRequest) Returns information about DNSSEC for a specific hosted zone, including the key-signing keys (KSKs) in the hosted zone.
This is a convenience which creates an instance of the
GetDnssecRequest.Builderavoiding the need to create one manually viaGetDnssecRequest.builder()- Parameters:
getDnssecRequest- AConsumerthat will call methods onGetDnssecRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDNSSEC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidArgumentException Parameter name is not valid.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeoLocation
default CompletableFuture<GetGeoLocationResponse> getGeoLocation(GetGeoLocationRequest getGeoLocationRequest) 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 continentUse the following syntax to determine whether a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country codeUse 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- Parameters:
getGeoLocationRequest- A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.- Returns:
- A Java Future containing the result of the GetGeoLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchGeoLocationException Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the GeoLocation data type.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeoLocation
default CompletableFuture<GetGeoLocationResponse> getGeoLocation(Consumer<GetGeoLocationRequest.Builder> getGeoLocationRequest) 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 continentUse the following syntax to determine whether a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country codeUse 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
This is a convenience which creates an instance of the
GetGeoLocationRequest.Builderavoiding the need to create one manually viaGetGeoLocationRequest.builder()- Parameters:
getGeoLocationRequest- AConsumerthat will call methods onGetGeoLocationRequest.Builderto create a request. A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.- Returns:
- A Java Future containing the result of the GetGeoLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchGeoLocationException Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the GeoLocation data type.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGeoLocation
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 continentUse the following syntax to determine whether a country is supported for geolocation:
GET /2013-04-01/geolocation?countrycode=two-character country codeUse 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- Returns:
- A Java Future containing the result of the GetGeoLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchGeoLocationException Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the GeoLocation data type.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheck
default CompletableFuture<GetHealthCheckResponse> getHealthCheck(GetHealthCheckRequest getHealthCheckRequest) Gets information about a specified health check.
- Parameters:
getHealthCheckRequest- A request to get information about a specified health check.- Returns:
- A Java Future containing the result of the GetHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheck
default CompletableFuture<GetHealthCheckResponse> getHealthCheck(Consumer<GetHealthCheckRequest.Builder> getHealthCheckRequest) Gets information about a specified health check.
This is a convenience which creates an instance of the
GetHealthCheckRequest.Builderavoiding the need to create one manually viaGetHealthCheckRequest.builder()- Parameters:
getHealthCheckRequest- AConsumerthat will call methods onGetHealthCheckRequest.Builderto create a request. A request to get information about a specified health check.- Returns:
- A Java Future containing the result of the GetHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheckCount
default CompletableFuture<GetHealthCheckCountResponse> getHealthCheckCount(GetHealthCheckCountRequest getHealthCheckCountRequest) Retrieves the number of health checks that are associated with the current Amazon Web Services account.
- Parameters:
getHealthCheckCountRequest- A request for the number of health checks that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the GetHealthCheckCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheckCount
default CompletableFuture<GetHealthCheckCountResponse> getHealthCheckCount(Consumer<GetHealthCheckCountRequest.Builder> getHealthCheckCountRequest) Retrieves the number of health checks that are associated with the current Amazon Web Services account.
This is a convenience which creates an instance of the
GetHealthCheckCountRequest.Builderavoiding the need to create one manually viaGetHealthCheckCountRequest.builder()- Parameters:
getHealthCheckCountRequest- AConsumerthat will call methods onGetHealthCheckCountRequest.Builderto create a request. A request for the number of health checks that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the GetHealthCheckCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheckCount
Retrieves the number of health checks that are associated with the current Amazon Web Services account.
- Returns:
- A Java Future containing the result of the GetHealthCheckCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheckLastFailureReason
default CompletableFuture<GetHealthCheckLastFailureReasonResponse> getHealthCheckLastFailureReason(GetHealthCheckLastFailureReasonRequest getHealthCheckLastFailureReasonRequest) Gets the reason that a specified health check failed most recently.
- Parameters:
getHealthCheckLastFailureReasonRequest- A request for the reason that a health check failed most recently.- Returns:
- A Java Future containing the result of the GetHealthCheckLastFailureReason operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheckLastFailureReason
default CompletableFuture<GetHealthCheckLastFailureReasonResponse> getHealthCheckLastFailureReason(Consumer<GetHealthCheckLastFailureReasonRequest.Builder> getHealthCheckLastFailureReasonRequest) Gets the reason that a specified health check failed most recently.
This is a convenience which creates an instance of the
GetHealthCheckLastFailureReasonRequest.Builderavoiding the need to create one manually viaGetHealthCheckLastFailureReasonRequest.builder()- Parameters:
getHealthCheckLastFailureReasonRequest- AConsumerthat will call methods onGetHealthCheckLastFailureReasonRequest.Builderto create a request. A request for the reason that a health check failed most recently.- Returns:
- A Java Future containing the result of the GetHealthCheckLastFailureReason operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheckStatus
default CompletableFuture<GetHealthCheckStatusResponse> getHealthCheckStatus(GetHealthCheckStatusRequest getHealthCheckStatusRequest) Gets status of a specified health check.
This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.
- Parameters:
getHealthCheckStatusRequest- A request to get the status for a health check.- Returns:
- A Java Future containing the result of the GetHealthCheckStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHealthCheckStatus
default CompletableFuture<GetHealthCheckStatusResponse> getHealthCheckStatus(Consumer<GetHealthCheckStatusRequest.Builder> getHealthCheckStatusRequest) Gets status of a specified health check.
This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.
This is a convenience which creates an instance of the
GetHealthCheckStatusRequest.Builderavoiding the need to create one manually viaGetHealthCheckStatusRequest.builder()- Parameters:
getHealthCheckStatusRequest- AConsumerthat will call methods onGetHealthCheckStatusRequest.Builderto create a request. A request to get the status for a health check.- Returns:
- A Java Future containing the result of the GetHealthCheckStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedZone
default CompletableFuture<GetHostedZoneResponse> getHostedZone(GetHostedZoneRequest getHostedZoneRequest) 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.- Parameters:
getHostedZoneRequest- A request to get information about a specified hosted zone.- Returns:
- A Java Future containing the result of the GetHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedZone
default CompletableFuture<GetHostedZoneResponse> getHostedZone(Consumer<GetHostedZoneRequest.Builder> getHostedZoneRequest) 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.
This is a convenience which creates an instance of the
GetHostedZoneRequest.Builderavoiding the need to create one manually viaGetHostedZoneRequest.builder()- Parameters:
getHostedZoneRequest- AConsumerthat will call methods onGetHostedZoneRequest.Builderto create a request. A request to get information about a specified hosted zone.- Returns:
- A Java Future containing the result of the GetHostedZone operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedZoneCount
default CompletableFuture<GetHostedZoneCountResponse> getHostedZoneCount(GetHostedZoneCountRequest getHostedZoneCountRequest) Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
- Parameters:
getHostedZoneCountRequest- A request to retrieve a count of all the hosted zones that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the GetHostedZoneCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedZoneCount
default CompletableFuture<GetHostedZoneCountResponse> getHostedZoneCount(Consumer<GetHostedZoneCountRequest.Builder> getHostedZoneCountRequest) Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
This is a convenience which creates an instance of the
GetHostedZoneCountRequest.Builderavoiding the need to create one manually viaGetHostedZoneCountRequest.builder()- Parameters:
getHostedZoneCountRequest- AConsumerthat will call methods onGetHostedZoneCountRequest.Builderto create a request. A request to retrieve a count of all the hosted zones that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the GetHostedZoneCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedZoneCount
Retrieves the number of hosted zones that are associated with the current Amazon Web Services account.
- Returns:
- A Java Future containing the result of the GetHostedZoneCount operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedZoneLimit
default CompletableFuture<GetHostedZoneLimitResponse> getHostedZoneLimit(GetHostedZoneLimitRequest getHostedZoneLimitRequest) Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
- Parameters:
getHostedZoneLimitRequest- A complex type that contains information about the request to create a hosted zone.- Returns:
- A Java Future containing the result of the GetHostedZoneLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- HostedZoneNotPrivateException The specified hosted zone is a public hosted zone, not a private hosted zone.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getHostedZoneLimit
default CompletableFuture<GetHostedZoneLimitResponse> getHostedZoneLimit(Consumer<GetHostedZoneLimitRequest.Builder> getHostedZoneLimitRequest) Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
This is a convenience which creates an instance of the
GetHostedZoneLimitRequest.Builderavoiding the need to create one manually viaGetHostedZoneLimitRequest.builder()- Parameters:
getHostedZoneLimitRequest- AConsumerthat will call methods onGetHostedZoneLimitRequest.Builderto create a request. A complex type that contains information about the request to create a hosted zone.- Returns:
- A Java Future containing the result of the GetHostedZoneLimit operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- HostedZoneNotPrivateException The specified hosted zone is a public hosted zone, not a private hosted zone.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryLoggingConfig
default CompletableFuture<GetQueryLoggingConfigResponse> getQueryLoggingConfig(GetQueryLoggingConfigRequest getQueryLoggingConfigRequest) Gets information about a specified configuration for DNS query logging.
For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.
- Parameters:
getQueryLoggingConfigRequest-- Returns:
- A Java Future containing the result of the GetQueryLoggingConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchQueryLoggingConfigException There is no DNS query logging configuration with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQueryLoggingConfig
default CompletableFuture<GetQueryLoggingConfigResponse> getQueryLoggingConfig(Consumer<GetQueryLoggingConfigRequest.Builder> getQueryLoggingConfigRequest) Gets information about a specified configuration for DNS query logging.
For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.
This is a convenience which creates an instance of the
GetQueryLoggingConfigRequest.Builderavoiding the need to create one manually viaGetQueryLoggingConfigRequest.builder()- Parameters:
getQueryLoggingConfigRequest- AConsumerthat will call methods onGetQueryLoggingConfigRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetQueryLoggingConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchQueryLoggingConfigException There is no DNS query logging configuration with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReusableDelegationSet
default CompletableFuture<GetReusableDelegationSetResponse> getReusableDelegationSet(GetReusableDelegationSetRequest getReusableDelegationSetRequest) Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
- Parameters:
getReusableDelegationSetRequest- A request to get information about a specified reusable delegation set.- Returns:
- A Java Future containing the result of the GetReusableDelegationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReusableDelegationSet
default CompletableFuture<GetReusableDelegationSetResponse> getReusableDelegationSet(Consumer<GetReusableDelegationSetRequest.Builder> getReusableDelegationSetRequest) Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.
This is a convenience which creates an instance of the
GetReusableDelegationSetRequest.Builderavoiding the need to create one manually viaGetReusableDelegationSetRequest.builder()- Parameters:
getReusableDelegationSetRequest- AConsumerthat will call methods onGetReusableDelegationSetRequest.Builderto create a request. A request to get information about a specified reusable delegation set.- Returns:
- A Java Future containing the result of the GetReusableDelegationSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReusableDelegationSetLimit
default CompletableFuture<GetReusableDelegationSetLimitResponse> getReusableDelegationSetLimit(GetReusableDelegationSetLimitRequest getReusableDelegationSetLimitRequest) Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
- Parameters:
getReusableDelegationSetLimitRequest- A complex type that contains information about the request to create a hosted zone.- Returns:
- A Java Future containing the result of the GetReusableDelegationSetLimit operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getReusableDelegationSetLimit
default CompletableFuture<GetReusableDelegationSetLimitResponse> getReusableDelegationSetLimit(Consumer<GetReusableDelegationSetLimitRequest.Builder> getReusableDelegationSetLimitRequest) Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.
For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.
This is a convenience which creates an instance of the
GetReusableDelegationSetLimitRequest.Builderavoiding the need to create one manually viaGetReusableDelegationSetLimitRequest.builder()- Parameters:
getReusableDelegationSetLimitRequest- AConsumerthat will call methods onGetReusableDelegationSetLimitRequest.Builderto create a request. A complex type that contains information about the request to create a hosted zone.- Returns:
- A Java Future containing the result of the GetReusableDelegationSetLimit operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicy
default CompletableFuture<GetTrafficPolicyResponse> getTrafficPolicy(GetTrafficPolicyRequest getTrafficPolicyRequest) Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the response from
GetTrafficPolicy, see DeleteTrafficPolicy .- Parameters:
getTrafficPolicyRequest- Gets information about a specific traffic policy version.- Returns:
- A Java Future containing the result of the GetTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicy
default CompletableFuture<GetTrafficPolicyResponse> getTrafficPolicy(Consumer<GetTrafficPolicyRequest.Builder> getTrafficPolicyRequest) Gets information about a specific traffic policy version.
For information about how of deleting a traffic policy affects the response from
GetTrafficPolicy, see DeleteTrafficPolicy .
This is a convenience which creates an instance of the
GetTrafficPolicyRequest.Builderavoiding the need to create one manually viaGetTrafficPolicyRequest.builder()- Parameters:
getTrafficPolicyRequest- AConsumerthat will call methods onGetTrafficPolicyRequest.Builderto create a request. Gets information about a specific traffic policy version.- Returns:
- A Java Future containing the result of the GetTrafficPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicyInstance
default CompletableFuture<GetTrafficPolicyInstanceResponse> getTrafficPolicyInstance(GetTrafficPolicyInstanceRequest getTrafficPolicyInstanceRequest) Gets information about a specified traffic policy instance.
Use
GetTrafficPolicyInstancewith theidof new traffic policy instance to confirm that theCreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest completed successfully. For more information, see theStateresponse element.In the Route 53 console, traffic policy instances are known as policy records.
- Parameters:
getTrafficPolicyInstanceRequest- Gets information about a specified traffic policy instance.- Returns:
- A Java Future containing the result of the GetTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicyInstance
default CompletableFuture<GetTrafficPolicyInstanceResponse> getTrafficPolicyInstance(Consumer<GetTrafficPolicyInstanceRequest.Builder> getTrafficPolicyInstanceRequest) Gets information about a specified traffic policy instance.
Use
GetTrafficPolicyInstancewith theidof new traffic policy instance to confirm that theCreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest completed successfully. For more information, see theStateresponse element.In the Route 53 console, traffic policy instances are known as policy records.
This is a convenience which creates an instance of the
GetTrafficPolicyInstanceRequest.Builderavoiding the need to create one manually viaGetTrafficPolicyInstanceRequest.builder()- Parameters:
getTrafficPolicyInstanceRequest- AConsumerthat will call methods onGetTrafficPolicyInstanceRequest.Builderto create a request. Gets information about a specified traffic policy instance.- Returns:
- A Java Future containing the result of the GetTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicyInstanceCount
default CompletableFuture<GetTrafficPolicyInstanceCountResponse> getTrafficPolicyInstanceCount(GetTrafficPolicyInstanceCountRequest getTrafficPolicyInstanceCountRequest) Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
- Parameters:
getTrafficPolicyInstanceCountRequest- Request to get the number of traffic policy instances that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the GetTrafficPolicyInstanceCount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicyInstanceCount
default CompletableFuture<GetTrafficPolicyInstanceCountResponse> getTrafficPolicyInstanceCount(Consumer<GetTrafficPolicyInstanceCountRequest.Builder> getTrafficPolicyInstanceCountRequest) Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
This is a convenience which creates an instance of the
GetTrafficPolicyInstanceCountRequest.Builderavoiding the need to create one manually viaGetTrafficPolicyInstanceCountRequest.builder()- Parameters:
getTrafficPolicyInstanceCountRequest- AConsumerthat will call methods onGetTrafficPolicyInstanceCountRequest.Builderto create a request. Request to get the number of traffic policy instances that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the GetTrafficPolicyInstanceCount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTrafficPolicyInstanceCount
Gets the number of traffic policy instances that are associated with the current Amazon Web Services account.
- Returns:
- A Java Future containing the result of the GetTrafficPolicyInstanceCount operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrBlocks
default CompletableFuture<ListCidrBlocksResponse> listCidrBlocks(ListCidrBlocksRequest listCidrBlocksRequest) Returns a paginated list of location objects and their CIDR blocks.
- Parameters:
listCidrBlocksRequest-- Returns:
- A Java Future containing the result of the ListCidrBlocks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- NoSuchCidrLocationException The CIDR collection location doesn't match any locations in your account.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrBlocks
default CompletableFuture<ListCidrBlocksResponse> listCidrBlocks(Consumer<ListCidrBlocksRequest.Builder> listCidrBlocksRequest) Returns a paginated list of location objects and their CIDR blocks.
This is a convenience which creates an instance of the
ListCidrBlocksRequest.Builderavoiding the need to create one manually viaListCidrBlocksRequest.builder()- Parameters:
listCidrBlocksRequest- AConsumerthat will call methods onListCidrBlocksRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCidrBlocks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- NoSuchCidrLocationException The CIDR collection location doesn't match any locations in your account.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrBlocksPaginator
default ListCidrBlocksPublisher listCidrBlocksPaginator(ListCidrBlocksRequest listCidrBlocksRequest) This is a variant of
listCidrBlocks(software.amazon.awssdk.services.route53.model.ListCidrBlocksRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListCidrBlocksPublisher publisher = client.listCidrBlocksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListCidrBlocksPublisher publisher = client.listCidrBlocksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListCidrBlocksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListCidrBlocksResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCidrBlocks(software.amazon.awssdk.services.route53.model.ListCidrBlocksRequest)operation.- Parameters:
listCidrBlocksRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- NoSuchCidrLocationException The CIDR collection location doesn't match any locations in your account.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrBlocksPaginator
default ListCidrBlocksPublisher listCidrBlocksPaginator(Consumer<ListCidrBlocksRequest.Builder> listCidrBlocksRequest) This is a variant of
listCidrBlocks(software.amazon.awssdk.services.route53.model.ListCidrBlocksRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListCidrBlocksPublisher publisher = client.listCidrBlocksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListCidrBlocksPublisher publisher = client.listCidrBlocksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListCidrBlocksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListCidrBlocksResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCidrBlocks(software.amazon.awssdk.services.route53.model.ListCidrBlocksRequest)operation.
This is a convenience which creates an instance of the
ListCidrBlocksRequest.Builderavoiding the need to create one manually viaListCidrBlocksRequest.builder()- Parameters:
listCidrBlocksRequest- AConsumerthat will call methods onListCidrBlocksRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- NoSuchCidrLocationException The CIDR collection location doesn't match any locations in your account.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrCollections
default CompletableFuture<ListCidrCollectionsResponse> listCidrCollections(ListCidrCollectionsRequest listCidrCollectionsRequest) Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
- Parameters:
listCidrCollectionsRequest-- Returns:
- A Java Future containing the result of the ListCidrCollections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrCollections
default CompletableFuture<ListCidrCollectionsResponse> listCidrCollections(Consumer<ListCidrCollectionsRequest.Builder> listCidrCollectionsRequest) Returns a paginated list of CIDR collections in the Amazon Web Services account (metadata only).
This is a convenience which creates an instance of the
ListCidrCollectionsRequest.Builderavoiding the need to create one manually viaListCidrCollectionsRequest.builder()- Parameters:
listCidrCollectionsRequest- AConsumerthat will call methods onListCidrCollectionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCidrCollections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrCollectionsPaginator
default ListCidrCollectionsPublisher listCidrCollectionsPaginator(ListCidrCollectionsRequest listCidrCollectionsRequest) This is a variant of
listCidrCollections(software.amazon.awssdk.services.route53.model.ListCidrCollectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListCidrCollectionsPublisher publisher = client.listCidrCollectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListCidrCollectionsPublisher publisher = client.listCidrCollectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListCidrCollectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListCidrCollectionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCidrCollections(software.amazon.awssdk.services.route53.model.ListCidrCollectionsRequest)operation.- Parameters:
listCidrCollectionsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrCollectionsPaginator
default ListCidrCollectionsPublisher listCidrCollectionsPaginator(Consumer<ListCidrCollectionsRequest.Builder> listCidrCollectionsRequest) This is a variant of
listCidrCollections(software.amazon.awssdk.services.route53.model.ListCidrCollectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListCidrCollectionsPublisher publisher = client.listCidrCollectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListCidrCollectionsPublisher publisher = client.listCidrCollectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListCidrCollectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListCidrCollectionsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCidrCollections(software.amazon.awssdk.services.route53.model.ListCidrCollectionsRequest)operation.
This is a convenience which creates an instance of the
ListCidrCollectionsRequest.Builderavoiding the need to create one manually viaListCidrCollectionsRequest.builder()- Parameters:
listCidrCollectionsRequest- AConsumerthat will call methods onListCidrCollectionsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrLocations
default CompletableFuture<ListCidrLocationsResponse> listCidrLocations(ListCidrLocationsRequest listCidrLocationsRequest) Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
- Parameters:
listCidrLocationsRequest-- Returns:
- A Java Future containing the result of the ListCidrLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrLocations
default CompletableFuture<ListCidrLocationsResponse> listCidrLocations(Consumer<ListCidrLocationsRequest.Builder> listCidrLocationsRequest) Returns a paginated list of CIDR locations for the given collection (metadata only, does not include CIDR blocks).
This is a convenience which creates an instance of the
ListCidrLocationsRequest.Builderavoiding the need to create one manually viaListCidrLocationsRequest.builder()- Parameters:
listCidrLocationsRequest- AConsumerthat will call methods onListCidrLocationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListCidrLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrLocationsPaginator
default ListCidrLocationsPublisher listCidrLocationsPaginator(ListCidrLocationsRequest listCidrLocationsRequest) This is a variant of
listCidrLocations(software.amazon.awssdk.services.route53.model.ListCidrLocationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListCidrLocationsPublisher publisher = client.listCidrLocationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListCidrLocationsPublisher publisher = client.listCidrLocationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListCidrLocationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListCidrLocationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCidrLocations(software.amazon.awssdk.services.route53.model.ListCidrLocationsRequest)operation.- Parameters:
listCidrLocationsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCidrLocationsPaginator
default ListCidrLocationsPublisher listCidrLocationsPaginator(Consumer<ListCidrLocationsRequest.Builder> listCidrLocationsRequest) This is a variant of
listCidrLocations(software.amazon.awssdk.services.route53.model.ListCidrLocationsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListCidrLocationsPublisher publisher = client.listCidrLocationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListCidrLocationsPublisher publisher = client.listCidrLocationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListCidrLocationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListCidrLocationsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCidrLocations(software.amazon.awssdk.services.route53.model.ListCidrLocationsRequest)operation.
This is a convenience which creates an instance of the
ListCidrLocationsRequest.Builderavoiding the need to create one manually viaListCidrLocationsRequest.builder()- Parameters:
listCidrLocationsRequest- AConsumerthat will call methods onListCidrLocationsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchCidrCollectionException The CIDR collection you specified, doesn't exist.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeoLocations
default CompletableFuture<ListGeoLocationsResponse> listGeoLocations(ListGeoLocationsRequest listGeoLocationsRequest) Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
For a list of supported geolocation codes, see the GeoLocation data type.
- Parameters:
listGeoLocationsRequest- A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.- Returns:
- A Java Future containing the result of the ListGeoLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeoLocations
default CompletableFuture<ListGeoLocationsResponse> listGeoLocations(Consumer<ListGeoLocationsRequest.Builder> listGeoLocationsRequest) Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
For a list of supported geolocation codes, see the GeoLocation data type.
This is a convenience which creates an instance of the
ListGeoLocationsRequest.Builderavoiding the need to create one manually viaListGeoLocationsRequest.builder()- Parameters:
listGeoLocationsRequest- AConsumerthat will call methods onListGeoLocationsRequest.Builderto create a request. A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.- Returns:
- A Java Future containing the result of the ListGeoLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGeoLocations
Retrieves a list of supported geographic locations.
Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.
Route 53 does not perform authorization for this API because it retrieves information that is already available to the public.
For a list of supported geolocation codes, see the GeoLocation data type.
- Returns:
- A Java Future containing the result of the ListGeoLocations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHealthChecks
default CompletableFuture<ListHealthChecksResponse> listHealthChecks(ListHealthChecksRequest listHealthChecksRequest) Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
- Parameters:
listHealthChecksRequest- A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListHealthChecks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHealthChecks
default CompletableFuture<ListHealthChecksResponse> listHealthChecks(Consumer<ListHealthChecksRequest.Builder> listHealthChecksRequest) Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListHealthChecksRequest.Builderavoiding the need to create one manually viaListHealthChecksRequest.builder()- Parameters:
listHealthChecksRequest- AConsumerthat will call methods onListHealthChecksRequest.Builderto create a request. A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListHealthChecks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHealthChecks
Retrieve a list of the health checks that are associated with the current Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListHealthChecks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHealthChecksPaginator
This is a variant of
listHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListHealthChecksPublisher publisher = client.listHealthChecksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListHealthChecksPublisher publisher = client.listHealthChecksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListHealthChecksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListHealthChecksResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHealthChecksPaginator
default ListHealthChecksPublisher listHealthChecksPaginator(ListHealthChecksRequest listHealthChecksRequest) This is a variant of
listHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListHealthChecksPublisher publisher = client.listHealthChecksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListHealthChecksPublisher publisher = client.listHealthChecksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListHealthChecksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListHealthChecksResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation.- Parameters:
listHealthChecksRequest- A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHealthChecksPaginator
default ListHealthChecksPublisher listHealthChecksPaginator(Consumer<ListHealthChecksRequest.Builder> listHealthChecksRequest) This is a variant of
listHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListHealthChecksPublisher publisher = client.listHealthChecksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListHealthChecksPublisher publisher = client.listHealthChecksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListHealthChecksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListHealthChecksResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHealthChecks(software.amazon.awssdk.services.route53.model.ListHealthChecksRequest)operation.
This is a convenience which creates an instance of the
ListHealthChecksRequest.Builderavoiding the need to create one manually viaListHealthChecksRequest.builder()- Parameters:
listHealthChecksRequest- AConsumerthat will call methods onListHealthChecksRequest.Builderto create a request. A request to retrieve a list of the health checks that are associated with the current Amazon Web Services account.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- IncompatibleVersionException The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedZones
default CompletableFuture<ListHostedZonesResponse> listHostedZones(ListHostedZonesRequest listHostedZonesRequest) Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a
HostedZoneschild element for each hosted zone.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the
maxitemsparameter to list them in groups of up to 100.- Parameters:
listHostedZonesRequest- A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListHostedZones operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedZones
default CompletableFuture<ListHostedZonesResponse> listHostedZones(Consumer<ListHostedZonesRequest.Builder> listHostedZonesRequest) Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a
HostedZoneschild element for each hosted zone.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the
maxitemsparameter to list them in groups of up to 100.
This is a convenience which creates an instance of the
ListHostedZonesRequest.Builderavoiding the need to create one manually viaListHostedZonesRequest.builder()- Parameters:
listHostedZonesRequest- AConsumerthat will call methods onListHostedZonesRequest.Builderto create a request. A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListHostedZones operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedZones
Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account. The response includes a
HostedZoneschild element for each hosted zone.Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the
maxitemsparameter to list them in groups of up to 100.- Returns:
- A Java Future containing the result of the ListHostedZones operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedZonesByName
default CompletableFuture<ListHostedZonesByNameResponse> listHostedZonesByName(ListHostedZonesByNameRequest listHostedZonesByNameRequest) Retrieves a list of your hosted zones in lexicographic order. The response includes a
HostedZoneschild element for each hosted zone created by the current Amazon Web Services account.ListHostedZonesByNamesorts hosted zones by name with the labels reversed. For example:com.example.www.Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode,
ListHostedZonesByNamealphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name.ListHostedZonesByNamealphabetizes it as:com.ex\344mple.The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the
MaxItemsparameter to list them in groups of up to 100. The response includes values that help navigate from one group ofMaxItemshosted zones to the next:-
The
DNSNameandHostedZoneIdelements in the response contain the values, if any, specified for thednsnameandhostedzoneidparameters in the request that produced the current response. -
The
MaxItemselement in the response contains the value, if any, that you specified for themaxitemsparameter in the request that produced the current response. -
If the value of
IsTruncatedin the response is true, there are more hosted zones associated with the current Amazon Web Services account.If
IsTruncatedis false, this response includes the last hosted zone that is associated with the current account. TheNextDNSNameelement andNextHostedZoneIdelements are omitted from the response. -
The
NextDNSNameandNextHostedZoneIdelements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call toListHostedZonesByName, and specify the value ofNextDNSNameandNextHostedZoneIdin thednsnameandhostedzoneidparameters, respectively.
- Parameters:
listHostedZonesByNameRequest- Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account in ASCII order by domain name.- Returns:
- A Java Future containing the result of the ListHostedZonesByName operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidDomainNameException The specified domain name is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listHostedZonesByName
default CompletableFuture<ListHostedZonesByNameResponse> listHostedZonesByName(Consumer<ListHostedZonesByNameRequest.Builder> listHostedZonesByNameRequest) Retrieves a list of your hosted zones in lexicographic order. The response includes a
HostedZoneschild element for each hosted zone created by the current Amazon Web Services account.ListHostedZonesByNamesorts hosted zones by name with the labels reversed. For example:com.example.www.Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode,
ListHostedZonesByNamealphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name.ListHostedZonesByNamealphabetizes it as:com.ex\344mple.The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the
MaxItemsparameter to list them in groups of up to 100. The response includes values that help navigate from one group ofMaxItemshosted zones to the next:-
The
DNSNameandHostedZoneIdelements in the response contain the values, if any, specified for thednsnameandhostedzoneidparameters in the request that produced the current response. -
The
MaxItemselement in the response contains the value, if any, that you specified for themaxitemsparameter in the request that produced the current response. -
If the value of
IsTruncatedin the response is true, there are more hosted zones associated with the current Amazon Web Services account.If
IsTruncatedis false, this response includes the last hosted zone that is associated with the current account. TheNextDNSNameelement andNextHostedZoneIdelements are omitted from the response. -
The
NextDNSNameandNextHostedZoneIdelements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call toListHostedZonesByName, and specify the value ofNextDNSNameandNextHostedZoneIdin thednsnameandhostedzoneidparameters, respectively.
This is a convenience which creates an instance of the
ListHostedZonesByNameRequest.Builderavoiding the need to create one manually viaListHostedZonesByNameRequest.builder()- Parameters:
listHostedZonesByNameRequest- AConsumerthat will call methods onListHostedZonesByNameRequest.Builderto create a request. Retrieves a list of the public and private hosted zones that are associated with the current Amazon Web Services account in ASCII order by domain name.- Returns:
- A Java Future containing the result of the ListHostedZonesByName operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidDomainNameException The specified domain name is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listHostedZonesByName
Retrieves a list of your hosted zones in lexicographic order. The response includes a
HostedZoneschild element for each hosted zone created by the current Amazon Web Services account.ListHostedZonesByNamesorts hosted zones by name with the labels reversed. For example:com.example.www.Note the trailing dot, which can change the sort order in some circumstances.
If the domain name includes escape characters or Punycode,
ListHostedZonesByNamealphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\344mple.com for the domain name.ListHostedZonesByNamealphabetizes it as:com.ex\344mple.The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the
MaxItemsparameter to list them in groups of up to 100. The response includes values that help navigate from one group ofMaxItemshosted zones to the next:-
The
DNSNameandHostedZoneIdelements in the response contain the values, if any, specified for thednsnameandhostedzoneidparameters in the request that produced the current response. -
The
MaxItemselement in the response contains the value, if any, that you specified for themaxitemsparameter in the request that produced the current response. -
If the value of
IsTruncatedin the response is true, there are more hosted zones associated with the current Amazon Web Services account.If
IsTruncatedis false, this response includes the last hosted zone that is associated with the current account. TheNextDNSNameelement andNextHostedZoneIdelements are omitted from the response. -
The
NextDNSNameandNextHostedZoneIdelements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current Amazon Web Services account. If you want to list more hosted zones, make another call toListHostedZonesByName, and specify the value ofNextDNSNameandNextHostedZoneIdin thednsnameandhostedzoneidparameters, respectively.
- Returns:
- A Java Future containing the result of the ListHostedZonesByName operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidDomainNameException The specified domain name is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listHostedZonesByVPC
default CompletableFuture<ListHostedZonesByVpcResponse> listHostedZonesByVPC(ListHostedZonesByVpcRequest listHostedZonesByVpcRequest) Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The
HostedZoneOwnerstructure in the response contains one of the following values:-
An
OwningAccountelement, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account. -
An
OwningServiceelement, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value ofOwnerisefs.amazonaws.com.
ListHostedZonesByVPCreturns the hosted zones associated with the specified VPC and does not reflect the hosted zone associations to VPCs via Route 53 Profiles. To get the associations to a Profile, call the ListProfileResourceAssociations API.When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
- Parameters:
listHostedZonesByVpcRequest- Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account created the hosted zones.- Returns:
- A Java Future containing the result of the ListHostedZonesByVPC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listHostedZonesByVPC
default CompletableFuture<ListHostedZonesByVpcResponse> listHostedZonesByVPC(Consumer<ListHostedZonesByVpcRequest.Builder> listHostedZonesByVpcRequest) Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account or Amazon Web Services service owns the hosted zones. The
HostedZoneOwnerstructure in the response contains one of the following values:-
An
OwningAccountelement, which contains the account number of either the current Amazon Web Services account or another Amazon Web Services account. Some services, such as Cloud Map, create hosted zones using the current account. -
An
OwningServiceelement, which identifies the Amazon Web Services service that created and owns the hosted zone. For example, if a hosted zone was created by Amazon Elastic File System (Amazon EFS), the value ofOwnerisefs.amazonaws.com.
ListHostedZonesByVPCreturns the hosted zones associated with the specified VPC and does not reflect the hosted zone associations to VPCs via Route 53 Profiles. To get the associations to a Profile, call the ListProfileResourceAssociations API.When listing private hosted zones, the hosted zone and the Amazon VPC must belong to the same partition where the hosted zones were created. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.
The following are the supported partitions:
-
aws- Amazon Web Services Regions -
aws-cn- China Regions -
aws-us-gov- Amazon Web Services GovCloud (US) Region
For more information, see Access Management in the Amazon Web Services General Reference.
This is a convenience which creates an instance of the
ListHostedZonesByVpcRequest.Builderavoiding the need to create one manually viaListHostedZonesByVpcRequest.builder()- Parameters:
listHostedZonesByVpcRequest- AConsumerthat will call methods onListHostedZonesByVpcRequest.Builderto create a request. Lists all the private hosted zones that a specified VPC is associated with, regardless of which Amazon Web Services account created the hosted zones.- Returns:
- A Java Future containing the result of the ListHostedZonesByVPC operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
listHostedZonesPaginator
This is a variant of
listHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListHostedZonesPublisher publisher = client.listHostedZonesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListHostedZonesPublisher publisher = client.listHostedZonesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListHostedZonesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListHostedZonesResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedZonesPaginator
default ListHostedZonesPublisher listHostedZonesPaginator(ListHostedZonesRequest listHostedZonesRequest) This is a variant of
listHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListHostedZonesPublisher publisher = client.listHostedZonesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListHostedZonesPublisher publisher = client.listHostedZonesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListHostedZonesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListHostedZonesResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation.- Parameters:
listHostedZonesRequest- A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listHostedZonesPaginator
default ListHostedZonesPublisher listHostedZonesPaginator(Consumer<ListHostedZonesRequest.Builder> listHostedZonesRequest) This is a variant of
listHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListHostedZonesPublisher publisher = client.listHostedZonesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListHostedZonesPublisher publisher = client.listHostedZonesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListHostedZonesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListHostedZonesResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listHostedZones(software.amazon.awssdk.services.route53.model.ListHostedZonesRequest)operation.
This is a convenience which creates an instance of the
ListHostedZonesRequest.Builderavoiding the need to create one manually viaListHostedZonesRequest.builder()- Parameters:
listHostedZonesRequest- AConsumerthat will call methods onListHostedZonesRequest.Builderto create a request. A request to retrieve a list of the public and private hosted zones that are associated with the current Amazon Web Services account.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchDelegationSetException A reusable delegation set with the specified ID does not exist.
- DelegationSetNotReusableException A reusable delegation set with the specified ID does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryLoggingConfigs
default CompletableFuture<ListQueryLoggingConfigsResponse> listQueryLoggingConfigs(ListQueryLoggingConfigsRequest listQueryLoggingConfigsRequest) Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.
- Parameters:
listQueryLoggingConfigsRequest-- Returns:
- A Java Future containing the result of the ListQueryLoggingConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryLoggingConfigs
default CompletableFuture<ListQueryLoggingConfigsResponse> listQueryLoggingConfigs(Consumer<ListQueryLoggingConfigsRequest.Builder> listQueryLoggingConfigsRequest) Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.
This is a convenience which creates an instance of the
ListQueryLoggingConfigsRequest.Builderavoiding the need to create one manually viaListQueryLoggingConfigsRequest.builder()- Parameters:
listQueryLoggingConfigsRequest- AConsumerthat will call methods onListQueryLoggingConfigsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListQueryLoggingConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryLoggingConfigs
Lists the configurations for DNS query logging that are associated with the current Amazon Web Services account or the configuration that is associated with a specified hosted zone.
For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.
- Returns:
- A Java Future containing the result of the ListQueryLoggingConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryLoggingConfigsPaginator
This is a variant of
listQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListQueryLoggingConfigsPublisher publisher = client.listQueryLoggingConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListQueryLoggingConfigsPublisher publisher = client.listQueryLoggingConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryLoggingConfigsPaginator
default ListQueryLoggingConfigsPublisher listQueryLoggingConfigsPaginator(ListQueryLoggingConfigsRequest listQueryLoggingConfigsRequest) This is a variant of
listQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListQueryLoggingConfigsPublisher publisher = client.listQueryLoggingConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListQueryLoggingConfigsPublisher publisher = client.listQueryLoggingConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation.- Parameters:
listQueryLoggingConfigsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQueryLoggingConfigsPaginator
default ListQueryLoggingConfigsPublisher listQueryLoggingConfigsPaginator(Consumer<ListQueryLoggingConfigsRequest.Builder> listQueryLoggingConfigsRequest) This is a variant of
listQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListQueryLoggingConfigsPublisher publisher = client.listQueryLoggingConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListQueryLoggingConfigsPublisher publisher = client.listQueryLoggingConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsResponse response) { //... }; });Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueryLoggingConfigs(software.amazon.awssdk.services.route53.model.ListQueryLoggingConfigsRequest)operation.
This is a convenience which creates an instance of the
ListQueryLoggingConfigsRequest.Builderavoiding the need to create one manually viaListQueryLoggingConfigsRequest.builder()- Parameters:
listQueryLoggingConfigsRequest- AConsumerthat will call methods onListQueryLoggingConfigsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRecordSets
default CompletableFuture<ListResourceRecordSetsResponse> listResourceRecordSets(ListResourceRecordSetsRequest listResourceRecordSetsRequest) Lists the resource record sets in a specified hosted zone.
ListResourceRecordSetsreturns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by thenameandtypeelements.Sort order
ListResourceRecordSetssorts results first by DNS name with the labels reversed, for example:com.example.www.Note the trailing dot, which can change the sort order when the record name contains characters that appear before
.(decimal 46) in the ASCII table. These characters include the following:! " # invalid input: '$' % & ' ( ) * + , -When multiple records have the same DNS name,
ListResourceRecordSetssorts results by the record type.Specifying where to start listing records
You can use the name and type elements to specify the resource record set that the list begins with:
- If you do not specify Name or Type
-
The results begin with the first resource record set that the hosted zone contains.
- If you specify Name but not Type
-
The results begin with the first resource record set in the list whose name is greater than or equal to
Name. - If you specify Type but not Name
-
Amazon Route 53 returns the
InvalidInputerror. - If you specify both Name and Type
-
The results begin with the first resource record set in the list whose name is greater than or equal to
Name, and whose type is greater than or equal toType.
Resource record sets that are PENDING
This action returns the most current version of the records. This includes records that are
PENDING, and that are not yet available on all Route 53 DNS servers.Changing resource record sets
To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a
ChangeResourceRecordSetsrequest while you're paging through the results of aListResourceRecordSetsrequest. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.Displaying the next page of results
If a
ListResourceRecordSetscommand returns more than one page of results, the value ofIsTruncatedistrue. To display the next page of results, get the values ofNextRecordName,NextRecordType, andNextRecordIdentifier(if any) from the response. Then submit anotherListResourceRecordSetsrequest, and specify those values forStartRecordName,StartRecordType, andStartRecordIdentifier.- Parameters:
listResourceRecordSetsRequest- A request for the resource record sets that are associated with a specified hosted zone.- Returns:
- A Java Future containing the result of the ListResourceRecordSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRecordSets
default CompletableFuture<ListResourceRecordSetsResponse> listResourceRecordSets(Consumer<ListResourceRecordSetsRequest.Builder> listResourceRecordSetsRequest) Lists the resource record sets in a specified hosted zone.
ListResourceRecordSetsreturns up to 300 resource record sets at a time in ASCII order, beginning at a position specified by thenameandtypeelements.Sort order
ListResourceRecordSetssorts results first by DNS name with the labels reversed, for example:com.example.www.Note the trailing dot, which can change the sort order when the record name contains characters that appear before
.(decimal 46) in the ASCII table. These characters include the following:! " # invalid input: '$' % & ' ( ) * + , -When multiple records have the same DNS name,
ListResourceRecordSetssorts results by the record type.Specifying where to start listing records
You can use the name and type elements to specify the resource record set that the list begins with:
- If you do not specify Name or Type
-
The results begin with the first resource record set that the hosted zone contains.
- If you specify Name but not Type
-
The results begin with the first resource record set in the list whose name is greater than or equal to
Name. - If you specify Type but not Name
-
Amazon Route 53 returns the
InvalidInputerror. - If you specify both Name and Type
-
The results begin with the first resource record set in the list whose name is greater than or equal to
Name, and whose type is greater than or equal toType.
Resource record sets that are PENDING
This action returns the most current version of the records. This includes records that are
PENDING, and that are not yet available on all Route 53 DNS servers.Changing resource record sets
To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a
ChangeResourceRecordSetsrequest while you're paging through the results of aListResourceRecordSetsrequest. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.Displaying the next page of results
If a
ListResourceRecordSetscommand returns more than one page of results, the value ofIsTruncatedistrue. To display the next page of results, get the values ofNextRecordName,NextRecordType, andNextRecordIdentifier(if any) from the response. Then submit anotherListResourceRecordSetsrequest, and specify those values forStartRecordName,StartRecordType, andStartRecordIdentifier.
This is a convenience which creates an instance of the
ListResourceRecordSetsRequest.Builderavoiding the need to create one manually viaListResourceRecordSetsRequest.builder()- Parameters:
listResourceRecordSetsRequest- AConsumerthat will call methods onListResourceRecordSetsRequest.Builderto create a request. A request for the resource record sets that are associated with a specified hosted zone.- Returns:
- A Java Future containing the result of the ListResourceRecordSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRecordSetsPaginator
default ListResourceRecordSetsPublisher listResourceRecordSetsPaginator(ListResourceRecordSetsRequest listResourceRecordSetsRequest) This is a variant of
listResourceRecordSets(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListResourceRecordSetsPublisher publisher = client.listResourceRecordSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListResourceRecordSetsPublisher publisher = client.listResourceRecordSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListResourceRecordSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceRecordSets(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsRequest)operation.- Parameters:
listResourceRecordSetsRequest- A request for the resource record sets that are associated with a specified hosted zone.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceRecordSetsPaginator
default ListResourceRecordSetsPublisher listResourceRecordSetsPaginator(Consumer<ListResourceRecordSetsRequest.Builder> listResourceRecordSetsRequest) This is a variant of
listResourceRecordSets(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.route53.paginators.ListResourceRecordSetsPublisher publisher = client.listResourceRecordSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.route53.paginators.ListResourceRecordSetsPublisher publisher = client.listResourceRecordSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.route53.model.ListResourceRecordSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsResponse response) { //... }; });Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceRecordSets(software.amazon.awssdk.services.route53.model.ListResourceRecordSetsRequest)operation.
This is a convenience which creates an instance of the
ListResourceRecordSetsRequest.Builderavoiding the need to create one manually viaListResourceRecordSetsRequest.builder()- Parameters:
listResourceRecordSetsRequest- AConsumerthat will call methods onListResourceRecordSetsRequest.Builderto create a request. A request for the resource record sets that are associated with a specified hosted zone.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReusableDelegationSets
default CompletableFuture<ListReusableDelegationSetsResponse> listReusableDelegationSets(ListReusableDelegationSetsRequest listReusableDelegationSetsRequest) Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
- Parameters:
listReusableDelegationSetsRequest- A request to get a list of the reusable delegation sets that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListReusableDelegationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReusableDelegationSets
default CompletableFuture<ListReusableDelegationSetsResponse> listReusableDelegationSets(Consumer<ListReusableDelegationSetsRequest.Builder> listReusableDelegationSetsRequest) Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListReusableDelegationSetsRequest.Builderavoiding the need to create one manually viaListReusableDelegationSetsRequest.builder()- Parameters:
listReusableDelegationSetsRequest- AConsumerthat will call methods onListReusableDelegationSetsRequest.Builderto create a request. A request to get a list of the reusable delegation sets that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListReusableDelegationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReusableDelegationSets
Retrieves a list of the reusable delegation sets that are associated with the current Amazon Web Services account.
- Returns:
- A Java Future containing the result of the ListReusableDelegationSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
- Parameters:
listTagsForResourceRequest- A complex type containing information about a request for a list of the tags that are associated with an individual resource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchHealthCheckException No health check exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- PriorRequestNotCompleteException 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists tags for one health check or hosted zone.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. A complex type containing information about a request for a list of the tags that are associated with an individual resource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchHealthCheckException No health check exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- PriorRequestNotCompleteException 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResources
default CompletableFuture<ListTagsForResourcesResponse> listTagsForResources(ListTagsForResourcesRequest listTagsForResourcesRequest) Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
- Parameters:
listTagsForResourcesRequest- A complex type that contains information about the health checks or hosted zones for which you want to list tags.- Returns:
- A Java Future containing the result of the ListTagsForResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchHealthCheckException No health check exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- PriorRequestNotCompleteException 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResources
default CompletableFuture<ListTagsForResourcesResponse> listTagsForResources(Consumer<ListTagsForResourcesRequest.Builder> listTagsForResourcesRequest) Lists tags for up to 10 health checks or hosted zones.
For information about using tags for cost allocation, see Using Cost Allocation Tags in the Billing and Cost Management User Guide.
This is a convenience which creates an instance of the
ListTagsForResourcesRequest.Builderavoiding the need to create one manually viaListTagsForResourcesRequest.builder()- Parameters:
listTagsForResourcesRequest- AConsumerthat will call methods onListTagsForResourcesRequest.Builderto create a request. A complex type that contains information about the health checks or hosted zones for which you want to list tags.- Returns:
- A Java Future containing the result of the ListTagsForResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchHealthCheckException No health check exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- PriorRequestNotCompleteException 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicies
default CompletableFuture<ListTrafficPoliciesResponse> listTrafficPolicies(ListTrafficPoliciesRequest listTrafficPoliciesRequest) Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.
For information about how of deleting a traffic policy affects the response from
ListTrafficPolicies, see DeleteTrafficPolicy .- Parameters:
listTrafficPoliciesRequest- A complex type that contains the information about the request to list the traffic policies that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListTrafficPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicies
default CompletableFuture<ListTrafficPoliciesResponse> listTrafficPolicies(Consumer<ListTrafficPoliciesRequest.Builder> listTrafficPoliciesRequest) Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.
For information about how of deleting a traffic policy affects the response from
ListTrafficPolicies, see DeleteTrafficPolicy .
This is a convenience which creates an instance of the
ListTrafficPoliciesRequest.Builderavoiding the need to create one manually viaListTrafficPoliciesRequest.builder()- Parameters:
listTrafficPoliciesRequest- AConsumerthat will call methods onListTrafficPoliciesRequest.Builderto create a request. A complex type that contains the information about the request to list the traffic policies that are associated with the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListTrafficPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicies
Gets information about the latest version for every traffic policy that is associated with the current Amazon Web Services account. Policies are listed in the order that they were created in.
For information about how of deleting a traffic policy affects the response from
ListTrafficPolicies, see DeleteTrafficPolicy .- Returns:
- A Java Future containing the result of the ListTrafficPolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyInstances
default CompletableFuture<ListTrafficPolicyInstancesResponse> listTrafficPolicyInstances(ListTrafficPolicyInstancesRequest listTrafficPolicyInstancesRequest) Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
After you submit an
UpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see theStateresponse element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItemsparameter to list them in groups of up to 100.- Parameters:
listTrafficPolicyInstancesRequest- A request to get information about the traffic policy instances that you created by using the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListTrafficPolicyInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyInstances
default CompletableFuture<ListTrafficPolicyInstancesResponse> listTrafficPolicyInstances(Consumer<ListTrafficPolicyInstancesRequest.Builder> listTrafficPolicyInstancesRequest) Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
After you submit an
UpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see theStateresponse element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItemsparameter to list them in groups of up to 100.
This is a convenience which creates an instance of the
ListTrafficPolicyInstancesRequest.Builderavoiding the need to create one manually viaListTrafficPolicyInstancesRequest.builder()- Parameters:
listTrafficPolicyInstancesRequest- AConsumerthat will call methods onListTrafficPolicyInstancesRequest.Builderto create a request. A request to get information about the traffic policy instances that you created by using the current Amazon Web Services account.- Returns:
- A Java Future containing the result of the ListTrafficPolicyInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyInstances
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
After you submit an
UpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see theStateresponse element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItemsparameter to list them in groups of up to 100.- Returns:
- A Java Future containing the result of the ListTrafficPolicyInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyInstancesByHostedZone
default CompletableFuture<ListTrafficPolicyInstancesByHostedZoneResponse> listTrafficPolicyInstancesByHostedZone(ListTrafficPolicyInstancesByHostedZoneRequest listTrafficPolicyInstancesByHostedZoneRequest) Gets information about the traffic policy instances that you created in a specified hosted zone.
After you submit a
CreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see theStateresponse element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItemsparameter to list them in groups of up to 100.- Parameters:
listTrafficPolicyInstancesByHostedZoneRequest- A request for the traffic policy instances that you created in a specified hosted zone.- Returns:
- A Java Future containing the result of the ListTrafficPolicyInstancesByHostedZone operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyInstancesByHostedZone
default CompletableFuture<ListTrafficPolicyInstancesByHostedZoneResponse> listTrafficPolicyInstancesByHostedZone(Consumer<ListTrafficPolicyInstancesByHostedZoneRequest.Builder> listTrafficPolicyInstancesByHostedZoneRequest) Gets information about the traffic policy instances that you created in a specified hosted zone.
After you submit a
CreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see theStateresponse element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItemsparameter to list them in groups of up to 100.
This is a convenience which creates an instance of the
ListTrafficPolicyInstancesByHostedZoneRequest.Builderavoiding the need to create one manually viaListTrafficPolicyInstancesByHostedZoneRequest.builder()- Parameters:
listTrafficPolicyInstancesByHostedZoneRequest- AConsumerthat will call methods onListTrafficPolicyInstancesByHostedZoneRequest.Builderto create a request. A request for the traffic policy instances that you created in a specified hosted zone.- Returns:
- A Java Future containing the result of the ListTrafficPolicyInstancesByHostedZone operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyInstancesByPolicy
default CompletableFuture<ListTrafficPolicyInstancesByPolicyResponse> listTrafficPolicyInstancesByPolicy(ListTrafficPolicyInstancesByPolicyRequest listTrafficPolicyInstancesByPolicyRequest) Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a
CreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see theStateresponse element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItemsparameter to list them in groups of up to 100.- Parameters:
listTrafficPolicyInstancesByPolicyRequest- A complex type that contains the information about the request to list your traffic policy instances.- Returns:
- A Java Future containing the result of the ListTrafficPolicyInstancesByPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyInstancesByPolicy
default CompletableFuture<ListTrafficPolicyInstancesByPolicyResponse> listTrafficPolicyInstancesByPolicy(Consumer<ListTrafficPolicyInstancesByPolicyRequest.Builder> listTrafficPolicyInstancesByPolicyRequest) Gets information about the traffic policy instances that you created by using a specify traffic policy version.
After you submit a
CreateTrafficPolicyInstanceor anUpdateTrafficPolicyInstancerequest, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see theStateresponse element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the
MaxItemsparameter to list them in groups of up to 100.
This is a convenience which creates an instance of the
ListTrafficPolicyInstancesByPolicyRequest.Builderavoiding the need to create one manually viaListTrafficPolicyInstancesByPolicyRequest.builder()- Parameters:
listTrafficPolicyInstancesByPolicyRequest- AConsumerthat will call methods onListTrafficPolicyInstancesByPolicyRequest.Builderto create a request. A complex type that contains the information about the request to list your traffic policy instances.- Returns:
- A Java Future containing the result of the ListTrafficPolicyInstancesByPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyVersions
default CompletableFuture<ListTrafficPolicyVersionsResponse> listTrafficPolicyVersions(ListTrafficPolicyVersionsRequest listTrafficPolicyVersionsRequest) Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by
VersionNumber.- Parameters:
listTrafficPolicyVersionsRequest- A complex type that contains the information about the request to list your traffic policies.- Returns:
- A Java Future containing the result of the ListTrafficPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTrafficPolicyVersions
default CompletableFuture<ListTrafficPolicyVersionsResponse> listTrafficPolicyVersions(Consumer<ListTrafficPolicyVersionsRequest.Builder> listTrafficPolicyVersionsRequest) Gets information about all of the versions for a specified traffic policy.
Traffic policy versions are listed in numerical order by
VersionNumber.
This is a convenience which creates an instance of the
ListTrafficPolicyVersionsRequest.Builderavoiding the need to create one manually viaListTrafficPolicyVersionsRequest.builder()- Parameters:
listTrafficPolicyVersionsRequest- AConsumerthat will call methods onListTrafficPolicyVersionsRequest.Builderto create a request. A complex type that contains the information about the request to list your traffic policies.- Returns:
- A Java Future containing the result of the ListTrafficPolicyVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVPCAssociationAuthorizations
default CompletableFuture<ListVpcAssociationAuthorizationsResponse> listVPCAssociationAuthorizations(ListVpcAssociationAuthorizationsRequest listVpcAssociationAuthorizationsRequest) Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more
CreateVPCAssociationAuthorizationrequests.The response includes a
VPCselement with aVPCchild element for each VPC that can be associated with the hosted zone.- Parameters:
listVpcAssociationAuthorizationsRequest- A complex type that contains information about that can be associated with your hosted zone.- Returns:
- A Java Future containing the result of the ListVPCAssociationAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVPCAssociationAuthorizations
default CompletableFuture<ListVpcAssociationAuthorizationsResponse> listVPCAssociationAuthorizations(Consumer<ListVpcAssociationAuthorizationsRequest.Builder> listVpcAssociationAuthorizationsRequest) Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more
CreateVPCAssociationAuthorizationrequests.The response includes a
VPCselement with aVPCchild element for each VPC that can be associated with the hosted zone.
This is a convenience which creates an instance of the
ListVpcAssociationAuthorizationsRequest.Builderavoiding the need to create one manually viaListVpcAssociationAuthorizationsRequest.builder()- Parameters:
listVpcAssociationAuthorizationsRequest- AConsumerthat will call methods onListVpcAssociationAuthorizationsRequest.Builderto create a request. A complex type that contains information about that can be associated with your hosted zone.- Returns:
- A Java Future containing the result of the ListVPCAssociationAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- InvalidPaginationTokenException The value that you specified to get the second or subsequent page of results is invalid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testDNSAnswer
default CompletableFuture<TestDnsAnswerResponse> testDNSAnswer(TestDnsAnswerRequest testDnsAnswerRequest) Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.
This call only supports querying public hosted zones.
The
TestDnsAnswerreturns information similar to what you would expect from the answer section of thedigcommand. Therefore, if you query for the name servers of a subdomain that point to the parent name servers, those will not be returned.- Parameters:
testDnsAnswerRequest- Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.- Returns:
- A Java Future containing the result of the TestDNSAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
testDNSAnswer
default CompletableFuture<TestDnsAnswerResponse> testDNSAnswer(Consumer<TestDnsAnswerRequest.Builder> testDnsAnswerRequest) Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.
This call only supports querying public hosted zones.
The
TestDnsAnswerreturns information similar to what you would expect from the answer section of thedigcommand. Therefore, if you query for the name servers of a subdomain that point to the parent name servers, those will not be returned.
This is a convenience which creates an instance of the
TestDnsAnswerRequest.Builderavoiding the need to create one manually viaTestDnsAnswerRequest.builder()- Parameters:
testDnsAnswerRequest- AConsumerthat will call methods onTestDnsAnswerRequest.Builderto create a request. Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.- Returns:
- A Java Future containing the result of the TestDNSAnswer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateHealthCheck
default CompletableFuture<UpdateHealthCheckResponse> updateHealthCheck(UpdateHealthCheckRequest updateHealthCheckRequest) Updates an existing health check. Note that some values can't be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
- Parameters:
updateHealthCheckRequest- A complex type that contains information about a request to update a health check.- Returns:
- A Java Future containing the result of the UpdateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- HealthCheckVersionMismatchException The value of
HealthCheckVersionin the request doesn't match the value ofHealthCheckVersionin the health check. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateHealthCheck
default CompletableFuture<UpdateHealthCheckResponse> updateHealthCheck(Consumer<UpdateHealthCheckRequest.Builder> updateHealthCheckRequest) Updates an existing health check. Note that some values can't be updated.
For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.
This is a convenience which creates an instance of the
UpdateHealthCheckRequest.Builderavoiding the need to create one manually viaUpdateHealthCheckRequest.builder()- Parameters:
updateHealthCheckRequest- AConsumerthat will call methods onUpdateHealthCheckRequest.Builderto create a request. A complex type that contains information about a request to update a health check.- Returns:
- A Java Future containing the result of the UpdateHealthCheck operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHealthCheckException No health check exists with the specified ID.
- InvalidInputException The input is not valid.
- HealthCheckVersionMismatchException The value of
HealthCheckVersionin the request doesn't match the value ofHealthCheckVersionin the health check. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateHostedZoneComment
default CompletableFuture<UpdateHostedZoneCommentResponse> updateHostedZoneComment(UpdateHostedZoneCommentRequest updateHostedZoneCommentRequest) Updates the comment for a specified hosted zone.
- Parameters:
updateHostedZoneCommentRequest- A request to update the comment for a hosted zone.- Returns:
- A Java Future containing the result of the UpdateHostedZoneComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateHostedZoneComment
default CompletableFuture<UpdateHostedZoneCommentResponse> updateHostedZoneComment(Consumer<UpdateHostedZoneCommentRequest.Builder> updateHostedZoneCommentRequest) Updates the comment for a specified hosted zone.
This is a convenience which creates an instance of the
UpdateHostedZoneCommentRequest.Builderavoiding the need to create one manually viaUpdateHostedZoneCommentRequest.builder()- Parameters:
updateHostedZoneCommentRequest- AConsumerthat will call methods onUpdateHostedZoneCommentRequest.Builderto create a request. A request to update the comment for a hosted zone.- Returns:
- A Java Future containing the result of the UpdateHostedZoneComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- NoSuchHostedZoneException No hosted zone exists with the ID that you specified.
- InvalidInputException The input is not valid.
- PriorRequestNotCompleteException 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. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrafficPolicyComment
default CompletableFuture<UpdateTrafficPolicyCommentResponse> updateTrafficPolicyComment(UpdateTrafficPolicyCommentRequest updateTrafficPolicyCommentRequest) Updates the comment for a specified traffic policy version.
- Parameters:
updateTrafficPolicyCommentRequest- A complex type that contains information about the traffic policy that you want to update the comment for.- Returns:
- A Java Future containing the result of the UpdateTrafficPolicyComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrafficPolicyComment
default CompletableFuture<UpdateTrafficPolicyCommentResponse> updateTrafficPolicyComment(Consumer<UpdateTrafficPolicyCommentRequest.Builder> updateTrafficPolicyCommentRequest) Updates the comment for a specified traffic policy version.
This is a convenience which creates an instance of the
UpdateTrafficPolicyCommentRequest.Builderavoiding the need to create one manually viaUpdateTrafficPolicyCommentRequest.builder()- Parameters:
updateTrafficPolicyCommentRequest- AConsumerthat will call methods onUpdateTrafficPolicyCommentRequest.Builderto create a request. A complex type that contains information about the traffic policy that you want to update the comment for.- Returns:
- A Java Future containing the result of the UpdateTrafficPolicyComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- ConcurrentModificationException Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateTrafficPolicyInstance
default CompletableFuture<UpdateTrafficPolicyInstanceResponse> updateTrafficPolicyInstance(UpdateTrafficPolicyInstanceRequest updateTrafficPolicyInstanceRequest) After you submit a
UpdateTrafficPolicyInstancerequest, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition. UseGetTrafficPolicyInstancewith theidof updated traffic policy instance confirm that theUpdateTrafficPolicyInstancerequest completed successfully. For more information, see theStateresponse element.Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:
-
Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
-
When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
-
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
- Parameters:
updateTrafficPolicyInstanceRequest- A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.- Returns:
- A Java Future containing the result of the UpdateTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- PriorRequestNotCompleteException 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. - ConflictingTypesException You tried to update a traffic policy instance by using a traffic policy
version that has a different DNS type than the current type for the instance. You specified the type in
the JSON document in the
CreateTrafficPolicyorCreateTrafficPolicyVersionrequest. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
updateTrafficPolicyInstance
default CompletableFuture<UpdateTrafficPolicyInstanceResponse> updateTrafficPolicyInstance(Consumer<UpdateTrafficPolicyInstanceRequest.Builder> updateTrafficPolicyInstanceRequest) After you submit a
UpdateTrafficPolicyInstancerequest, there's a brief delay while Route 53 creates the resource record sets that are specified in the traffic policy definition. UseGetTrafficPolicyInstancewith theidof updated traffic policy instance confirm that theUpdateTrafficPolicyInstancerequest completed successfully. For more information, see theStateresponse element.Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.
When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:
-
Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.
-
When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.
-
Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.
This is a convenience which creates an instance of the
UpdateTrafficPolicyInstanceRequest.Builderavoiding the need to create one manually viaUpdateTrafficPolicyInstanceRequest.builder()- Parameters:
updateTrafficPolicyInstanceRequest- AConsumerthat will call methods onUpdateTrafficPolicyInstanceRequest.Builderto create a request. A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.- Returns:
- A Java Future containing the result of the UpdateTrafficPolicyInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidInputException The input is not valid.
- NoSuchTrafficPolicyException No traffic policy exists with the specified ID.
- NoSuchTrafficPolicyInstanceException No traffic policy instance exists with the specified ID.
- PriorRequestNotCompleteException 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. - ConflictingTypesException You tried to update a traffic policy instance by using a traffic policy
version that has a different DNS type than the current type for the instance. You specified the type in
the JSON document in the
CreateTrafficPolicyorCreateTrafficPolicyVersionrequest. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- Route53Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
waiter
Create an instance ofRoute53AsyncWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
Route53AsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aRoute53AsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aRoute53AsyncClient.
-