Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Paws::Route53(3)      User Contributed Perl Documentation     Paws::Route53(3)

NAME
       Paws::Route53 - Perl Interface to AWS Amazon Route 53

SYNOPSIS
	 use Paws;

	 my $obj = Paws->service('Route53')->new;
	 my $res = $obj->Method(
	   Arg1	=> $val1,
	   Arg2	=> [ 'V1', 'V2'	],
	   # if	Arg3 is	an object, the HashRef will be used as arguments to the	constructor
	   # of	the arguments type
	   Arg3	=> { Att1 => 'Val1' },
	   # if	Arg4 is	an array of objects, the HashRefs will be passed as arguments to
	   # the constructor of	the arguments type
	   Arg4	=> [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
	 );

DESCRIPTION
       Amazon Route 53

       Amazon Route 53 is a scalable Domain Name System	(DNS) web service. It
       provides	secure and reliable routing to your infrastructure that	uses
       Amazon Web Services (AWS) products, such	as Amazon Elastic Compute
       Cloud (Amazon EC2), Elastic Load	Balancing, or Amazon Simple Storage
       Service (Amazon S3). You	can also use Amazon Route 53 to	route users to
       your infrastructure outside of AWS.

       Amazon Route 53 is an authoritative DNS service,	meaning	it translates
       friendly	domains	names like www.example.com into	IP addresses like
       192.0.2.1. Amazon Route 53 responds to DNS queries using	a global
       network of authoritative	DNS servers, which reduces latency. For	a list
       of the locations	of Amazon Route	53 DNS servers,	see The	Amazon Route
       53 Global Network on the	Amazon Route 53	detail page.

METHODS
   AssociateVPCWithHostedZone(HostedZoneId => Str, VPC => Paws::Route53::VPC,
       [Comment	=> Str])
       Each argument is	described in detail in:
       Paws::Route53::AssociateVPCWithHostedZone

       Returns:	a Paws::Route53::AssociateVPCWithHostedZoneResponse instance

       This action associates a	VPC with an hosted zone.

       To associate a VPC with an hosted zone, send a "POST" request to	the
       "2013-04-01/hostedzone/hosted zone ID/associatevpc" resource. The
       request body must include an XML	document with a
       "AssociateVPCWithHostedZoneRequest" element. The	response returns the
       "AssociateVPCWithHostedZoneResponse" element that contains "ChangeInfo"
       for you to track	the progress of	the
       "AssociateVPCWithHostedZoneRequest" you made. See "GetChange" operation
       for how to track	the progress of	your change.

   ChangeResourceRecordSets(ChangeBatch	=> Paws::Route53::ChangeBatch,
       HostedZoneId => Str)
       Each argument is	described in detail in:
       Paws::Route53::ChangeResourceRecordSets

       Returns:	a Paws::Route53::ChangeResourceRecordSetsResponse instance

       Use this	action to create or change your	authoritative DNS information.
       To use this action, send	a "POST" request to the
       "2013-04-01/hostedzone/hosted Zone ID/rrset" resource. The request body
       must include an XML document with a "ChangeResourceRecordSetsRequest"
       element.

       Changes are a list of change items and are considered transactional.
       For more	information on transactional changes, also known as change
       batches,	see Creating, Changing,	and Deleting Resource Record Sets
       Using the Route 53 API in the Amazon Route 53 Developer Guide.

       Due to the nature of transactional changes, you cannot delete the same
       resource	record set more	than once in a single change batch. If you
       attempt to delete the same change batch more than once, Route 53
       returns an "InvalidChangeBatch" error.

       In response to a	"ChangeResourceRecordSets" request, your DNS data is
       changed on all Route 53 DNS servers. Initially, the status of a change
       is "PENDING". This means	the change has not yet propagated to all the
       authoritative Route 53 DNS servers. When	the change is propagated to
       all hosts, the change returns a status of "INSYNC".

       Note the	following limitations on a "ChangeResourceRecordSets" request:

       - A request cannot contain more than 100	Change elements.

       - A request cannot contain more than 1000 ResourceRecord	elements.

       The sum of the number of	characters (including spaces) in all "Value"
       elements	in a request cannot exceed 32,000 characters.

   ChangeTagsForResource(ResourceId => Str, ResourceType => Str, [AddTags =>
       ArrayRef[Paws::Route53::Tag], RemoveTagKeys => ArrayRef[Str]])
       Each argument is	described in detail in:
       Paws::Route53::ChangeTagsForResource

       Returns:	a Paws::Route53::ChangeTagsForResourceResponse instance

   CreateHealthCheck(CallerReference =>	Str, HealthCheckConfig =>
       Paws::Route53::HealthCheckConfig)
       Each argument is	described in detail in:
       Paws::Route53::CreateHealthCheck

       Returns:	a Paws::Route53::CreateHealthCheckResponse instance

       This action creates a new health	check.

       To create a new health check, send a "POST" request to the
       "2013-04-01/healthcheck"	resource. The request body must	include	an XML
       document	with a "CreateHealthCheckRequest" element. The response
       returns the "CreateHealthCheckResponse" element that contains metadata
       about the health	check.

   CreateHostedZone(CallerReference => Str, Name => Str, [DelegationSetId =>
       Str, HostedZoneConfig =>	Paws::Route53::HostedZoneConfig, VPC =>
       Paws::Route53::VPC])
       Each argument is	described in detail in:
       Paws::Route53::CreateHostedZone

       Returns:	a Paws::Route53::CreateHostedZoneResponse instance

       This action creates a new hosted	zone.

       To create a new hosted zone, send a "POST" request to the
       "2013-04-01/hostedzone" resource. The request body must include an XML
       document	with a "CreateHostedZoneRequest" element. The response returns
       the "CreateHostedZoneResponse" element that contains metadata about the
       hosted zone.

       Route 53	automatically creates a	default	SOA record and four NS records
       for the zone. The NS records in the hosted zone are the name servers
       you give	your registrar to delegate your	domain to. 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.

       When you	create a zone, its initial status is "PENDING".	This means
       that it is not yet available on all DNS servers.	The status of the zone
       changes to "INSYNC" when	the NS and SOA records are available on	all
       Route 53	DNS servers.

       When trying to create a hosted zone using a reusable delegation set,
       you could specify an optional DelegationSetId, and Route53 would	assign
       those 4 NS records for the zone,	instead	of alloting a new one.

   CreateReusableDelegationSet(CallerReference => Str, [HostedZoneId =>	Str])
       Each argument is	described in detail in:
       Paws::Route53::CreateReusableDelegationSet

       Returns:	a Paws::Route53::CreateReusableDelegationSetResponse instance

       This action creates a reusable delegationSet.

       To create a new reusable	delegationSet, send a "POST" request to	the
       "2013-04-01/delegationset" resource. The	request	body must include an
       XML document with a "CreateReusableDelegationSetRequest"	element. The
       response	returns	the "CreateReusableDelegationSetResponse" element that
       contains	metadata about the delegationSet.

       If the optional parameter HostedZoneId is specified, it marks the
       delegationSet associated	with that particular hosted zone as reusable.

   DeleteHealthCheck(HealthCheckId => Str)
       Each argument is	described in detail in:
       Paws::Route53::DeleteHealthCheck

       Returns:	a Paws::Route53::DeleteHealthCheckResponse instance

       This action deletes a health check. To delete a health check, send a
       "DELETE"	request	to the "2013-04-01/healthcheck/health check ID"
       resource.

       You can delete a	health check only if there are no resource record sets
       associated with this health check. If resource record sets are
       associated with this health check, you must disassociate	them before
       you can delete your health check. If you	try to delete a	health check
       that is associated with resource	record sets, Route 53 will deny	your
       request with a "HealthCheckInUse" error.	For information	about
       disassociating the records from your health check, see
       ChangeResourceRecordSets.

   DeleteHostedZone(Id => Str)
       Each argument is	described in detail in:
       Paws::Route53::DeleteHostedZone

       Returns:	a Paws::Route53::DeleteHostedZoneResponse instance

       This action deletes a hosted zone. To delete a hosted zone, send	a
       "DELETE"	request	to the "2013-04-01/hostedzone/hosted zone ID"
       resource.

       For more	information about deleting a hosted zone, see Deleting a
       Hosted Zone in the Amazon Route 53 Developer Guide.

       You can delete a	hosted zone only if there are no resource record sets
       other than the default SOA record and NS	resource record	sets. If your
       hosted zone contains other resource record sets,	you must delete	them
       before you can delete your hosted zone. If you try to delete a hosted
       zone that contains other	resource record	sets, Route 53 will deny your
       request with a "HostedZoneNotEmpty" error. For information about
       deleting	records	from your hosted zone, see ChangeResourceRecordSets.

   DeleteReusableDelegationSet(Id => Str)
       Each argument is	described in detail in:
       Paws::Route53::DeleteReusableDelegationSet

       Returns:	a Paws::Route53::DeleteReusableDelegationSetResponse instance

       This action deletes a reusable delegation set. To delete	a reusable
       delegation set, send a "DELETE" request to the
       "2013-04-01/delegationset/delegation set	ID" resource.

       You can delete a	reusable delegation set	only if	there are no
       associated hosted zones.	If your	reusable delegation set	contains
       associated hosted zones,	you must delete	them before you	can delete
       your reusable delegation	set. If	you try	to delete a reusable
       delegation set that contains associated hosted zones, Route 53 will
       deny your request with a	"DelegationSetInUse" error.

   DisassociateVPCFromHostedZone(HostedZoneId => Str, VPC =>
       Paws::Route53::VPC, [Comment => Str])
       Each argument is	described in detail in:
       Paws::Route53::DisassociateVPCFromHostedZone

       Returns:	a Paws::Route53::DisassociateVPCFromHostedZoneResponse
       instance

       This action disassociates a VPC from an hosted zone.

       To disassociate a VPC to	a hosted zone, send a "POST" request to	the
       "2013-04-01/hostedzone/hosted zone ID/disassociatevpc" resource.	 The
       request body must include an XML	document with a
       "DisassociateVPCFromHostedZoneRequest" element. The response returns
       the "DisassociateVPCFromHostedZoneResponse" element that	contains
       "ChangeInfo" for	you to track the progress of the
       "DisassociateVPCFromHostedZoneRequest" you made.	See "GetChange"
       operation for how to track the progress of your change.

   GetChange(Id	=> Str)
       Each argument is	described in detail in:	Paws::Route53::GetChange

       Returns:	a Paws::Route53::GetChangeResponse instance

       This action returns the current status of a change batch	request. The
       status is one of	the following values:

       - "PENDING" indicates that the changes in this request have not
       replicated to all Route 53 DNS servers. This is the initial status of
       all change batch	requests.

       - "INSYNC" indicates that the changes have replicated to	all Amazon
       Route 53	DNS servers.

   GetCheckerIpRanges( => )
       Each argument is	described in detail in:
       Paws::Route53::GetCheckerIpRanges

       Returns:	a Paws::Route53::GetCheckerIpRangesResponse instance

       To retrieve a list of the IP ranges used	by Amazon Route	53 health
       checkers	to check the health of your resources, send a "GET" request to
       the "2013-04-01/checkeripranges"	resource. You can use these IP
       addresses to configure router and firewall rules	to allow health
       checkers	to check the health of your resources.

   GetGeoLocation([ContinentCode => Str, CountryCode =>	Str, SubdivisionCode
       => Str])
       Each argument is	described in detail in:	Paws::Route53::GetGeoLocation

       Returns:	a Paws::Route53::GetGeoLocationResponse	instance

       To retrieve a single geo	location, send a "GET" request to the
       "2013-04-01/geolocation"	resource with one of these options:
       continentcode | countrycode | countrycode and subdivisioncode.

   GetHealthCheck(HealthCheckId	=> Str)
       Each argument is	described in detail in:	Paws::Route53::GetHealthCheck

       Returns:	a Paws::Route53::GetHealthCheckResponse	instance

       To retrieve the health check, send a "GET" request to the
       "2013-04-01/healthcheck/health check ID"	resource.

   GetHealthCheckCount(	=> )
       Each argument is	described in detail in:
       Paws::Route53::GetHealthCheckCount

       Returns:	a Paws::Route53::GetHealthCheckCountResponse instance

       To retrieve a count of all your health checks, send a "GET" request to
       the "2013-04-01/healthcheckcount" resource.

   GetHealthCheckLastFailureReason(HealthCheckId => Str)
       Each argument is	described in detail in:
       Paws::Route53::GetHealthCheckLastFailureReason

       Returns:	a Paws::Route53::GetHealthCheckLastFailureReasonResponse
       instance

       If you want to learn why	a health check is currently failing or why it
       failed most recently (if	at all), you can get the failure reason	for
       the most	recent failure.	Send a "GET" request to	the
       "2013-04-01/healthcheck/health check ID/lastfailurereason" resource.

   GetHealthCheckStatus(HealthCheckId => Str)
       Each argument is	described in detail in:
       Paws::Route53::GetHealthCheckStatus

       Returns:	a Paws::Route53::GetHealthCheckStatusResponse instance

       To retrieve the health check status, send a "GET" request to the
       "2013-04-01/healthcheck/health check ID/status" resource. You can use
       this call to get	a health check's current status.

   GetHostedZone(Id => Str)
       Each argument is	described in detail in:	Paws::Route53::GetHostedZone

       Returns:	a Paws::Route53::GetHostedZoneResponse instance

       To retrieve the delegation set for a hosted zone, send a	"GET" request
       to the "2013-04-01/hostedzone/hosted zone ID" resource. The delegation
       set is the four Route 53	name servers that were assigned	to the hosted
       zone when you created it.

   GetHostedZoneCount( => )
       Each argument is	described in detail in:
       Paws::Route53::GetHostedZoneCount

       Returns:	a Paws::Route53::GetHostedZoneCountResponse instance

       To retrieve a count of all your hosted zones, send a "GET" request to
       the "2013-04-01/hostedzonecount"	resource.

   GetReusableDelegationSet(Id => Str)
       Each argument is	described in detail in:
       Paws::Route53::GetReusableDelegationSet

       Returns:	a Paws::Route53::GetReusableDelegationSetResponse instance

       To retrieve the reusable	delegation set,	send a "GET" request to	the
       "2013-04-01/delegationset/delegation set	ID" resource.

   ListGeoLocations([MaxItems => Str, StartContinentCode => Str,
       StartCountryCode	=> Str,	StartSubdivisionCode =>	Str])
       Each argument is	described in detail in:
       Paws::Route53::ListGeoLocations

       Returns:	a Paws::Route53::ListGeoLocationsResponse instance

       To retrieve a list of supported geo locations, send a "GET" request to
       the "2013-04-01/geolocations" resource. The response to this request
       includes	a "GeoLocationDetailsList" element with	zero, one, or multiple
       "GeoLocationDetails" child elements. The	list is	sorted by country
       code, and then subdivision code,	followed by continents at the end of
       the list.

       By default, the list of geo locations is	displayed on a single page.
       You can control the length of the page that is displayed	by using the
       "MaxItems" parameter. If	the list is truncated, "IsTruncated" will be
       set to true and a combination of	"NextContinentCode, NextCountryCode,
       NextSubdivisionCode" will be populated. You can pass these as
       parameters to "StartContinentCode, StartCountryCode,
       StartSubdivisionCode" to	control	the geo	location that the list begins
       with.

   ListHealthChecks([Marker => Str, MaxItems =>	Str])
       Each argument is	described in detail in:
       Paws::Route53::ListHealthChecks

       Returns:	a Paws::Route53::ListHealthChecksResponse instance

       To retrieve a list of your health checks, send a	"GET" request to the
       "2013-04-01/healthcheck"	resource. The response to this request
       includes	a "HealthChecks" element with zero, one, or multiple
       "HealthCheck" child elements. By	default, the list of health checks is
       displayed on a single page. You can control the length of the page that
       is displayed by using the "MaxItems" parameter. You can use the
       "Marker"	parameter to control the health	check that the list begins
       with.

       Amazon Route 53 returns a maximum of 100	items. If you set MaxItems to
       a value greater than 100, Amazon	Route 53 returns only the first	100.

   ListHostedZones([DelegationSetId => Str, Marker => Str, MaxItems => Str])
       Each argument is	described in detail in:	Paws::Route53::ListHostedZones

       Returns:	a Paws::Route53::ListHostedZonesResponse instance

       To retrieve a list of your hosted zones,	send a "GET" request to	the
       "2013-04-01/hostedzone" resource. The response to this request includes
       a "HostedZones" element with zero, one, or multiple "HostedZone"	child
       elements. By default, the list of hosted	zones is displayed on a	single
       page. You can control the length	of the page that is displayed by using
       the "MaxItems" parameter. You can use the "Marker" parameter to control
       the hosted zone that the	list begins with.

       Amazon Route 53 returns a maximum of 100	items. If you set MaxItems to
       a value greater than 100, Amazon	Route 53 returns only the first	100.

   ListHostedZonesByName([DNSName => Str, HostedZoneId => Str, MaxItems	=>
       Str])
       Each argument is	described in detail in:
       Paws::Route53::ListHostedZonesByName

       Returns:	a Paws::Route53::ListHostedZonesByNameResponse instance

       To retrieve a list of your hosted zones in lexicographic	order, send a
       "GET" request to	the "2013-04-01/hostedzonesbyname" resource. The
       response	to this	request	includes a "HostedZones" element with zero or
       more "HostedZone" child elements	lexicographically ordered by DNS name.
       By default, the list of hosted zones is displayed on a single page. You
       can control the length of the page that is displayed by using the
       "MaxItems" parameter. You can use the "DNSName" and "HostedZoneId"
       parameters to control the hosted	zone that the list begins with.

       Amazon Route 53 returns a maximum of 100	items. If you set MaxItems to
       a value greater than 100, Amazon	Route 53 returns only the first	100.

   ListResourceRecordSets(HostedZoneId => Str, [MaxItems => Str,
       StartRecordIdentifier =>	Str, StartRecordName =>	Str, StartRecordType
       => Str])
       Each argument is	described in detail in:
       Paws::Route53::ListResourceRecordSets

       Returns:	a Paws::Route53::ListResourceRecordSetsResponse	instance

       Imagine all the resource	record sets in a zone listed out in front of
       you. Imagine them sorted	lexicographically first	by DNS name (with the
       labels reversed,	like "com.amazon.www" for example), and	secondarily,
       lexicographically by record type. This operation	retrieves at most
       MaxItems	resource record	sets from this list, in	order, starting	at a
       position	specified by the Name and Type arguments:

       o   If both Name	and Type are omitted, this means start the results at
	   the first RRSET in the HostedZone.

       o   If Name is specified	but Type is omitted, this means	start the
	   results at the first	RRSET in the list whose	name is	greater	than
	   or equal to Name.

       o   If both Name	and Type are specified,	this means start the results
	   at the first	RRSET in the list whose	name is	greater	than or	equal
	   to Name and whose type is greater than or equal to Type.

       o   It is an error to specify the Type but not the Name.

       Use ListResourceRecordSets to retrieve a	single known record set	by
       specifying the record set's name	and type, and setting MaxItems = 1

       To retrieve all the records in a	HostedZone, first pause	any processes
       making calls to ChangeResourceRecordSets. Initially call
       ListResourceRecordSets without a	Name and Type to get the first page of
       record sets. For	subsequent calls, set Name and Type to the NextName
       and NextType values returned by the previous response.

       In the presence of concurrent ChangeResourceRecordSets calls, there is
       no consistency of results across	calls to ListResourceRecordSets. The
       only way	to get a consistent multi-page snapshot	of all RRSETs in a
       zone is to stop making changes while pagination is in progress.

       However,	the results from ListResourceRecordSets	are consistent within
       a page. If MakeChange calls are taking place concurrently, the result
       of each one will	either be completely visible in	your results or	not at
       all. You	will not see partial changes, or changes that do not
       ultimately succeed. (This follows from the fact that MakeChange is
       atomic)

       The results from	ListResourceRecordSets are strongly consistent with
       ChangeResourceRecordSets. To be precise,	if a single process makes a
       call to ChangeResourceRecordSets	and receives a successful response,
       the effects of that change will be visible in a subsequent call to
       ListResourceRecordSets by that process.

   ListReusableDelegationSets([Marker => Str, MaxItems => Str])
       Each argument is	described in detail in:
       Paws::Route53::ListReusableDelegationSets

       Returns:	a Paws::Route53::ListReusableDelegationSetsResponse instance

       To retrieve a list of your reusable delegation sets, send a "GET"
       request to the "2013-04-01/delegationset" resource. The response	to
       this request includes a "DelegationSets"	element	with zero, one,	or
       multiple	"DelegationSet"	child elements.	By default, the	list of
       delegation sets is displayed on a single	page. You can control the
       length of the page that is displayed by using the "MaxItems" parameter.
       You can use the "Marker"	parameter to control the delegation set	that
       the list	begins with.

       Amazon Route 53 returns a maximum of 100	items. If you set MaxItems to
       a value greater than 100, Amazon	Route 53 returns only the first	100.

   ListTagsForResource(ResourceId => Str, ResourceType => Str)
       Each argument is	described in detail in:
       Paws::Route53::ListTagsForResource

       Returns:	a Paws::Route53::ListTagsForResourceResponse instance

   ListTagsForResources(ResourceType =>	Str)
       Each argument is	described in detail in:
       Paws::Route53::ListTagsForResources

       Returns:	a Paws::Route53::ListTagsForResourcesResponse instance

   UpdateHealthCheck(HealthCheckId => Str, [FailureThreshold =>	Int,
       FullyQualifiedDomainName	=> Str,	HealthCheckVersion => Int, IPAddress
       => Str, Port => Int, ResourcePath => Str, SearchString => Str])
       Each argument is	described in detail in:
       Paws::Route53::UpdateHealthCheck

       Returns:	a Paws::Route53::UpdateHealthCheckResponse instance

       This action updates an existing health check.

       To update a health check, send a	"POST" request to the
       "2013-04-01/healthcheck/health check ID"	resource. The request body
       must include an XML document with an "UpdateHealthCheckRequest"
       element.	The response returns an	"UpdateHealthCheckResponse" element,
       which contains metadata about the health	check.

   UpdateHostedZoneComment(Id => Str, [Comment => Str])
       Each argument is	described in detail in:
       Paws::Route53::UpdateHostedZoneComment

       Returns:	a Paws::Route53::UpdateHostedZoneCommentResponse instance

       To update the hosted zone comment, send a "POST"	request	to the
       "2013-04-01/hostedzone/hosted zone ID" resource.	The request body must
       include an XML document with a "UpdateHostedZoneCommentRequest"
       element.	The response to	this request includes the modified
       "HostedZone" element.

       The comment can have a maximum length of	256 characters.

SEE ALSO
       This service class forms	part of	Paws

BUGS and CONTRIBUTIONS
       The source code is located here:	https://github.com/pplu/aws-sdk-perl

       Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

perl v5.32.1			  2015-08-06		      Paws::Route53(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | SEE ALSO | BUGS and CONTRIBUTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::Route53&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help