Batch Stop - AWS Elemental MediaLive API Reference

Batch Stop

URI

/prod/batch/stop

HTTP Methods

POST

Operation ID: BatchStop

Stops running resources

Responses
Status Code Response Model Description
200 BatchStopResultModel

200 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

Request Bodies

Example POST

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

Response Bodies

Example BatchStopResultModel

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

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ResourceNotFound

{ "message": "string" }

Example ResourceConflict

{ "message": "string" }

Example LimitExceeded

{ "message": "string" }

Example InternalServiceError

{ "message": "string" }

Example BadGatewayException

{ "message": "string" }

Example GatewayTimeoutException

{ "message": "string" }

Properties

AccessDenied

Property Type Required Description
message

string

False

BadGatewayException

Property Type Required Description
message

string

False

BatchFailedResultModel

Details from a failed operation

Property Type Required Description
id

string

False

ID of the resource

arn

string

False

ARN of the resource

code

string

False

Error code for the failed operation

message

string

False

Error message for the failed operation

BatchStop

Batch stop resource request

Property Type Required Description
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

Property Type Required Description
successful

Array of type BatchSuccessfulResultModel

False

List of successful operations

failed

Array of type BatchFailedResultModel

False

List of failed operations

BatchSuccessfulResultModel

Details from a successful operation

Property Type Required Description
id

string

False

ID of the resource

arn

string

False

ARN of the resource

state

string

False

Current state of the resource

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

ResourceConflict

Property Type Required Description
message

string

False

ResourceNotFound

Property Type Required Description
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