DescribeWorkflowType
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, etc.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
-
Use a
Resourceelement with the domain name to limit the action to only specified domains. -
Use an
Actionelement to allow or deny permission to call this action. -
Constrain the following parameters by using a
Conditionelement with the appropriate keys.-
workflowType.name: String constraint. The key isswf:workflowType.name. -
workflowType.version: String constraint. The key isswf:workflowType.version.
-
If the caller doesn't 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 is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
Request Syntax
{
"domain": "string",
"workflowType": {
"name": "string",
"version": "string"
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- domain
-
The name of the domain in which this workflow type is registered.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- workflowType
-
The workflow type to describe.
Type: WorkflowType object
Required: Yes
Response Syntax
{
"configuration": {
"defaultChildPolicy": "string",
"defaultExecutionStartToCloseTimeout": "string",
"defaultLambdaRole": "string",
"defaultTaskList": {
"name": "string"
},
"defaultTaskPriority": "string",
"defaultTaskStartToCloseTimeout": "string"
},
"typeInfo": {
"creationDate": number,
"deprecationDate": number,
"description": "string",
"status": "string",
"workflowType": {
"name": "string",
"version": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- configuration
-
Configuration settings of the workflow type registered through RegisterWorkflowType
Type: WorkflowTypeConfiguration object
- typeInfo
-
General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
-
REGISTERED– The type is registered and available. Workers supporting this type should be running. -
DEPRECATED– The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.
Type: WorkflowTypeInfo object
-
Errors
For information about the errors that are common to all actions, see Common Errors.
- OperationNotPermittedFault
-
Returned when the caller doesn't have sufficient permissions to invoke the action.
HTTP Status Code: 400
- UnknownResourceFault
-
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.
HTTP Status Code: 400
Examples
DescribeWorkflowType Example
This example illustrates one usage of DescribeWorkflowType.
Sample Request
POST / HTTP/1.1
Host: swf.us-east-1.amazonaws.com
User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)
Accept: application/json, text/javascript, */*
Accept-Language: en-us,en;q=0.5
Accept-Encoding: gzip,deflate
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
Keep-Alive: 115
Connection: keep-alive
Content-Type: application/x-amz-json-1.0
X-Requested-With: XMLHttpRequest
X-Amz-Date: Sun, 15 Jan 2012 22:40:40 GMT
X-Amz-Target: SimpleWorkflowService.DescribeWorkflowType
Content-Encoding: amz-1.0
X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=iGt8t83OmrURqu0pKYbcW6mNdjXbFomevCBPUPQEbaM=
Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html
Content-Length: 102
Pragma: no-cache
Cache-Control: no-cache
{
"domain": "867530901",
"workflowType": {
"version": "1.0",
"name": "customerOrderWorkflow"
}
}Sample Response
HTTP/1.1 200 OK
Content-Length: 348
Content-Type: application/json
x-amzn-RequestId: f35a8e7f-3fc9-11e1-a23a-99d60383ae71
{
"configuration": {
"defaultExecutionStartToCloseTimeout": "3600",
"defaultTaskStartToCloseTimeout": "600",
"defaultTaskList": {"name": "mainTaskList"},
"defaultTaskPriority": "10"
"defaultChildPolicy": "TERMINATE"
},
"typeInfo": {
"status": "REGISTERED",
"creationDate": 1326481174.027,
"description": "Handle customer orders",
"workflowType": {
"version": "1.0",
"name": "customerOrderWorkflow"
}
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
