stop_pipe

stop_pipe(**kwargs)

Stop an existing pipe.

See also: AWS API Documentation

Request Syntax

response = client.stop_pipe(
    Name='string'
)

Parameters

Name (string) --

[REQUIRED]

The name of the pipe.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'CurrentState': 'RUNNING'|'STOPPED'|'CREATING'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'CREATE_FAILED'|'UPDATE_FAILED'|'START_FAILED'|'STOP_FAILED',
    'DesiredState': 'RUNNING'|'STOPPED',
    'LastModifiedTime': datetime(2015, 1, 1),
    'Name': 'string'
}

Response Structure

• (dict) --
  • Arn (string) --

    The ARN of the pipe.

  • CreationTime (datetime) --

    The time the pipe was created.

  • CurrentState (string) --

    The state the pipe is in.

  • DesiredState (string) --

    The state the pipe should be in.

  • LastModifiedTime (datetime) --

    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

  • Name (string) --

    The name of the pipe.

Exceptions

• EventBridgePipes.Client.exceptions.InternalException
• EventBridgePipes.Client.exceptions.ValidationException
• EventBridgePipes.Client.exceptions.ThrottlingException
• EventBridgePipes.Client.exceptions.NotFoundException
• EventBridgePipes.Client.exceptions.ConflictException