Skip to main content

workflow

Gets an individual workflow resource

Overview

Nameworkflow
TypeResource
Descriptionworkflow
Idawscc.transfer.workflow

Fields

NameDatatypeDescription
on_exception_stepsarraySpecifies the steps (actions) to take if any errors are encountered during execution of the workflow.
stepsarraySpecifies the details for the steps that are in the specified workflow.
tagsarrayKey-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
descriptionstringA textual description for the workflow.
workflow_idstringA unique identifier for the workflow.
arnstringSpecifies the unique Amazon Resource Name (ARN) for the workflow.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
on_exception_steps,
steps,
tags,
description,
workflow_id,
arn
FROM awscc.transfer.workflow
WHERE data__Identifier = '<WorkflowId>';

Permissions

To operate on the workflow resource, the following permissions are required:

Read

transfer:DescribeWorkflow

Delete

transfer:DeleteWorkflow

Update

transfer:UnTagResource,
transfer:TagResource