Amazon Route 53 Domains

The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).

Parameters:

• DomainName (string): The basis for your domain suggestion search, a string with (or without) top-level domain specified.

• SuggestionCount (int): The number of domain suggestions to be returned, maximum 50, minimum 1.

• OnlyAvailable (bool): If true, availability check will be performed on suggestion results, and only available domains will be returned. If false, suggestions will be returned without checking whether the domain is actually available, and caller will have to call checkDomainAvailability for each suggestion to determine availability for registration.

Request Syntax

client.get_domain_suggestions(
    DomainName='string',
    SuggestionCount=123,
    OnlyAvailable=True|False
)

type DomainName

string

param DomainName

[REQUIRED]

type SuggestionCount

integer

param SuggestionCount

[REQUIRED]

type OnlyAvailable

boolean

param OnlyAvailable

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'SuggestionsList': [
        {
            'DomainName': 'string',
            'Availability': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • SuggestionsList (list) --

    • (dict) --

      • DomainName (string) --

      • Availability (string) --

This operation returns all the domain-related billing records for the current AWS account for a specified period

Request Syntax

client.view_billing(
    Start=datetime(2015, 1, 1),
    End=datetime(2015, 1, 1),
    Marker='string',
    MaxItems=123
)

type Start

datetime

param Start

The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.

Type: Double

Default: None

Required: Yes

type End

datetime

param End

The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.

Type: Double

Default: None

Required: Yes

type Marker

string

param Marker

For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for MaxItems , you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

Required: No

type MaxItems

integer

param MaxItems

The number of billing records to be returned.

Type: Integer

Default: 20

Constraints: A value between 1 and 100.

Required: No

rtype

dict

returns

Response Syntax

{
    'NextPageMarker': 'string',
    'BillingRecords': [
        {
            'DomainName': 'string',
            'Operation': 'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK',
            'InvoiceId': 'string',
            'BillDate': datetime(2015, 1, 1),
            'Price': 123.0
        },
    ]
}

Response Structure

• (dict) --

  The ViewBilling response includes the following elements.

  • NextPageMarker (string) --

    If there are more billing records than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker .

    Type: String

    Parent: BillingRecords

  • BillingRecords (list) --

    A summary of billing records.

    Type: Complex type containing a list of billing record summaries.

    Children: DomainName , Operation , InvoiceId , BillDate and Price

    • (dict) --

      • DomainName (string) --

        The name of a domain.

        Type: String

      • Operation (string) --

        The operation that you were charged for.

        Type: String

        Valid values:

        • REGISTER_DOMAIN

        • TRANSFER_IN_DOMAIN

        • RENEW_DOMAIN

        • CHANGE_DOMAIN_OWNER

      • InvoiceId (string) --

        The ID of the invoice that is associated with the billing record.

        Type: String

      • BillDate (datetime) --

        The date that the operation was billed, in Unix format.

        Type: Double

      • Price (float) --

        The price that you were charged for the operation, in US dollars.

        Type: Double

        Example value: 12.0

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 documentation.

Request Syntax

client.renew_domain(
    DomainName='string',
    DurationInYears=123,
    CurrentExpiryYear=123
)

type DomainName

string

param DomainName

[REQUIRED]

type DurationInYears

integer

param DurationInYears

The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 documentation.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: No

type CurrentExpiryYear

integer

param CurrentExpiryYear

[REQUIRED]

The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.

Type: Integer

Default: None

Valid values: Integer

Required: Yes

rtype

dict

returns

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

• (dict) --

  • OperationId (string) --