GetFlowTemplate
Gets the latest version of the DefinitionDocument
and FlowTemplateSummary
for the specified workflow.
Request Syntax
{
"id": "string
",
"revisionNumber": number
}
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.
- id
-
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
Type: String
Length Constraints: Maximum length of 160.
Pattern:
^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/[\p{Alnum}_]+)*)$
Required: Yes
- revisionNumber
-
The number of the workflow revision to retrieve.
Type: Long
Required: No
Response Syntax
{
"description": {
"definition": {
"language": "string",
"text": "string"
},
"summary": {
"arn": "string",
"createdAt": number,
"id": "string",
"revisionNumber": number
},
"validatedNamespaceVersion": number
}
}
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.
- description
-
The object that describes the specified workflow.
Type: FlowTemplateDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
HTTP Status Code: 500
- InvalidRequestException
-
HTTP Status Code: 400
- ResourceNotFoundException
-
HTTP Status Code: 400
- ThrottlingException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: