com.amazonaws.services.simpleworkflow.model

Class DescribeDomainRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.DescribeDomainRequest

All Implemented Interfaces:

Serializable

public class DescribeDomainRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeDomain operation.

Returns information about the specified domain including description and status.

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.
• 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.describeDomain(DescribeDomainRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeDomainRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() The name of the domain to describe.
int	hashCode()
void	setName(String name) The name of the domain to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDomainRequest	withName(String name) The name of the domain to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeDomainRequest

public DescribeDomainRequest()

Method Detail

getName

public String getName()

The name of the domain to describe.

Constraints:
Length: 1 - 256

Returns:

The name of the domain to describe.

setName

public void setName(String name)

The name of the domain to describe.

Constraints:
Length: 1 - 256

Parameters:

name - The name of the domain to describe.

withName

public DescribeDomainRequest withName(String name)

The name of the domain to describe.

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

Constraints:
Length: 1 - 256

Parameters:

name - The name of the domain to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object