com.amazonaws.services.simpleworkflow.model

Class DeprecateWorkflowTypeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.DeprecateWorkflowTypeRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DeprecateWorkflowTypeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DeprecateWorkflowType operation.

Deprecates the specified workflow type . After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.

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.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • workflowType.name : String constraint. The key is swf:workflowType.name .
  • workflowType.version : String constraint. The key is swf:workflowType.version .

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.deprecateWorkflowType(DeprecateWorkflowTypeRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeprecateWorkflowTypeRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DeprecateWorkflowTypeRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDomain() The name of the domain in which the workflow type is registered.
WorkflowType	getWorkflowType() The workflow type to deprecate.
int	hashCode()
void	setDomain(String domain) The name of the domain in which the workflow type is registered.
void	setWorkflowType(WorkflowType workflowType) The workflow type to deprecate.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeprecateWorkflowTypeRequest	withDomain(String domain) The name of the domain in which the workflow type is registered.
DeprecateWorkflowTypeRequest	withWorkflowType(WorkflowType workflowType) The workflow type to deprecate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DeprecateWorkflowTypeRequest

public DeprecateWorkflowTypeRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain in which the workflow type is registered.

Constraints:
Length: 1 - 256

Returns:

The name of the domain in which the workflow type is registered.

setDomain

public void setDomain(String domain)

The name of the domain in which the workflow type is registered.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain in which the workflow type is registered.

withDomain

public DeprecateWorkflowTypeRequest withDomain(String domain)

The name of the domain in which the workflow type is registered.

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 in which the workflow type is registered.

Returns:

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

getWorkflowType

public WorkflowType getWorkflowType()

The workflow type to deprecate.

Returns:

The workflow type to deprecate.

setWorkflowType

public void setWorkflowType(WorkflowType workflowType)

The workflow type to deprecate.

Parameters:

workflowType - The workflow type to deprecate.

withWorkflowType

public DeprecateWorkflowTypeRequest withWorkflowType(WorkflowType workflowType)

The workflow type to deprecate.

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

Parameters:

workflowType - The workflow type to deprecate.

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 DeprecateWorkflowTypeRequest 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()