Menu
Amazon Simple Workflow Service
API Reference (API Version 2012-01-25)

ListDomains

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Note

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.

  • Use an Action element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Request Syntax

Copy
{ "maximumPageSize": number, "nextPageToken": "string", "registrationStatus": "string", "reverseOrder": boolean }

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.

maximumPageSize

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

nextPageToken

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

registrationStatus

Specifies the registration status of the domains to list.

Type: String

Valid Values: REGISTERED | DEPRECATED

Required: Yes

reverseOrder

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

Type: Boolean

Required: No

Response Syntax

Copy
{ "domainInfos": [ { "description": "string", "name": "string", "status": "string" } ], "nextPageToken": "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.

domainInfos

A list of DomainInfo structures.

Type: array of DomainInfo objects

nextPageToken

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

Type: String

Length Constraints: Maximum length of 2048.

Errors

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

OperationNotPermittedFault

Returned when the caller does not have sufficient permissions to invoke the action.

HTTP Status Code: 400

Example

ListDomains Example

Sample Request

Copy
POST / HTTP/1.1 Host: swf.us-east-1.amazonaws.com User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E) Accept: application/json, text/javascript, */* Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 115 Connection: keep-alive Content-Type: application/x-amz-json-1.0 X-Requested-With: XMLHttpRequest X-Amz-Date: Sun, 15 Jan 2012 03:09:58 GMT X-Amz-Target: SimpleWorkflowService.ListDomains Content-Encoding: amz-1.0 X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=ZCprC72dUxF9ca3w/tbwKZ8lBQn0jaA4xOJqDF0uqMI= Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html Content-Length: 86 Pragma: no-cache Cache-Control: no-cache {"registrationStatus": "REGISTERED", "maximumPageSize": 50, "reverseOrder": false}

Sample Response

Copy
HTTP/1.1 200 OK Content-Length: 568 Content-Type: application/json x-amzn-RequestId: 67e874cc-3f26-11e1-9b11-7182192d0b57 {"domainInfos": [ {"description": "music", "name": "867530901", "status": "REGISTERED"}, {"description": "music", "name": "867530902", "status": "REGISTERED"}, {"description": "", "name": "Demo", "status": "REGISTERED"}, {"description": "", "name": "DemoDomain", "status": "REGISTERED"}, {"description": "", "name": "Samples", "status": "REGISTERED"}, {"description": "", "name": "testDomain2", "status": "REGISTERED"}, {"description": "", "name": "testDomain3", "status": "REGISTERED"}, {"description": "", "name": "testDomain4", "status": "REGISTERED"}, {"description": "", "name": "zsxfvgsxcv", "status": "REGISTERED"} ] }

See Also

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