ListDomainsRequest (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.simpleworkflow.model
Class ListDomainsRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.simpleworkflow.model.ListDomainsRequest

All Implemented Interfaces:: Serializable

public class ListDomainsRequest
extends AmazonWebServiceRequest
implements Serializable
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListDomains operation.

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 .

See Also:: AmazonSimpleWorkflow.listDomains(ListDomainsRequest), Serialized Form

Constructor Summary
`ListDomainsRequest()`

Method Summary
`boolean`	`equals(Object obj)`
`Integer`	`getMaximumPageSize()` The maximum number of results returned in each page.
`String`	`getNextPageToken()` If on a previous call to this method a `NextPageToken` was returned, the result has more than one page.
`String`	`getRegistrationStatus()` Specifies the registration status of the domains to list.
`Boolean`	`getReverseOrder()` When set to `true`, returns the results in reverse order.
`int`	`hashCode()`
`Boolean`	`isReverseOrder()` When set to `true`, returns the results in reverse order.
`void`	`setMaximumPageSize(Integer maximumPageSize)` The maximum number of results returned in each page.
`void`	`setNextPageToken(String nextPageToken)` If on a previous call to this method a `NextPageToken` was returned, the result has more than one page.
`void`	`setRegistrationStatus(RegistrationStatus registrationStatus)` Specifies the registration status of the domains to list.
`void`	`setRegistrationStatus(String registrationStatus)` Specifies the registration status of the domains to list.
`void`	`setReverseOrder(Boolean reverseOrder)` When set to `true`, returns the results in reverse order.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ListDomainsRequest`	`withMaximumPageSize(Integer maximumPageSize)` The maximum number of results returned in each page.
`ListDomainsRequest`	`withNextPageToken(String nextPageToken)` If on a previous call to this method a `NextPageToken` was returned, the result has more than one page.
`ListDomainsRequest`	`withRegistrationStatus(RegistrationStatus registrationStatus)` Specifies the registration status of the domains to list.
`ListDomainsRequest`	`withRegistrationStatus(String registrationStatus)` Specifies the registration status of the domains to list.
`ListDomainsRequest`	`withReverseOrder(Boolean reverseOrder)` When set to `true`, returns the results in reverse order.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
`copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail

ListDomainsRequest

public ListDomainsRequest()

Method Detail

getNextPageToken

public String getNextPageToken()

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.

Constraints:
Length: 0 - 2048

Returns:: 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.

setNextPageToken

public void setNextPageToken(String nextPageToken)

Constraints:
Length: 0 - 2048

Parameters:: 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.

withNextPageToken

public ListDomainsRequest withNextPageToken(String nextPageToken)

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 2048

Parameters:: 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.
Returns:: A reference to this updated object so that method calls can be chained together.