CmdID / aws / aws pipes

aws pipes describe-pipe

Get the information about an existing pipe. AWS CLI reference

1 example 1 option Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To retrieve information about a Pipe

The following describe-pipe example displays information about the Pipe Demo_Pipe in the specified account.

aws pipes describe-pipe --name Demo_PipeIdentify

--nameThe name of the pipe.

Its output

{
    "Arn": "arn:aws:pipes:us-west-2:123456789012:pipe/Demo_Pipe",
    "Name": "Demo_Pipe",
    "DesiredState": "RUNNING",
    "CurrentState": "RUNNING",
    "StateReason": "User initiated",
    "Source": "arn:aws:sqs:us-west-2:123456789012:Demo_Queue",
    "SourceParameters": {
        "SqsQueueParameters": {
            "BatchSize": 1
        }
    },
    "EnrichmentParameters": {},
    "Target": "arn:aws:logs:us-west-2:123456789012:log-group:/aws/pipes/Demo_LogGroup",
    "TargetParameters": {},
    "RoleArn": "arn:aws:iam::123456789012:role/service-role/Amazon_EventBridge_Pipe_Demo_Pipe_28b3aa4f",
    "Tags": {},
    "CreationTime": "2024-10-08T09:29:10-05:00",
    "LastModifiedTime": "2024-10-08T10:23:47-05:00",
    "LogConfiguration": {
        "CloudwatchLogsLogDestination": {
            "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:/aws/vendedlogs/pipes/Demo_Pipe"
        },
        "Level": "ERROR"
    }
}

For more information, see Amazon EventBridge Pipes concepts in the Amazon EventBridge User Guide.

Options

1 in the AWS CLI reference

--nameThe name of the pipe.