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

ListOperations

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.

Request Syntax


{
   "Marker": "string",
   "MaxItems": number,
   "SortBy": "string",
   "SortOrder": "string",
   "Status": [ "string" ],
   "SubmittedSince": number,
   "Type": [ "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.

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: String

Length Constraints: Maximum length of 4096.

Required: No

MaxItems

Number of domains to be returned.

Default: 20

Type: Integer

Valid Range: Maximum value of 100.

Required: No

SortBy

The sort type for returned values.

Type: String

Valid Values: SubmittedDate

Required: No

SortOrder

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

Type: String

Valid Values: ASC | DESC

Required: No

Status

The status of the operations.

Type: Array of strings

Array Members: Maximum number of 5 items.

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

Required: No

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: Timestamp

Required: No

Type

An arrays of the domains operation types.

Type: Array of strings

Array Members: Maximum number of 21 items.

Required: No

Response Syntax


{
   "NextPageMarker": "string",
   "Operations": [ 
      { 
         "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.

NextPageMarker

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.

Type: String

Length Constraints: Maximum length of 4096.

Operations

Lists summaries of the operations.

Type: Array of OperationSummary objects

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

ListOperations Example

This example illustrates one usage of ListOperations.

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.ListOperations
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]
{
   "MaxItems" : 2
}

Sample Response


HTTP/1.1 200
Content-Length:[number of characters in the JSON string]
{
   "Operations":[
       {
         "OperationId":"4ced3d4a-e011-45ee-b94f-1e2d73477562",
         "Status":"WORKFLOW_IN_PROGRESS",
         "SubmittedDate":1403548979.088,
         "Type":"CHANGE_PRIVACY_PROTECTION"
      },
      {
         "OperationId":"2e3ac45b-89b3-47ea-a042-f56dcd1b6883",
         "Status":"WORKFLOW_IN_PROGRESS",
         "SubmittedDate":1403548986.429,
         "Type":"DOMAIN_LOCK"
      }
   ]
}