Menu
AWS Elastic Beanstalk
API Reference (API Version 2010-12-01)

CheckDNSAvailability

Checks if the specified CNAME is available.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CNAMEPrefix

The prefix used when this CNAME is reserved.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 63.

Required: Yes

Response Elements

The following elements are returned by the service.

Available

Indicates if the specified CNAME is available:

  • true : The CNAME is available.

  • false : The CNAME is not available.

Type: Boolean

FullyQualifiedCNAME

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Errors

For information about the errors that are common to all actions, see Common Errors.

Example

Sample Request

https://elasticbeanstalk.us-west-2.amazonaws.com/?CNAMEPrefix=sampleapplication
&Operation=CheckDNSAvailability
&AuthParams
        

Sample Response

<CheckDNSAvailabilityResponse xmlns="https://elasticbeanstalk.amazonaws.com/docs/2010-12-01/">
  <CheckDNSAvailabilityResult>
    <FullyQualifiedCNAME>sampleapplication.elasticbeanstalk.amazonaws.com</FullyQualifiedCNAME>
    <Available>true</Available>
  </CheckDNSAvailabilityResult>
  <ResponseMetadata>
    <RequestId>12f6701f-f1d6-11df-8a78-9f77047e0d0c</RequestId>
  </ResponseMetadata>
</CheckDNSAvailabilityResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: