Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetOperationDetail

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

Request Syntax


{
   "OperationId": "string"
}

Request Parameters

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

The request accepts the following data in JSON format.

OperationId

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.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax


{
   "DomainName": "string",
   "LastUpdatedDate": number,
   "Message": "string",
   "OperationId": "string",
   "Status": "string",
   "StatusFlag": "string",
   "SubmittedDate": number,
   "Type": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DomainName

The name of a domain.

Type: String

Length Constraints: Maximum length of 255.

LastUpdatedDate

The date when the operation was last updated.

Type: Timestamp

Message

Detailed information on the status including possible errors.

Type: String

OperationId

The identifier for the operation.

Type: String

Length Constraints: Maximum length of 255.

Status

The current status of the requested operation in the system.

Type: String

Valid Values: SUBMITTED | IN_PROGRESS | ERROR | SUCCESSFUL | FAILED

StatusFlag

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.

Type: String

Valid Values: PENDING_ACCEPTANCE | PENDING_CUSTOMER_ACTION | PENDING_AUTHORIZATION | PENDING_PAYMENT_VERIFICATION | PENDING_SUPPORT_CASE

SubmittedDate

The date when the request was submitted.

Type: Timestamp

Type

The type of operation that was requested.

Type: String

Errors

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

InvalidInput

The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

HTTP Status Code: 400

Examples

GetOperationDetail Example

This example illustrates one usage of GetOperationDetail.

Sample Request


POST / HTTP/1.1
host:route53domains.us-east-1.amazonaws.com
x-amz-date:20140711T205230Z
authorization:AWS4-HMAC-SHA256
              Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,
              SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
              Signature=[calculated-signature]
x-amz-target:Route53Domains_v20140515.GetOperationDetail
user-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
   "OperationId":"43884ce5-e30a-4801-858f-7aa86356c127"
}

Sample Response


HTTP/1.1 200
Content-Length:[number of characters in the JSON string]
{
   "DomainName":"happierdomain.ca",
   "OperationId":"43884ce5-e30a-4801-858f-7aa86356c127",
   "Status":"WORKFLOW_IN_PROGRESS",
   "SubmittedDate" : 1402630939.057,
   "Type" : "REGISTER_DOMAIN"
}