stop_flow

Appflow.Client.stop_flow(**kwargs)

Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.

See also: AWS API Documentation

Request Syntax

response = client.stop_flow(
    flowName='string'
)

Parameters

flowName (string) --

[REQUIRED]

The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Return type

dict

Returns

Response Syntax

{
    'flowArn': 'string',
    'flowStatus': 'Active'|'Deprecated'|'Deleted'|'Draft'|'Errored'|'Suspended'
}

Response Structure

• (dict) --
  • flowArn (string) --

    The flow's Amazon Resource Name (ARN).

  • flowStatus (string) --

    Indicates the current status of the flow.

Exceptions

• Appflow.Client.exceptions.ConflictException
• Appflow.Client.exceptions.ResourceNotFoundException
• Appflow.Client.exceptions.UnsupportedOperationException
• Appflow.Client.exceptions.InternalServerException