Class Route53Client
Client to interact with Amazon Route 53
- Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
- Guzzle\Http\Client implements Guzzle\Http\ClientInterface
- Guzzle\Service\Client implements Guzzle\Service\ClientInterface
- Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
- Aws\Route53\Route53Client
Methods summary
-
public static
factory ( array|Collection $config = array() )
Factory method to create a new Amazon Glacier client using an array of configuration options.
-
public
getServerTime ( )
Retrieves the server time from Route53. Can be useful for detecting and/or preventing clock skew.
-
public static
cleanId ( string $id )
Filter function used to remove ID prefixes. This is used automatically by the client so that Hosted Zone and Change Record IDs can be specified with or without the prefix.
-
public
associateVPCWithHostedZone ( array $args = array() )
Executes the AssociateVPCWithHostedZone operation.
-
public
changeResourceRecordSets ( array $args = array() )
Executes the ChangeResourceRecordSets operation.
-
public
changeTagsForResource ( array $args = array() )
Executes the ChangeTagsForResource operation.
-
public
createHealthCheck ( array $args = array() )
Executes the CreateHealthCheck operation.
-
public
createHostedZone ( array $args = array() )
Executes the CreateHostedZone operation.
-
public
createReusableDelegationSet ( array $args = array() )
Executes the CreateReusableDelegationSet operation.
-
public
deleteHealthCheck ( array $args = array() )
Executes the DeleteHealthCheck operation.
-
public
deleteHostedZone ( array $args = array() )
Executes the DeleteHostedZone operation.
-
public
deleteReusableDelegationSet ( array $args = array() )
Executes the DeleteReusableDelegationSet operation.
-
public
disassociateVPCFromHostedZone ( array $args = array() )
Executes the DisassociateVPCFromHostedZone operation.
-
public
getChange ( array $args = array() )
Executes the GetChange operation.
-
public
getCheckerIpRanges ( array $args = array() )
Executes the GetCheckerIpRanges operation.
-
public
getGeoLocation ( array $args = array() )
Executes the GetGeoLocation operation.
-
public
getHealthCheck ( array $args = array() )
Executes the GetHealthCheck operation.
-
public
getHealthCheckCount ( array $args = array() )
Executes the GetHealthCheckCount operation.
-
public
getHealthCheckLastFailureReason ( array $args = array() )
Executes the GetHealthCheckLastFailureReason operation.
-
public
getHealthCheckStatus ( array $args = array() )
Executes the GetHealthCheckStatus operation.
-
public
getHostedZone ( array $args = array() )
Executes the GetHostedZone operation.
-
public
getHostedZoneCount ( array $args = array() )
Executes the GetHostedZoneCount operation.
-
public
getReusableDelegationSet ( array $args = array() )
Executes the GetReusableDelegationSet operation.
-
public
listGeoLocations ( array $args = array() )
Executes the ListGeoLocations operation.
-
public
listHealthChecks ( array $args = array() )
Executes the ListHealthChecks operation.
-
public
listHostedZones ( array $args = array() )
Executes the ListHostedZones operation.
-
public
listHostedZonesByName ( array $args = array() )
Executes the ListHostedZonesByName operation.
-
public
listResourceRecordSets ( array $args = array() )
Executes the ListResourceRecordSets operation.
-
public
listReusableDelegationSets ( array $args = array() )
Executes the ListReusableDelegationSets operation.
-
public
listTagsForResource ( array $args = array() )
Executes the ListTagsForResource operation.
-
public
listTagsForResources ( array $args = array() )
Executes the ListTagsForResources operation.
-
public
updateHealthCheck ( array $args = array() )
Executes the UpdateHealthCheck operation.
-
public
updateHostedZoneComment ( array $args = array() )
Executes the UpdateHostedZoneComment operation.
-
public
getListHealthChecksIterator ( array $args = array() )
The input array uses the parameters of the ListHealthChecks operation
-
public
getListHostedZonesIterator ( array $args = array() )
The input array uses the parameters of the ListHostedZones operation
-
public
getListResourceRecordSetsIterator ( array $args = array() )
The input array uses the parameters of the ListResourceRecordSets operation
Methods detail
public static
Aws\Route53\Route53Client
factory( array|Guzzle\Common\Collection
$config = array() )
Factory method to create a new Amazon Glacier client using an array of configuration options.
Parameters
- $config
array|
Guzzle\Common\Collection
$config Client configuration data
Returns
Link
Overrides
Retrieves the server time from Route53. Can be useful for detecting and/or preventing clock skew.
Returns
Link
Filter function used to remove ID prefixes. This is used automatically by the client so that Hosted Zone and Change Record IDs can be specified with or without the prefix.
Parameters
- $id
string
$id The ID value to clean
Returns
string
Executes the AssociateVPCWithHostedZone operation.
This action associates a VPC with an hosted zone.
To associate a VPC with an hosted zone, send a
Examples
- Basic formatting example
$result = $client->associateVPCWithHostedZone(array( // HostedZoneId is required 'HostedZoneId' => 'string', // VPC is required 'VPC' => array( 'VPCRegion' => 'string', 'VPCId' => 'string', ), 'Comment' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HostedZoneId => (string)The ID of the hosted zone you want to associate your VPC with.
Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.
-
VPC => (associative-array)The VPC that you want your hosted zone to be associated with.
-
VPCRegion => (string:us-east-1 |us-west-1 |us-west-2 |eu-west-1 |eu-central-1 |ap-southeast-1 |ap-southeast-2 |ap-northeast-1 |sa-east-1 |cn-north-1 ) -
VPCId => (string)A VPC ID
-
-
Comment => (string)Optional: Any comments you want to include about a AssociateVPCWithHostedZoneRequest.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ChangeInfo => (associative-array)A complex type that contains the ID, the status, and the date and time of your AssociateVPCWithHostedZoneRequest.
-
Id => (string)The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
-
Status => (string)The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
-
SubmittedAt => (string)The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
Comment => (string)A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
-
-
RequestId => ()Request ID of the operation
Executes the ChangeResourceRecordSets operation.
Use this action to create or change your authoritative DNS information. To
use this action, send a
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.
In response to a
Note the following limitations on a
- 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
Examples
- Basic formatting example
$result = $client->changeResourceRecordSets(array( // HostedZoneId is required 'HostedZoneId' => 'string', // ChangeBatch is required 'ChangeBatch' => array( 'Comment' => 'string', // Changes is required 'Changes' => array( array( // Action is required 'Action' => 'string', // ResourceRecordSet is required 'ResourceRecordSet' => array( // Name is required 'Name' => 'string', // Type is required 'Type' => 'string', 'SetIdentifier' => 'string', 'Weight' => integer, 'Region' => 'string', 'GeoLocation' => array( 'ContinentCode' => 'string', 'CountryCode' => 'string', 'SubdivisionCode' => 'string', ), 'Failover' => 'string', 'TTL' => integer, 'ResourceRecords' => array( array( // Value is required 'Value' => 'string', ), // ... repeated ), 'AliasTarget' => array( // HostedZoneId is required 'HostedZoneId' => 'string', // DNSName is required 'DNSName' => 'string', // EvaluateTargetHealth is required 'EvaluateTargetHealth' => true || false, ), 'HealthCheckId' => 'string', ), ), // ... repeated ), ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HostedZoneId => (string)The ID of the hosted zone that contains the resource record sets that you want to change.
-
ChangeBatch => (associative-array)A complex type that contains an optional comment and the Changes element.
-
Comment => (string)Optional: Any comments you want to include about a change batch request.
-
Changes => (array<associative-array>)A complex type that contains one Change element for each resource record set that you want to create or delete.
- (associative-array)
A complex type that contains the information for each change in a change batch request.
-
Action => (string:CREATE |DELETE |UPSERT )The action to perform.
Valid values: CREATE | DELETE | UPSERT
-
ResourceRecordSet => (associative-array)Information about the resource record set to create or delete.
-
Name => (string)The domain name of the current resource record set.
-
Type => (string:SOA |A |TXT |NS |CNAME |MX |PTR |SRV |SPF |AAAA )The type of the current resource record set.
-
SetIdentifier => (string)Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.
-
Weight => (int)Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.
-
Region => (string:us-east-1 |us-west-1 |us-west-2 |eu-west-1 |eu-central-1 |ap-southeast-1 |ap-southeast-2 |ap-northeast-1 |sa-east-1 |cn-north-1 )Latency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
-
GeoLocation => (associative-array)Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
-
ContinentCode => (string)The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
-
CountryCode => (string)The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
-
SubdivisionCode => (string)The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
-
-
Failover => (string:PRIMARY |SECONDARY )Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.
Valid values: PRIMARY | SECONDARY
-
TTL => (int)The cache time to live for the current resource record set.
-
ResourceRecords => (array<associative-array>)A complex type that contains the resource records for the current resource record set.
- (associative-array)
A complex type that contains the value of the Value element for the current resource record set.
-
Value => (string)The value of the Value element for the current resource record set.
-
- (associative-array)
-
AliasTarget => (associative-array)Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
-
HostedZoneId => (string)Alias resource record sets only: The value of the hosted zone ID for the AWS resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
. -
DNSName => (string)Alias resource record sets only: The external DNS name associated with the AWS Resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
. -
EvaluateTargetHealth => (bool)Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
-
-
HealthCheckId => (string)Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.
-
-
- (associative-array)
-
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ChangeInfo => (associative-array)A complex type that contains information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
-
Id => (string)The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
-
Status => (string)The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
-
SubmittedAt => (string)The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
Comment => (string)A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
-
-
RequestId => ()Request ID of the operation
Executes the ChangeTagsForResource operation.
Examples
- Basic formatting example
$result = $client->changeTagsForResource(array( // ResourceType is required 'ResourceType' => 'string', // ResourceId is required 'ResourceId' => 'string', 'AddTags' => array( array( 'Key' => 'string', 'Value' => 'string', ), // ... repeated ), 'RemoveTagKeys' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
ResourceType => (string:healthcheck |hostedzone )The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
-
ResourceId => (string)The ID of the resource for which you want to add, change, or delete tags.
-
AddTags => (array<associative-array>)A complex type that contains a list of Tag elements. Each Tag element identifies a tag that you want to add or update for the specified resource.
- (associative-array)
A single tag containing a key and value.
-
Key => (string)The key for a Tag.
-
Value => (string)The value for a Tag.
-
- (associative-array)
-
RemoveTagKeys => (array<string>)A list of Tag keys that you want to remove from the specified resource.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
RequestId => ()Request ID of the operation
Executes the CreateHealthCheck operation.
This action creates a new health check.
To create a new health check, send a
Examples
- Basic formatting example
$result = $client->createHealthCheck(array( // CallerReference is required 'CallerReference' => 'string', // HealthCheckConfig is required 'HealthCheckConfig' => array( 'IPAddress' => 'string', 'Port' => integer, // Type is required 'Type' => 'string', 'ResourcePath' => 'string', 'FullyQualifiedDomainName' => 'string', 'SearchString' => 'string', 'RequestInterval' => integer, 'FailureThreshold' => integer, 'MeasureLatency' => true || false, 'Inverted' => true || false, 'HealthThreshold' => integer, 'ChildHealthChecks' => array('string', ... ), ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string)A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
-
HealthCheckConfig => (associative-array)A complex type that contains health check configuration.
-
IPAddress => (string)IP Address of the instance being checked.
-
Port => (int)Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
-
Type => (string:HTTP |HTTPS |HTTP_STR_MATCH |HTTPS_STR_MATCH |TCP )The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
-
ResourcePath => (string)Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
-
FullyQualifiedDomainName => (string)Fully qualified domain name of the instance to be health checked.
-
SearchString => (string)A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
-
RequestInterval => (int)The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
-
FailureThreshold => (int)The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
-
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HealthCheck => (associative-array)A complex type that contains identifying information about the health check.
-
Id => (string)The ID of the specified health check.
-
CallerReference => (string)A unique string that identifies the request to create the health check.
-
HealthCheckConfig => (associative-array)A complex type that contains the health check configuration.
-
IPAddress => (string)IP Address of the instance being checked.
-
Port => (int)Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
-
Type => (string)The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
-
ResourcePath => (string)Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
-
FullyQualifiedDomainName => (string)Fully qualified domain name of the instance to be health checked.
-
SearchString => (string)A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
-
RequestInterval => (int)The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
-
FailureThreshold => (int)The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
-
-
HealthCheckVersion => (int)The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
-
-
Location => (string)The unique URL representing the new health check.
-
RequestId => ()Request ID of the operation
Executes the CreateHostedZone operation.
This action creates a new hosted zone.
To create a new hosted zone, send a
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
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.
Examples
- Basic formatting example
$result = $client->createHostedZone(array( // Name is required 'Name' => 'string', 'VPC' => array( 'VPCRegion' => 'string', 'VPCId' => 'string', ), // CallerReference is required 'CallerReference' => 'string', 'HostedZoneConfig' => array( 'Comment' => 'string', 'PrivateZone' => true || false, ), 'DelegationSetId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Name => (string)The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
-
VPC => (associative-array)The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.
-
VPCRegion => (string:us-east-1 |us-west-1 |us-west-2 |eu-west-1 |eu-central-1 |ap-southeast-1 |ap-southeast-2 |ap-northeast-1 |sa-east-1 |cn-north-1 ) -
VPCId => (string)A VPC ID
-
-
CallerReference => (string)A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
-
HostedZoneConfig => (associative-array)A complex type that contains an optional comment about your hosted zone.
-
Comment => (string)An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
-
PrivateZone => (bool)A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
-
-
DelegationSetId => (string)The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HostedZone => (associative-array)A complex type that contains identifying information about the hosted zone.
-
Id => (string)The ID of the specified hosted zone.
-
Name => (string)The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
-
CallerReference => (string)A unique string that identifies the request to create the hosted zone.
-
Config => (associative-array)A complex type that contains the Comment element.
-
Comment => (string)An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
-
PrivateZone => (bool)A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
-
-
ResourceRecordSetCount => (int)Total number of resource record sets in the hosted zone.
-
-
ChangeInfo => (associative-array)A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.
-
Id => (string)The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
-
Status => (string)The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
-
SubmittedAt => (string)The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
Comment => (string)A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
-
-
DelegationSet => (associative-array)A complex type that contains name server information.
-
Id => (string) -
CallerReference => (string) -
NameServers => (array<string>)A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
-
-
VPC => (associative-array)-
VPCRegion => (string) -
VPCId => (string)A VPC ID
-
-
Location => (string)The unique URL representing the new hosted zone.
-
RequestId => ()Request ID of the operation
Executes the CreateReusableDelegationSet operation.
This action creates a reusable delegationSet.
To create a new reusable delegationSet, send a
If the optional parameter HostedZoneId is specified, it marks the delegationSet associated with that particular hosted zone as reusable.
Examples
- Basic formatting example
$result = $client->createReusableDelegationSet(array( // CallerReference is required 'CallerReference' => 'string', 'HostedZoneId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
CallerReference => (string)A unique string that identifies the request and that allows failed CreateReusableDelegationSet requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a reusable delegation set. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration01.
Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.
-
HostedZoneId => (string)The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
DelegationSet => (associative-array)A complex type that contains name server information.
-
Id => (string) -
CallerReference => (string) -
NameServers => (array<string>)A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
-
-
Location => (string)The unique URL representing the new reusbale delegation set.
-
RequestId => ()Request ID of the operation
Executes the DeleteHealthCheck operation.
This action deletes a health check. To delete a health check, send a
Examples
- Basic formatting example
$result = $client->deleteHealthCheck(array( // HealthCheckId is required 'HealthCheckId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HealthCheckId => (string)The ID of the health check to delete.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
RequestId => ()Request ID of the operation
Executes the DeleteHostedZone operation.
This action deletes a hosted zone. To delete a hosted zone, send a
For more information about deleting a hosted zone, see Deleting a Hosted Zone in the Amazon Route 53 Developer Guide.
Examples
- Basic formatting example
$result = $client->deleteHostedZone(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)The ID of the hosted zone you want to delete.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ChangeInfo => (associative-array)A complex type that contains the ID, the status, and the date and time of your delete request.
-
Id => (string)The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
-
Status => (string)The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
-
SubmittedAt => (string)The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
Comment => (string)A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
-
-
RequestId => ()Request ID of the operation
Executes the DeleteReusableDelegationSet operation.
This action deletes a reusable delegation set. To delete a reusable
delegation set, send a
Examples
- Basic formatting example
$result = $client->deleteReusableDelegationSet(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)The ID of the reusable delegation set you want to delete.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
RequestId => ()Request ID of the operation
Executes the DisassociateVPCFromHostedZone operation.
This action disassociates a VPC from an hosted zone.
To disassociate a VPC to a hosted zone, send a
Examples
- Basic formatting example
$result = $client->disassociateVPCFromHostedZone(array( // HostedZoneId is required 'HostedZoneId' => 'string', // VPC is required 'VPC' => array( 'VPCRegion' => 'string', 'VPCId' => 'string', ), 'Comment' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HostedZoneId => (string)The ID of the hosted zone you want to disassociate your VPC from.
Note that you cannot disassociate the last VPC from a hosted zone.
-
VPC => (associative-array)The VPC that you want your hosted zone to be disassociated from.
-
VPCRegion => (string:us-east-1 |us-west-1 |us-west-2 |eu-west-1 |eu-central-1 |ap-southeast-1 |ap-southeast-2 |ap-northeast-1 |sa-east-1 |cn-north-1 ) -
VPCId => (string)A VPC ID
-
-
Comment => (string)Optional: Any comments you want to include about a DisassociateVPCFromHostedZoneRequest.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ChangeInfo => (associative-array)A complex type that contains the ID, the status, and the date and time of your DisassociateVPCFromHostedZoneRequest.
-
Id => (string)The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
-
Status => (string)The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
-
SubmittedAt => (string)The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
Comment => (string)A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
-
-
RequestId => ()Request ID of the operation
Executes the GetChange operation.
This action returns the current status of a change batch request. The status is one of the following values:
-
-
Examples
- Basic formatting example
$result = $client->getChange(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ChangeInfo => (associative-array)A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.
-
Id => (string)The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
-
Status => (string)The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
-
SubmittedAt => (string)The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
Comment => (string)A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
-
-
RequestId => ()Request ID of the operation
Executes the GetCheckerIpRanges operation.
To retrieve a list of the IP ranges used by Amazon Route 53 health checkers
to check the health of your resources, send a
Examples
- Basic formatting example
$result = $client->getCheckerIpRanges(array( ));
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
CheckerIpRanges => (array<string>)A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
-
RequestId => ()Request ID of the operation
Executes the GetGeoLocation operation.
To retrieve a single geo location, send a
Examples
- Basic formatting example
$result = $client->getGeoLocation(array( 'ContinentCode' => 'string', 'CountryCode' => 'string', 'SubdivisionCode' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
ContinentCode => (string)The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
-
CountryCode => (string)The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
-
SubdivisionCode => (string)The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
GeoLocationDetails => (associative-array)A complex type that contains the information about the specified geo location.
-
ContinentCode => (string)The code for a continent geo location. Note: only continent locations have a continent code.
-
ContinentName => (string)The name of the continent. This element is only present if ContinentCode is also present.
-
CountryCode => (string)The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
-
CountryName => (string)The name of the country. This element is only present if CountryCode is also present.
-
SubdivisionCode => (string)The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
-
SubdivisionName => (string)The name of the subdivision. This element is only present if SubdivisionCode is also present.
-
-
RequestId => ()Request ID of the operation
Executes the GetHealthCheck operation.
To retrieve the health check, send a
Examples
- Basic formatting example
$result = $client->getHealthCheck(array( // HealthCheckId is required 'HealthCheckId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HealthCheckId => (string)The ID of the health check to retrieve.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HealthCheck => (associative-array)A complex type that contains the information about the specified health check.
-
Id => (string)The ID of the specified health check.
-
CallerReference => (string)A unique string that identifies the request to create the health check.
-
HealthCheckConfig => (associative-array)A complex type that contains the health check configuration.
-
IPAddress => (string)IP Address of the instance being checked.
-
Port => (int)Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
-
Type => (string)The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
-
ResourcePath => (string)Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
-
FullyQualifiedDomainName => (string)Fully qualified domain name of the instance to be health checked.
-
SearchString => (string)A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
-
RequestInterval => (int)The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
-
FailureThreshold => (int)The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
-
-
HealthCheckVersion => (int)The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
-
-
RequestId => ()Request ID of the operation
Executes the GetHealthCheckCount operation.
To retrieve a count of all your health checks, send a
Examples
- Basic formatting example
$result = $client->getHealthCheckCount(array( ));
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HealthCheckCount => (int)The number of health checks associated with the current AWS account.
-
RequestId => ()Request ID of the operation
Executes the GetHealthCheckLastFailureReason operation.
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
Examples
- Basic formatting example
$result = $client->getHealthCheckLastFailureReason(array( // HealthCheckId is required 'HealthCheckId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HealthCheckId => (string)The ID of the health check for which you want to retrieve the reason for the most recent failure.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HealthCheckObservations => (array<associative-array>)A list that contains one HealthCheckObservation element for each Route 53 health checker.
- (associative-array)
A complex type that contains the IP address of a Route 53 health checker and the reason for the health check status.
-
IPAddress => (string)The IP address of the Route 53 health checker that performed the health check.
-
StatusReport => (associative-array)A complex type that contains information about the health check status for the current observation.
-
Status => (string)The observed health check status.
-
CheckedTime => (string)The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
-
- (associative-array)
-
RequestId => ()Request ID of the operation
Executes the GetHealthCheckStatus operation.
To retrieve the health check status, send a
Examples
- Basic formatting example
$result = $client->getHealthCheckStatus(array( // HealthCheckId is required 'HealthCheckId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HealthCheckId => (string)The ID of the health check for which you want to retrieve the most recent status.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HealthCheckObservations => (array<associative-array>)A list that contains one HealthCheckObservation element for each Route 53 health checker.
- (associative-array)
A complex type that contains the IP address of a Route 53 health checker and the reason for the health check status.
-
IPAddress => (string)The IP address of the Route 53 health checker that performed the health check.
-
StatusReport => (associative-array)A complex type that contains information about the health check status for the current observation.
-
Status => (string)The observed health check status.
-
CheckedTime => (string)The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC), which is synonymous with Greenwich Mean Time in this context.
-
-
- (associative-array)
-
RequestId => ()Request ID of the operation
Executes the GetHostedZone operation.
To retrieve the delegation set for a hosted zone, send a
Examples
- Basic formatting example
$result = $client->getHostedZone(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HostedZone => (associative-array)A complex type that contains the information about the specified hosted zone.
-
Id => (string)The ID of the specified hosted zone.
-
Name => (string)The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
-
CallerReference => (string)A unique string that identifies the request to create the hosted zone.
-
Config => (associative-array)A complex type that contains the Comment element.
-
Comment => (string)An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
-
PrivateZone => (bool)A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
-
-
ResourceRecordSetCount => (int)Total number of resource record sets in the hosted zone.
-
-
DelegationSet => (associative-array)A complex type that contains information about the name servers for the specified hosted zone.
-
Id => (string) -
CallerReference => (string) -
NameServers => (array<string>)A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
-
-
VPCs => (array<associative-array>)A complex type that contains information about VPCs associated with the specified hosted zone.
- (associative-array)
-
VPCRegion => (string) -
VPCId => (string)A VPC ID
-
- (associative-array)
-
RequestId => ()Request ID of the operation
Executes the GetHostedZoneCount operation.
To retrieve a count of all your hosted zones, send a
Examples
- Basic formatting example
$result = $client->getHostedZoneCount(array( ));
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HostedZoneCount => (int)The number of hosted zones associated with the current AWS account.
-
RequestId => ()Request ID of the operation
Executes the GetReusableDelegationSet operation.
To retrieve the reusable delegation set, send a
Examples
- Basic formatting example
$result = $client->getReusableDelegationSet(array( // Id is required 'Id' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)The ID of the reusable delegation set for which you want to get a list of the name server.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
DelegationSet => (associative-array)A complex type that contains the information about the nameservers for the specified delegation set ID.
-
Id => (string) -
CallerReference => (string) -
NameServers => (array<string>)A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
-
-
RequestId => ()Request ID of the operation
Executes the ListGeoLocations operation.
To retrieve a list of supported geo locations, send a
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
Examples
- Basic formatting example
$result = $client->listGeoLocations(array( 'StartContinentCode' => 'string', 'StartCountryCode' => 'string', 'StartSubdivisionCode' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
StartContinentCode => (string)The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
-
StartCountryCode => (string)The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
-
StartSubdivisionCode => (string)The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
-
MaxItems => (string)The maximum number of geo locations you want in the response body.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
GeoLocationDetailsList => (array<associative-array>)A complex type that contains information about the geo locations that are returned by the request.
- (associative-array)
A complex type that contains information about a GeoLocation.
-
ContinentCode => (string)The code for a continent geo location. Note: only continent locations have a continent code.
-
ContinentName => (string)The name of the continent. This element is only present if ContinentCode is also present.
-
CountryCode => (string)The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
-
CountryName => (string)The name of the country. This element is only present if CountryCode is also present.
-
SubdivisionCode => (string)The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
-
SubdivisionName => (string)The name of the subdivision. This element is only present if SubdivisionCode is also present.
-
- (associative-array)
-
IsTruncated => (bool)A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.
Valid Values: true | false
-
NextContinentCode => (string)If the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.
-
NextCountryCode => (string)If the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.
-
NextSubdivisionCode => (string)If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.
-
MaxItems => (string)The maximum number of records you requested. The maximum value of MaxItems is 100.
-
RequestId => ()Request ID of the operation
Executes the ListHealthChecks operation.
To retrieve a list of your health checks, send a
Examples
- Basic formatting example
$result = $client->listHealthChecks(array( 'Marker' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Marker => (string)If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
-
MaxItems => (string)Specify the maximum number of health checks to return per page of results.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HealthChecks => (array<associative-array>)A complex type that contains information about the health checks associated with the current AWS account.
- (associative-array)
A complex type that contains identifying information about the health check.
-
Id => (string)The ID of the specified health check.
-
CallerReference => (string)A unique string that identifies the request to create the health check.
-
HealthCheckConfig => (associative-array)A complex type that contains the health check configuration.
-
IPAddress => (string)IP Address of the instance being checked.
-
Port => (int)Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
-
Type => (string)The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
-
ResourcePath => (string)Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
-
FullyQualifiedDomainName => (string)Fully qualified domain name of the instance to be health checked.
-
SearchString => (string)A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
-
RequestInterval => (int)The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
-
FailureThreshold => (int)The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
-
-
HealthCheckVersion => (int)The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
-
- (associative-array)
-
Marker => (string)If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
-
IsTruncated => (bool)A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
-
NextMarker => (string)Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.
-
MaxItems => (string)The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of ListHealthChecksResponse$IsTruncated in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.
-
RequestId => ()Request ID of the operation
Executes the ListHostedZones operation.
To retrieve a list of your hosted zones, send a
Examples
- Basic formatting example
$result = $client->listHostedZones(array( 'Marker' => 'string', 'MaxItems' => 'string', 'DelegationSetId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Marker => (string)If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
-
MaxItems => (string)Specify the maximum number of hosted zones to return per page of results.
-
DelegationSetId => (string)
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HostedZones => (array<associative-array>)A complex type that contains information about the hosted zones associated with the current AWS account.
- (associative-array)
A complex type that contain information about the specified hosted zone.
-
Id => (string)The ID of the specified hosted zone.
-
Name => (string)The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
-
CallerReference => (string)A unique string that identifies the request to create the hosted zone.
-
Config => (associative-array)A complex type that contains the Comment element.
-
Comment => (string)An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
-
PrivateZone => (bool)A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
-
-
ResourceRecordSetCount => (int)Total number of resource record sets in the hosted zone.
-
- (associative-array)
-
Marker => (string)If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
-
IsTruncated => (bool)A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
-
NextMarker => (string)Indicates where to continue listing hosted zones. If ListHostedZonesResponse$IsTruncated is true, make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.
-
MaxItems => (string)The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesResponse$IsTruncated in the response is true. Call ListHostedZones again and specify the value of ListHostedZonesResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.
-
RequestId => ()Request ID of the operation
Executes the ListHostedZonesByName operation.
To retrieve a list of your hosted zones in lexicographic order, send a
Examples
- Basic formatting example
$result = $client->listHostedZonesByName(array( 'DNSName' => 'string', 'HostedZoneId' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
DNSName => (string)The first name in the lexicographic ordering of domain names that you want the ListHostedZonesByNameRequest request to list.
If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.
-
HostedZoneId => (string)If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.
-
MaxItems => (string)Specify the maximum number of hosted zones to return per page of results.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HostedZones => (array<associative-array>)A complex type that contains information about the hosted zones associated with the current AWS account.
- (associative-array)
A complex type that contain information about the specified hosted zone.
-
Id => (string)The ID of the specified hosted zone.
-
Name => (string)The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
-
CallerReference => (string)A unique string that identifies the request to create the hosted zone.
-
Config => (associative-array)A complex type that contains the Comment element.
-
Comment => (string)An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
-
PrivateZone => (bool)A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
-
-
ResourceRecordSetCount => (int)Total number of resource record sets in the hosted zone.
-
- (associative-array)
-
DNSName => (string)The DNSName value sent in the request.
-
HostedZoneId => (string)The HostedZoneId value sent in the request.
-
IsTruncated => (bool)A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the NextDNSName and NextHostedZoneId elements.
Valid Values: true | false
-
NextDNSName => (string)If ListHostedZonesByNameResponse$IsTruncated is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of ListHostedZonesByNameResponse$NextDNSName in the ListHostedZonesByNameRequest$DNSName element and ListHostedZonesByNameResponse$NextHostedZoneId in the ListHostedZonesByNameRequest$HostedZoneId element.
-
NextHostedZoneId => (string)If ListHostedZonesByNameResponse$IsTruncated is true, there are more hosted zones associated with the current AWS account. To get the next page of results, make another request to ListHostedZonesByName. Specify the value of ListHostedZonesByNameResponse$NextDNSName in the ListHostedZonesByNameRequest$DNSName element and ListHostedZonesByNameResponse$NextHostedZoneId in the ListHostedZonesByNameRequest$HostedZoneId element.
-
MaxItems => (string)The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesByNameResponse$IsTruncated in the response is true. Call ListHostedZonesByName again and specify the value of ListHostedZonesByNameResponse$NextDNSName and ListHostedZonesByNameResponse$NextHostedZoneId elements respectively to get the next page of results.
-
RequestId => ()Request ID of the operation
Executes the ListResourceRecordSets operation.
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:
- If both Name and Type are omitted, this means start the results at the first RRSET in the HostedZone.
- 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.
- 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.
- 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.
Examples
- Basic formatting example
$result = $client->listResourceRecordSets(array( // HostedZoneId is required 'HostedZoneId' => 'string', 'StartRecordName' => 'string', 'StartRecordType' => 'string', 'StartRecordIdentifier' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HostedZoneId => (string)The ID of the hosted zone that contains the resource record sets that you want to get.
-
StartRecordName => (string)The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.
-
StartRecordType => (string:SOA |A |TXT |NS |CNAME |MX |PTR |SRV |SPF |AAAA )The DNS type at which to begin the listing of resource record sets.
Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT
Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT
Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT
Values for Alias Resource Record Sets: A | AAAA
Constraint: Specifying type without specifying name returns an InvalidInput error.
-
StartRecordIdentifier => (string)Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.
-
MaxItems => (string)The maximum number of records you want in the response body.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ResourceRecordSets => (array<associative-array>)A complex type that contains information about the resource record sets that are returned by the request.
- (associative-array)
A complex type that contains information about the current resource record set.
-
Name => (string)The domain name of the current resource record set.
-
Type => (string)The type of the current resource record set.
-
SetIdentifier => (string)Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type.
-
Weight => (int)Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines what portion of traffic for the current resource record set is routed to the associated location.
-
Region => (string)Latency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
-
GeoLocation => (associative-array)Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
-
ContinentCode => (string)The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
-
CountryCode => (string)The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
-
SubdivisionCode => (string)The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
-
-
Failover => (string)Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.
Valid values: PRIMARY | SECONDARY
-
TTL => (int)The cache time to live for the current resource record set.
-
ResourceRecords => (array<associative-array>)A complex type that contains the resource records for the current resource record set.
- (associative-array)
A complex type that contains the value of the Value element for the current resource record set.
-
Value => (string)The value of the Value element for the current resource record set.
-
- (associative-array)
-
AliasTarget => (associative-array)Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
-
HostedZoneId => (string)Alias resource record sets only: The value of the hosted zone ID for the AWS resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
. -
DNSName => (string)Alias resource record sets only: The external DNS name associated with the AWS Resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
. -
EvaluateTargetHealth => (bool)Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
-
-
HealthCheckId => (string)Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.
-
- (associative-array)
-
IsTruncated => (bool)A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.
Valid Values: true | false
-
NextRecordName => (string)If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
-
NextRecordType => (string)If the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.
-
NextRecordIdentifier => (string)Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.
-
MaxItems => (string)The maximum number of records you requested. The maximum value of MaxItems is 100.
-
RequestId => ()Request ID of the operation
Executes the ListReusableDelegationSets operation.
To retrieve a list of your reusable delegation sets, send a
Examples
- Basic formatting example
$result = $client->listReusableDelegationSets(array( 'Marker' => 'string', 'MaxItems' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Marker => (string)If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
-
MaxItems => (string)Specify the maximum number of reusable delegation sets to return per page of results.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
DelegationSets => (array<associative-array>)A complex type that contains information about the reusable delegation sets associated with the current AWS account.
- (associative-array)
A complex type that contains name server information.
-
Id => (string) -
CallerReference => (string) -
NameServers => (array<string>)A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.
-
- (associative-array)
-
Marker => (string)If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.
-
IsTruncated => (bool)A flag indicating whether there are more reusable delegation sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.
Valid Values: true | false
-
NextMarker => (string)Indicates where to continue listing reusable delegation sets. If ListReusableDelegationSetsResponse$IsTruncated is true, make another request to ListReusableDelegationSets and include the value of the NextMarker element in the Marker element to get the next page of results.
-
MaxItems => (string)The maximum number of reusable delegation sets to be included in the response body. If the number of reusable delegation sets associated with this AWS account exceeds MaxItems, the value of ListReusablDelegationSetsResponse$IsTruncated in the response is true. Call ListReusableDelegationSets again and specify the value of ListReusableDelegationSetsResponse$NextMarker in the ListReusableDelegationSetsRequest$Marker element to get the next page of results.
-
RequestId => ()Request ID of the operation
Executes the ListTagsForResource operation.
Examples
- Basic formatting example
$result = $client->listTagsForResource(array( // ResourceType is required 'ResourceType' => 'string', // ResourceId is required 'ResourceId' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
ResourceType => (string:healthcheck |hostedzone )The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
-
ResourceId => (string)The ID of the resource for which you want to retrieve tags.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ResourceTagSet => (associative-array)A ResourceTagSet containing tags associated with the specified resource.
-
ResourceType => (string)The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
-
ResourceId => (string)The ID for the specified resource.
-
Tags => (array<associative-array>)The tags associated with the specified resource.
- (associative-array)
A single tag containing a key and value.
-
Key => (string)The key for a Tag.
-
Value => (string)The value for a Tag.
-
- (associative-array)
-
-
RequestId => ()Request ID of the operation
Executes the ListTagsForResources operation.
Examples
- Basic formatting example
$result = $client->listTagsForResources(array( // ResourceType is required 'ResourceType' => 'string', // ResourceIds is required 'ResourceIds' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
ResourceType => (string:healthcheck |hostedzone )The type of the resources.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
-
ResourceIds => (array<string>)A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
ResourceTagSets => (array<associative-array>)A list of ResourceTagSets containing tags associated with the specified resources.
- (associative-array)
A complex type containing a resource and its associated tags.
-
ResourceType => (string)The type of the resource.
- The resource type for health checks is healthcheck.
- The resource type for hosted zones is hostedzone.
-
ResourceId => (string)The ID for the specified resource.
-
Tags => (array<associative-array>)The tags associated with the specified resource.
- (associative-array)
A single tag containing a key and value.
-
Key => (string)The key for a Tag.
-
Value => (string)The value for a Tag.
-
- (associative-array)
-
- (associative-array)
-
RequestId => ()Request ID of the operation
Executes the UpdateHealthCheck operation.
This action updates an existing health check.
To update a health check, send a
Examples
- Basic formatting example
$result = $client->updateHealthCheck(array( // HealthCheckId is required 'HealthCheckId' => 'string', 'HealthCheckVersion' => integer, 'IPAddress' => 'string', 'Port' => integer, 'ResourcePath' => 'string', 'FullyQualifiedDomainName' => 'string', 'SearchString' => 'string', 'FailureThreshold' => integer, 'Inverted' => true || false, 'HealthThreshold' => integer, 'ChildHealthChecks' => array('string', ... ), ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
HealthCheckId => (string)The ID of the health check to update.
-
HealthCheckVersion => (int)Optional. When you specify a health check version, Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.
-
IPAddress => (string)The IP address of the resource that you want to check.
Specify this value only if you want to change it.
-
Port => (int)The port on which you want Route 53 to open a connection to perform health checks.
Specify this value only if you want to change it.
-
ResourcePath => (string)The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.
Specify this value only if you want to change it.
-
FullyQualifiedDomainName => (string)Fully qualified domain name of the instance to be health checked.
Specify this value only if you want to change it.
-
SearchString => (string)If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.
Specify this value only if you want to change it.
-
FailureThreshold => (int)The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
Specify this value only if you want to change it.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HealthCheck => (associative-array)A complex type that contains identifying information about the health check.
-
Id => (string)The ID of the specified health check.
-
CallerReference => (string)A unique string that identifies the request to create the health check.
-
HealthCheckConfig => (associative-array)A complex type that contains the health check configuration.
-
IPAddress => (string)IP Address of the instance being checked.
-
Port => (int)Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
-
Type => (string)The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
-
ResourcePath => (string)Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
-
FullyQualifiedDomainName => (string)Fully qualified domain name of the instance to be health checked.
-
SearchString => (string)A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
-
RequestInterval => (int)The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
-
FailureThreshold => (int)The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
-
-
HealthCheckVersion => (int)The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.
-
-
RequestId => ()Request ID of the operation
Executes the UpdateHostedZoneComment operation.
To update the hosted zone comment, send a
Examples
- Basic formatting example
$result = $client->updateHostedZoneComment(array( // Id is required 'Id' => 'string', 'Comment' => 'string', ));
Parameters
- $args
array
$arg Associative array containing the following keys (required keys are bold):-
Id => (string)The ID of the hosted zone you want to update.
-
Comment => (string)A comment about your hosted zone.
-
Returns
Guzzle\Service\Resource\Model
Returns a response Model object
-
HostedZone => (associative-array)A complex type that contain information about the specified hosted zone.
-
Id => (string)The ID of the specified hosted zone.
-
Name => (string)The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.
-
CallerReference => (string)A unique string that identifies the request to create the hosted zone.
-
Config => (associative-array)A complex type that contains the Comment element.
-
Comment => (string)An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.
-
PrivateZone => (bool)A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
-
-
ResourceRecordSetCount => (int)Total number of resource record sets in the hosted zone.
-
-
RequestId => ()Request ID of the operation
public
Guzzle\Service\Resource\ResourceIteratorInterface
getListHealthChecksIterator( array $args = array() )
The input array uses the parameters of the ListHealthChecks operation
Parameters
- $args
array
$args
Returns
public
Guzzle\Service\Resource\ResourceIteratorInterface
getListHostedZonesIterator( array $args = array() )
The input array uses the parameters of the ListHostedZones operation
Parameters
- $args
array
$args
Returns
public
Guzzle\Service\Resource\ResourceIteratorInterface
getListResourceRecordSetsIterator( array $args = array() )
The input array uses the parameters of the ListResourceRecordSets operation
Parameters
- $args
array
$args
Returns
Methods inherited from Aws\Common\Client\AbstractClient
__call()
,
__construct()
,
createRequest()
,
getAllEvents()
,
getApiVersion()
,
getCredentials()
,
getRegion()
,
getRegions()
,
getSignature()
,
getWaiter()
,
getWaiterFactory()
,
send()
,
setCredentials()
,
setRegion()
,
setWaiterFactory()
,
waitUntil()
Methods inherited from Guzzle\Service\Client
execute()
,
executeMultiple()
,
getCommand()
,
getCommandFactory()
,
getDescription()
,
getInflector()
,
getIterator()
,
getResourceIteratorFactory()
,
prepareCommand()
,
setCommandFactory()
,
setDescription()
,
setInflector()
,
setResourceIteratorFactory()
Methods inherited from Guzzle\Http\Client
delete()
,
expandTemplate()
,
extractPharCacert()
,
get()
,
getBaseUrl()
,
getConfig()
,
getCurlMulti()
,
getDefaultOption()
,
getDefaultUserAgent()
,
getUriTemplate()
,
head()
,
initSsl()
,
options()
,
patch()
,
post()
,
prepareRequest()
,
put()
,
sendMultiple()
,
setBaseUrl()
,
setConfig()
,
setCurlMulti()
,
setDefaultOption()
,
setRequestFactory()
,
setSslVerification()
,
setUriTemplate()
,
setUserAgent()
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber()
,
dispatch()
,
getEventDispatcher()
,
setEventDispatcher()
Magic methods summary
Constants summary
string |
LATEST_API_VERSION |
'2013-04-01' |
Constants inherited from Guzzle\Service\Client
Constants inherited from Guzzle\Http\Client
CURL_OPTIONS
,
DEFAULT_SELECT_TIMEOUT
,
DISABLE_REDIRECTS
,
MAX_HANDLES
,
REQUEST_OPTIONS
,
SSL_CERT_AUTHORITY
Constants inherited from Guzzle\Http\ClientInterface
Properties summary
Properties inherited from Aws\Common\Client\AbstractClient
$aggregator
,
$credentials
,
$signature
,
$waiterFactory
Properties inherited from Guzzle\Service\Client
$commandFactory
,
$inflector
,
$resourceIteratorFactory
,
$serviceDescription
Properties inherited from Guzzle\Http\Client
$defaultHeaders
,
$requestFactory
,
$userAgent