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

CreateRouterNetworkInterface

Creates a new router network interface in AWS Elemental MediaConnect.

Request Syntax


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

{
   "clientToken": "string",
   "configuration": { ... },
   "name": "string",
   "regionName": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique identifier for the request to ensure idempotency.

Type: String

Required: No

configuration

The configuration settings for the router network interface.

Type: RouterNetworkInterfaceConfiguration object

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

Required: Yes

name

The name of the router network interface.

Type: String

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

Required: Yes

regionName

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

Type: String

Required: No

tags

Key-value pairs that can be used to tag and organize this router network interface.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "routerNetworkInterface": { 
      "arn": "string",
      "associatedInputCount": number,
      "associatedOutputCount": number,
      "configuration": { ... },
      "createdAt": "string",
      "id": "string",
      "name": "string",
      "networkInterfaceType": "string",
      "regionName": "string",
      "state": "string",
      "tags": { 
         "string" : "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.

routerNetworkInterface

The newly-created router network interface.

Type: RouterNetworkInterface 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

RouterNetworkInterfaceServiceQuotaExceededException

The request to create a new router network interface 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