ListWorkflowTypes
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
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 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
",
"maximumPageSize": number
,
"name": "string
",
"nextPageToken": "string
",
"registrationStatus": "string
",
"reverseOrder": boolean
}
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 the workflow types have been registered.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- maximumPageSize
-
The maximum number of results that are returned per call. Use
nextPageToken
to obtain further pages of results.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No
- name
-
If specified, lists the workflow type with this name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- nextPageToken
-
If
NextPageToken
is returned there are more results available. The value ofNextPageToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a400
error: "Specified token has exceeded its maximum lifetime
".The configured
maximumPageSize
determines how many results can be returned in a single call.Type: String
Length Constraints: Maximum length of 2048.
Required: No
- registrationStatus
-
Specifies the registration status of the workflow types to list.
Type: String
Valid Values:
REGISTERED | DEPRECATED
Required: Yes
- reverseOrder
-
When set to
true
, returns the results in reverse order. By default the results are returned in ascending alphabetical order of thename
of the workflow types.Type: Boolean
Required: No
Response Syntax
{
"nextPageToken": "string",
"typeInfos": [
{
"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.
- nextPageToken
-
If a
NextPageToken
was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.Type: String
Length Constraints: Maximum length of 2048.
- typeInfos
-
The list of workflow type information.
Type: Array of WorkflowTypeInfo objects
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
ListWorkflowTypes Example
This example illustrates one usage of ListWorkflowTypes.
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:25:43 GMT
X-Amz-Target: SimpleWorkflowService.ListWorkflowTypes
Content-Encoding: amz-1.0
X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=uleWQSyVVf0+aG50IoBJG5h0hzxNFNT97Mkn/FSCQ+Q=
Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html
Content-Length: 110
Pragma: no-cache
Cache-Control: no-cache
{"domain": "867530901",
"registrationStatus": "REGISTERED",
"maximumPageSize": 50,
"reverseOrder": true}
Sample Response
HTTP/1.1 200 OK
Content-Length: 174
Content-Type: application/json
x-amzn-RequestId: dcde6719-3fc7-11e1-9e8f-57bb03e21482
{"typeInfos":
[
{"creationDate": 1326481174.027,
"description": "Handle customer orders",
"status": "REGISTERED",
"workflowType":
{"name": "customerOrderWorkflow",
"version": "1.0"}
}
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: