Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateRouterOutput

Creates a new router output in AWS Elemental MediaConnect.

Request Syntax


POST /v1/routerOutput HTTP/1.1
Content-type: application/json

{
   "availabilityZone": "string",
   "clientToken": "string",
   "configuration": { ... },
   "maintenanceConfiguration": { ... },
   "maximumBitrate": number,
   "name": "string",
   "regionName": "string",
   "routingScope": "string",
   "tags": { 
      "string" : "string" 
   },
   "tier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

availabilityZone

The Availability Zone where you want to create the router output. This must be a valid Availability Zone for the region specified by regionName, or the current region if no regionName is provided.

Type: String

Required: No

clientToken

A unique identifier for the request to ensure idempotency.

Type: String

Required: No

configuration

The configuration settings for the router output.

Type: RouterOutputConfiguration object

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

Required: Yes

maintenanceConfiguration

The maintenance configuration settings for the router output, including preferred maintenance windows and schedules.

Type: MaintenanceConfiguration object

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

Required: No

maximumBitrate

The maximum bitrate for the router output.

Type: Long

Required: Yes

name

The name of the router output.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

regionName

The AWS Region for the router output. Defaults to the current region if not specified.

Type: String

Required: No

routingScope

Specifies whether the router output can take inputs that are in different Regions. REGIONAL (default) - can only take inputs from same Region. GLOBAL - can take inputs from any Region.

Type: String

Valid Values: REGIONAL | GLOBAL

Required: Yes

tags

Key-value pairs that can be used to tag this router output.

Type: String to string map

Required: No

tier

The tier level for the router output.

Type: String

Valid Values: OUTPUT_100 | OUTPUT_50 | OUTPUT_20

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "routerOutput": { 
      "arn": "string",
      "availabilityZone": "string",
      "configuration": { ... },
      "createdAt": "string",
      "id": "string",
      "ipAddress": "string",
      "maintenanceConfiguration": { ... },
      "maintenanceSchedule": { ... },
      "maintenanceScheduleType": "string",
      "maintenanceType": "string",
      "maximumBitrate": number,
      "messages": [ 
         { 
            "code": "string",
            "message": "string"
         }
      ],
      "name": "string",
      "outputType": "string",
      "regionName": "string",
      "routedInputArn": "string",
      "routedState": "string",
      "routingScope": "string",
      "state": "string",
      "streamDetails": { ... },
      "tags": { 
         "string" : "string" 
      },
      "tier": "string",
      "updatedAt": "string"
   }
}

Response Elements

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

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

routerOutput

The newly-created router output.

Type: RouterOutput object

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

RouterOutputServiceQuotaExceededException

The request to create a new router output would exceed the service quotas (limits) set for the account.

HTTP Status Code: 420

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