public class DescribeWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
DescribeWorkflowType operation
.
Returns information about the specified workflow type . This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource
element with the domain name to limit
the action to only specified domains.Action
element to allow or deny permission to
call this action.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 .
NOOP
Constructor and Description |
---|
DescribeWorkflowTypeRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeWorkflowTypeRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getDomain()
The name of the domain in which this workflow type is registered.
|
WorkflowType |
getWorkflowType()
The workflow type to describe.
|
int |
hashCode() |
void |
setDomain(String domain)
The name of the domain in which this workflow type is registered.
|
void |
setWorkflowType(WorkflowType workflowType)
The workflow type to describe.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeWorkflowTypeRequest |
withDomain(String domain)
The name of the domain in which this workflow type is registered.
|
DescribeWorkflowTypeRequest |
withWorkflowType(WorkflowType workflowType)
The workflow type to describe.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(String domain)
Constraints:
Length: 1 - 256
domain
- The name of the domain in which this workflow type is registered.public DescribeWorkflowTypeRequest withDomain(String domain)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
domain
- The name of the domain in which this workflow type is registered.public WorkflowType getWorkflowType()
public void setWorkflowType(WorkflowType workflowType)
workflowType
- The workflow type to describe.public DescribeWorkflowTypeRequest withWorkflowType(WorkflowType workflowType)
Returns a reference to this object so that method calls can be chained together.
workflowType
- The workflow type to describe.public String toString()
toString
in class Object
Object.toString()
public DescribeWorkflowTypeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.