com.amazonaws.services.simpleworkflow.model

Class DescribeWorkflowExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.DescribeWorkflowExecutionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeWorkflowExecutionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeWorkflowExecution operation.

Returns information about the specified workflow execution including its type and some statistics.

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.
• 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 .

See Also:

AmazonSimpleWorkflow.describeWorkflowExecution(DescribeWorkflowExecutionRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeWorkflowExecutionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeWorkflowExecutionRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDomain() The name of the domain containing the workflow execution.
WorkflowExecution	getExecution() The workflow execution to describe.
int	hashCode()
void	setDomain(String domain) The name of the domain containing the workflow execution.
void	setExecution(WorkflowExecution execution) The workflow execution to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeWorkflowExecutionRequest	withDomain(String domain) The name of the domain containing the workflow execution.
DescribeWorkflowExecutionRequest	withExecution(WorkflowExecution execution) The workflow execution to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeWorkflowExecutionRequest

public DescribeWorkflowExecutionRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

Returns:

The name of the domain containing the workflow execution.

setDomain

public void setDomain(String domain)

The name of the domain containing the workflow execution.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow execution.

withDomain

public DescribeWorkflowExecutionRequest withDomain(String domain)

The name of the domain containing the workflow execution.

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

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow execution.

Returns:

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

getExecution

public WorkflowExecution getExecution()

The workflow execution to describe.

Returns:

The workflow execution to describe.

setExecution

public void setExecution(WorkflowExecution execution)

The workflow execution to describe.

Parameters:

execution - The workflow execution to describe.

withExecution

public DescribeWorkflowExecutionRequest withExecution(WorkflowExecution execution)

The workflow execution to describe.

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

Parameters:

execution - The workflow execution 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

clone

public DescribeWorkflowExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()