Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1459758542.7 KB

Stops a running channel

post/prod/channels/{channelId}/stop

Path parameters

channelIdstring required

Placeholder documentation for __string

A request to stop a running channel

Response

Success

Arnstring

The unique arn of the channel.

ChannelClass'STANDARD' | 'SINGLE_PIPELINE'

The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

Idstring

The unique id of the channel.

LogLevel'ERROR' | 'WARNING' | 'INFO' | 'DEBUG' | 'DISABLED'

The log level being written to CloudWatch Logs.

Namestring

The name of the channel. (user-mutable)

PipelinesRunningCountinteger

The number of currently healthy pipelines.

RoleArnstring

The Amazon Resource Name (ARN) of the role assumed when running the Channel.

State'CREATING' | 'CREATE_FAILED' | 'IDLE' | 'STARTING' | 'RUNNING' | 'RECOVERING' | 'STOPPING' | 'DELETING' | 'DELETED' | 'UPDATING' | 'UPDATE_FAILED'

Placeholder documentation for ChannelState

Tagsobject

A collection of key-value pairs.