Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

Batch action: stop

PDF
Focus mode
Batch action: stop - AWS Elemental MediaLive API Reference
URIHTTP methodsSchemasPropertiesSee also

URI

/prod/batch/stop

HTTP methods

POST

Operation ID: BatchStop

Responses
Status codeResponse modelDescription
200BatchStopResultModel

200 response

400InvalidRequest

400 response

403AccessDenied

403 response

404ResourceNotFound

404 response

409ResourceConflict

409 response

429LimitExceeded

429 response

500InternalServiceError

500 response

502BadGatewayException

502 response

504GatewayTimeoutException

504 response

Schemas

Request bodies

{
  "channelIds": [
    "string"
  ],
  "multiplexIds": [
    "string"
  ]
}

POST schema

{
  "channelIds": [
    "string"
  ],
  "multiplexIds": [
    "string"
  ]
}

Response bodies

{
  "failed": [
    {
      "arn": "string",
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "successful": [
    {
      "arn": "string",
      "id": "string",
      "state": "string"
    }
  ]
}

BatchStopResultModel schema

{
  "failed": [
    {
      "arn": "string",
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "successful": [
    {
      "arn": "string",
      "id": "string",
      "state": "string"
    }
  ]
}
{
  "message": "string"
}

InvalidRequest schema

{
  "message": "string"
}
{
  "message": "string"
}

AccessDenied schema

{
  "message": "string"
}
{
  "message": "string"
}

ResourceNotFound schema

{
  "message": "string"
}
{
  "message": "string"
}

ResourceConflict schema

{
  "message": "string"
}
{
  "message": "string"
}

LimitExceeded schema

{
  "message": "string"
}
{
  "message": "string"
}

InternalServiceError schema

{
  "message": "string"
}
{
  "message": "string"
}

BadGatewayException schema

{
  "message": "string"
}
{
  "message": "string"
}

GatewayTimeoutException schema

{
  "message": "string"
}

Properties

AccessDenied

PropertyTypeRequiredDescription
message

string

False

BadGatewayException

PropertyTypeRequiredDescription
message

string

False

BatchFailedResultModel

Details from a failed operation

PropertyTypeRequiredDescription
arn

string

False

ARN of the resource

code

string

False

Error code for the failed operation

id

string

False

ID of the resource

message

string

False

Error message for the failed operation

BatchStop

Batch stop resource request

PropertyTypeRequiredDescription
channelIds

Array of type string

False

List of channel IDs

multiplexIds

Array of type string

False

List of multiplex IDs

BatchStopResultModel

Batch stop resource results

PropertyTypeRequiredDescription
failed

Array of type BatchFailedResultModel

False

List of failed operations

successful

Array of type BatchSuccessfulResultModel

False

List of successful operations

BatchSuccessfulResultModel

Details from a successful operation

PropertyTypeRequiredDescription
arn

string

False

ARN of the resource

id

string

False

ID of the resource

state

string

False

Current state of the resource

GatewayTimeoutException

PropertyTypeRequiredDescription
message

string

False

InternalServiceError

PropertyTypeRequiredDescription
message

string

False

InvalidRequest

PropertyTypeRequiredDescription
message

string

False

LimitExceeded

PropertyTypeRequiredDescription
message

string

False

ResourceConflict

PropertyTypeRequiredDescription
message

string

False

ResourceNotFound

PropertyTypeRequiredDescription
message

string

False

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

BatchStop

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.