Skip to content

DescribedWorkflow

Source code in docs_src/capo_transfer/types/described_workflow.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class DescribedWorkflow(TypedDict, closed=True):
    arn: "capo_transfer.types.arn.Arn"
    """<p>Specifies the unique Amazon Resource Name (ARN) for the workflow.</p>"""
    description: NotRequired[
        "capo_transfer.types.workflow_description.WorkflowDescription"
    ]
    """<p>Specifies the text description for the workflow.</p>"""
    steps: NotRequired["capo_transfer.types.workflow_steps.WorkflowSteps"]
    """<p>Specifies the details for the steps that are in the specified workflow.</p>"""
    on_exception_steps: NotRequired["capo_transfer.types.workflow_steps.WorkflowSteps"]
    """<p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p>"""
    workflow_id: NotRequired["capo_transfer.types.workflow_id.WorkflowId"]
    """<p>A unique identifier for the workflow.</p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>"""
    structured_log_destinations: NotRequired[
        "capo_transfer.types.structured_log_destinations.StructuredLogDestinations"
    ]
    """<p>Specifies the log groups to which your workflow logs are sent.</p> <p>To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:</p> <p> <code>arn:partition:logs:region-name:amazon-account-id:log-group:log-group-name:*</code> </p> <p>For example, <code>arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*</code> </p>"""

arn instance-attribute 

arn: Arn

Specifies the unique Amazon Resource Name (ARN) for the workflow.

description instance-attribute 

description: NotRequired[WorkflowDescription]

Specifies the text description for the workflow.

on_exception_steps instance-attribute 

on_exception_steps: NotRequired[WorkflowSteps]

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

steps instance-attribute 

steps: NotRequired[WorkflowSteps]

Specifies the details for the steps that are in the specified workflow.

structured_log_destinations instance-attribute 

structured_log_destinations: NotRequired[StructuredLogDestinations]

Specifies the log groups to which your workflow logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:partition:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

tags instance-attribute 

tags: NotRequired[Tags]

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

workflow_id instance-attribute 

workflow_id: NotRequired[WorkflowId]

A unique identifier for the workflow.