AWS Documentation » Amazon Simple Workflow Service » API Reference » Actions » ListDomains	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

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 by throwing OperationNotPermitted. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Request Syntax

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

Request Parameters

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

The request accepts the following data in JSON format.

maximumPageSize

The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of domains may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.

Type: Number

Required: No

nextPageToken

If on a previous call to this method a NextPageToken was returned, the result has more than one page. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.

Type: String

Length constraints: Minimum length of 0. 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 of the name of the domains.

Type: Boolean

Required: No

Response Syntax

{
    "domainInfos": [
        {
            "description": "string",
            "name": "string",
            "status": "string"
        }
    ],
    "nextPageToken": "string"
}

Response Elements

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

domainInfos

A list of DomainInfo structures.

Type: array of DomainInfo objects

Required: Yes

nextPageToken

Returns a value if the results are paginated. To get the next page of results, repeat the request specifying this token and all other arguments unchanged.

Type: String

Length constraints: Minimum length of 0. Maximum length of 2048.

Required: No

Errors

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

OperationNotPermitted

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

HTTP Status Code: 400

Examples

ListDomains Example

Sample Request

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

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"}
  ]
}

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...