StartRouterOutput - AWS Elemental MediaConnect

StartRouterOutput

Starts a router output in AWS Elemental MediaConnect.

Request Syntax

POST /v1/routerOutput/start/arn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

arn

The Amazon Resource Name (ARN) of the router output that you want to start.

Pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerOutput:[a-z0-9]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 202 Content-type: application/json { "arn": "string", "maintenanceSchedule": { ... }, "maintenanceScheduleType": "string", "name": "string", "state": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

arn

The Amazon Resource Name (ARN) of the router output that was started.

Type: String

Pattern: arn:(aws[a-zA-Z-]*):mediaconnect:[a-z0-9-]+:[0-9]{12}:routerOutput:[a-z0-9]{12}

maintenanceSchedule

The details of the maintenance schedule for the router output.

Type: MaintenanceSchedule object

Note: This object is a Union. Only one member of this object can be specified or returned.

maintenanceScheduleType

The type of maintenance schedule associated with the router output.

Type: String

Valid Values: WINDOW

name

The name of the router output that was started.

Type: String

state

The current state of the router output after being started.

Type: String

Valid Values: CREATING | STANDBY | STARTING | ACTIVE | STOPPING | DELETING | UPDATING | ERROR | RECOVERING | MIGRATING

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.

HTTP Status Code: 400

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

HTTP Status Code: 409

ForbiddenException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerErrorException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable or busy.

HTTP Status Code: 503

TooManyRequestsException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also

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