AWS API Changes

2024/12/12 - Amazon Route 53 Domains - 3 updated api methods

Changes This release includes the following API updates: added the enumeration type RESTORE_DOMAIN to the OperationType; constrained the Price attribute to non-negative values; updated the LangCode to allow 2 or 3 alphabetical characters.

GetOperationDetail (updated)

Link ¶
Changes (response)

{'Type': {'RESTORE_DOMAIN'}}

This operation returns the current status of an operation that is not completed.

See also: AWS API Documentation

Request Syntax

client.get_operation_detail(
    OperationId='string'
)

type OperationId:

string

param OperationId:

[REQUIRED]

The identifier for the operation for which you want to get the status. Route 53 returned the identifier in the response to the original request.

rtype:

dict

returns:

Response Syntax

{
    'OperationId': 'string',
    'Status': 'SUBMITTED'|'IN_PROGRESS'|'ERROR'|'SUCCESSFUL'|'FAILED',
    'Message': 'string',
    'DomainName': 'string',
    'Type': 'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK'|'ENABLE_AUTORENEW'|'DISABLE_AUTORENEW'|'ADD_DNSSEC'|'REMOVE_DNSSEC'|'EXPIRE_DOMAIN'|'TRANSFER_OUT_DOMAIN'|'CHANGE_DOMAIN_OWNER'|'RENEW_DOMAIN'|'PUSH_DOMAIN'|'INTERNAL_TRANSFER_OUT_DOMAIN'|'INTERNAL_TRANSFER_IN_DOMAIN'|'RELEASE_TO_GANDI'|'TRANSFER_ON_RENEW'|'RESTORE_DOMAIN',
    'SubmittedDate': datetime(2015, 1, 1),
    'LastUpdatedDate': datetime(2015, 1, 1),
    'StatusFlag': 'PENDING_ACCEPTANCE'|'PENDING_CUSTOMER_ACTION'|'PENDING_AUTHORIZATION'|'PENDING_PAYMENT_VERIFICATION'|'PENDING_SUPPORT_CASE'
}

Response Structure

(dict) --

The GetOperationDetail response includes the following elements.
- OperationId (string) --
  
  The identifier for the operation.
- Status (string) --
  
  The current status of the requested operation in the system.
- Message (string) --
  
  Detailed information on the status including possible errors.
- DomainName (string) --
  
  The name of a domain.
- Type (string) --
  
  The type of operation that was requested.
- SubmittedDate (datetime) --
  
  The date when the request was submitted.
- LastUpdatedDate (datetime) --
  
  The date when the operation was last updated.
- StatusFlag (string) --
  
  Lists any outstanding operations that require customer action. Valid values are:
  - PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
  - PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
  - PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
  - PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
  - PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.

ListOperations (updated)

Link ¶
Changes (request, response)
Request

{'Type': {'RESTORE_DOMAIN'}}

Response

{'Operations': {'Type': {'RESTORE_DOMAIN'}}}

Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.

This command runs only in the us-east-1 Region.

See also: AWS API Documentation

Request Syntax

client.list_operations(
    SubmittedSince=datetime(2015, 1, 1),
    Marker='string',
    MaxItems=123,
    Status=[
        'SUBMITTED'|'IN_PROGRESS'|'ERROR'|'SUCCESSFUL'|'FAILED',
    ],
    Type=[
        'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK'|'ENABLE_AUTORENEW'|'DISABLE_AUTORENEW'|'ADD_DNSSEC'|'REMOVE_DNSSEC'|'EXPIRE_DOMAIN'|'TRANSFER_OUT_DOMAIN'|'CHANGE_DOMAIN_OWNER'|'RENEW_DOMAIN'|'PUSH_DOMAIN'|'INTERNAL_TRANSFER_OUT_DOMAIN'|'INTERNAL_TRANSFER_IN_DOMAIN'|'RELEASE_TO_GANDI'|'TRANSFER_ON_RENEW'|'RESTORE_DOMAIN',
    ],
    SortBy='SubmittedDate',
    SortOrder='ASC'|'DESC'
)

type SubmittedSince:

datetime

param SubmittedSince:

An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).

type Marker:

string

param Marker:

For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

type MaxItems:

integer

param MaxItems:

Number of domains to be returned.

Default: 20

type Status:

list

param Status:

The status of the operations.

(string) --

type Type:

list

param Type:

An arrays of the domains operation types.

(string) --

type SortBy:

string

param SortBy:

The sort type for returned values.

type SortOrder:

string

param SortOrder:

The sort order for returned values, either ascending or descending.

rtype:

dict

returns:

Response Syntax

{
    'Operations': [
        {
            'OperationId': 'string',
            'Status': 'SUBMITTED'|'IN_PROGRESS'|'ERROR'|'SUCCESSFUL'|'FAILED',
            'Type': 'REGISTER_DOMAIN'|'DELETE_DOMAIN'|'TRANSFER_IN_DOMAIN'|'UPDATE_DOMAIN_CONTACT'|'UPDATE_NAMESERVER'|'CHANGE_PRIVACY_PROTECTION'|'DOMAIN_LOCK'|'ENABLE_AUTORENEW'|'DISABLE_AUTORENEW'|'ADD_DNSSEC'|'REMOVE_DNSSEC'|'EXPIRE_DOMAIN'|'TRANSFER_OUT_DOMAIN'|'CHANGE_DOMAIN_OWNER'|'RENEW_DOMAIN'|'PUSH_DOMAIN'|'INTERNAL_TRANSFER_OUT_DOMAIN'|'INTERNAL_TRANSFER_IN_DOMAIN'|'RELEASE_TO_GANDI'|'TRANSFER_ON_RENEW'|'RESTORE_DOMAIN',
            'SubmittedDate': datetime(2015, 1, 1),
            'DomainName': 'string',
            'Message': 'string',
            'StatusFlag': 'PENDING_ACCEPTANCE'|'PENDING_CUSTOMER_ACTION'|'PENDING_AUTHORIZATION'|'PENDING_PAYMENT_VERIFICATION'|'PENDING_SUPPORT_CASE',
            'LastUpdatedDate': datetime(2015, 1, 1)
        },
    ],
    'NextPageMarker': 'string'
}

Response Structure

(dict) --

The ListOperations response includes the following elements.
- Operations (list) --
  
  Lists summaries of the operations.
  - (dict) --
    
    OperationSummary includes the following elements.
    - OperationId (string) --
      
      Identifier returned to track the requested action.
    - Status (string) --
      
      The current status of the requested operation in the system.
    - Type (string) --
      
      Type of the action requested.
    - SubmittedDate (datetime) --
      
      The date when the request was submitted.
    - DomainName (string) --
      
      Name of the domain.
    - Message (string) --
      
      Message about the operation.
    - StatusFlag (string) --
      
      Automatically checks whether there are no outstanding operations on domains that need customer attention.
      
      Valid values are:
      - PENDING_ACCEPTANCE: The operation is waiting for acceptance from the account that is receiving the domain.
      - PENDING_CUSTOMER_ACTION: The operation is waiting for customer action, for example, returning an email.
      - PENDING_AUTHORIZATION: The operation is waiting for the form of authorization. For more information, see ResendOperationAuthorization.
      - PENDING_PAYMENT_VERIFICATION: The operation is waiting for the payment method to validate.
      - PENDING_SUPPORT_CASE: The operation includes a support case and is waiting for its resolution.
    - LastUpdatedDate (datetime) --
      
      The date when the last change was made in Unix time format and Coordinated Universal Time (UTC).
- NextPageMarker (string) --
  
  If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

ViewBilling (updated)

Link ¶
Changes (response)

{'BillingRecords': {'Operation': {'RESTORE_DOMAIN'}}}

Returns all the domain-related billing records for the current Amazon Web Services account for a specified period

See also: AWS API Documentation

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 and time in Unix time format and Coordinated Universal time (UTC).

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 and time in Unix time format and Coordinated Universal time (UTC).

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 Amazon Web Services 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.

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

type MaxItems:

integer

param MaxItems:

The number of billing records to be returned.

Default: 20

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'|'ENABLE_AUTORENEW'|'DISABLE_AUTORENEW'|'ADD_DNSSEC'|'REMOVE_DNSSEC'|'EXPIRE_DOMAIN'|'TRANSFER_OUT_DOMAIN'|'CHANGE_DOMAIN_OWNER'|'RENEW_DOMAIN'|'PUSH_DOMAIN'|'INTERNAL_TRANSFER_OUT_DOMAIN'|'INTERNAL_TRANSFER_IN_DOMAIN'|'RELEASE_TO_GANDI'|'TRANSFER_ON_RENEW'|'RESTORE_DOMAIN',
            '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.
- BillingRecords (list) --
  
  A summary of billing records.
  - (dict) --
    
    Information for one billing record.
    - DomainName (string) --
      
      The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
    - Operation (string) --
      
      The operation that you were charged for.
    - InvoiceId (string) --
      
      The ID of the invoice that is associated with the billing record.
    - BillDate (datetime) --
      
      The date that the operation was billed, in Unix format.
    - Price (float) --
      
      The price that you were charged for the operation, in US dollars.
      
      Example value: 12.0