URI HTTP methods Schemas Properties See also

Multiplex: stop

URI

/prod/multiplexes/multiplexId/stop

HTTP methods

POST

Operation ID: StopMultiplex

Path parameters
Name	Type	Required	Description
`multiplexId`	String	True

Responses
Status code	Response model	Description
`202`	`Multiplex`	202 response
`400`	`InvalidRequest`	400 response
`403`	`AccessDenied`	403 response
`404`	`ResourceNotFound`	404 response
`409`	`ResourceConflict`	409 response
`429`	`LimitExceeded`	429 response
`500`	`InternalServiceError`	500 response
`502`	`BadGatewayException`	502 response
`504`	`GatewayTimeoutException`	504 response

Schemas

Response bodies


{
  "arn": "string",
  "availabilityZones": [
    "string"
  ],
  "destinations": [
    {
      "mediaConnectSettings": {
        "entitlementArn": "string"
      }
    }
  ],
  "id": "string",
  "multiplexSettings": {
    "maximumVideoBufferDelayMilliseconds": integer,
    "transportStreamBitrate": integer,
    "transportStreamId": integer,
    "transportStreamReservedBitrate": integer
  },
  "name": "string",
  "pipelinesRunningCount": integer,
  "programCount": integer,
  "state": enum,
  "tags": {
  }
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}


{
  "message": "string"
}

Properties

AccessDenied

Property	Type	Required	Description
`message`	string	False

BadGatewayException

Property	Type	Required	Description
`message`	string	False

GatewayTimeoutException

Property	Type	Required	Description
`message`	string	False

InternalServiceError

Property	Type	Required	Description
`message`	string	False

InvalidRequest

Property	Type	Required	Description
`message`	string	False

LimitExceeded

Property	Type	Required	Description
`message`	string	False

Multiplex

The multiplex object.

Property	Type	Required	Description
`arn`	string	False	The unique arn of the multiplex.
`availabilityZones`	Array of type string	False	A list of availability zones for the multiplex.
`destinations`	Array of type MultiplexOutputDestination	False	A list of the multiplex output destinations.
`id`	string	False	The unique id of the multiplex.
`multiplexSettings`	MultiplexSettings	False	Configuration for a multiplex event.
`name`	string	False	The name of the multiplex.
`pipelinesRunningCount`	integer	False	The number of currently healthy pipelines.
`programCount`	integer	False	The number of programs in the multiplex.
`state`	MultiplexState	False	The current state of the multiplex.
`tags`	Tags	False	A collection of key-value pairs.

MultiplexMediaConnectOutputDestinationSettings

Multiplex MediaConnect output destination settings.

Property Type Required Description

Property	Type	Required	Description
`entitlementArn`	string MinLength: 1	False	The MediaConnect entitlement ARN available as a Flow source.

entitlementArn

string

MinLength: 1

False

The MediaConnect entitlement ARN available as a Flow source.

MultiplexOutputDestination

Multiplex output destination settings

Property	Type	Required	Description
`mediaConnectSettings`	MultiplexMediaConnectOutputDestinationSettings	False	Multiplex MediaConnect output destination settings.

MultiplexSettings

Contains configuration for a Multiplex event

Property	Type	Required	Description
`maximumVideoBufferDelayMilliseconds`	integer Minimum: 800 Maximum: 3000	False	Maximum video buffer delay in milliseconds.
`transportStreamBitrate`	integer Minimum: 1000000 Maximum: 100000000	True	Transport stream bit rate.
`transportStreamId`	integer Minimum: 0 Maximum: 65535	True	Transport stream ID.
`transportStreamReservedBitrate`	integer Minimum: 0 Maximum: 100000000	False	Transport stream reserved bit rate.

MultiplexState

The current state of the multiplex.

CREATING
CREATE_FAILED
IDLE
STARTING
RUNNING
RECOVERING
STOPPING
DELETING
DELETED

ResourceConflict

Property	Type	Required	Description
`message`	string	False

ResourceNotFound

Property	Type	Required	Description
`message`	string	False