Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetWorkflowDefinition

Retrieves the details and configuration of a specific workflow definition.

Request Syntax


GET /workflow-definitions/workflowDefinitionName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

workflowDefinitionName

The name of the workflow definition to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z0-9_-]{1,40}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdAt": "string",
   "description": "string",
   "exportConfig": { 
      "s3BucketName": "string",
      "s3KeyPrefix": "string"
   },
   "name": "string",
   "status": "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.

arn

The Amazon Resource Name (ARN) of the workflow definition.

Type: String

Pattern: arn:(aws|aws-cn|aws-us-gov):nova-act:[a-z0-9-]+:[0-9]{12}:workflow-definition/[a-zA-Z0-9_-]{1,40}

createdAt

The timestamp when the workflow definition was created.

Type: Timestamp

description

The description of the workflow definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4000.

exportConfig

The export configuration for the workflow definition.

Type: WorkflowExportConfig object

name

The name of the workflow definition.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z0-9_-]{1,40}

status

The current status of the workflow definition.

Type: String

Valid Values: ACTIVE | DELETING

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permissions to perform this action.

message: You don't have sufficient permissions to perform this action. Verify your IAM permissions and try again.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. Please try again later.

message: The service encountered an internal error. Try again later.
reason: The reason for the internal server error.
retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

message: The specified resource was not found.
resourceId: The identifier of the resource that wasn't found.
resourceType: The type of resource that wasn't found.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to too many requests. Please try again later.

message: The request was denied due to request throttling.
quotaCode: The quota code related to the throttling.
retryAfterSeconds: The number of seconds to wait before retrying the throttled request.
serviceCode: The service code where throttling occurred.

HTTP Status Code: 429

ValidationException

The input parameters for the request are invalid.

fieldList: The list of fields that failed validation.
message: The input fails to satisfy the constraints specified by the service.
reason: The reason for the validation failure.

HTTP Status Code: 400