EventBridgePipes / Client / delete_pipe

delete_pipe#

EventBridgePipes.Client.delete_pipe(**kwargs)#

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_pipe(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

The name of the pipe.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Arn (string) –

      The ARN of the pipe.

    • Name (string) –

      The name of the pipe.

    • DesiredState (string) –

      The state the pipe should be in.

    • CurrentState (string) –

      The state the pipe is in.

    • CreationTime (datetime) –

      The time the pipe was created.

    • LastModifiedTime (datetime) –

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

Exceptions