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

UpdateRouterInput

Updates the configuration of an existing router input in AWS Elemental MediaConnect.

Request Syntax


PUT /v1/routerInput/arn HTTP/1.1
Content-type: application/json

{
   "configuration": { ... },
   "maintenanceConfiguration": { ... },
   "maximumBitrate": number,
   "name": "string",
   "routingScope": "string",
   "tier": "string",
   "transitEncryption": { 
      "encryptionKeyConfiguration": { ... },
      "encryptionKeyType": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

arn

The Amazon Resource Name (ARN) of the router input that you want to update.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

configuration

The updated configuration settings for the router input. Changing the type of the configuration is not supported.

Type: RouterInputConfiguration object

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

Required: No

maintenanceConfiguration

The updated maintenance configuration settings for the router input, including any changes to 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 updated maximum bitrate for the router input.

Type: Long

Required: No

name

The updated name for the router input.

Type: String

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

Required: No

routingScope

Specifies whether the router input can be assigned to outputs in different Regions. REGIONAL (default) - can be assigned only to outputs in the same Region. GLOBAL - can be assigned to outputs in any Region.

Type: String

Valid Values: REGIONAL | GLOBAL

Required: No

tier

The updated tier level for the router input.

Type: String

Valid Values: INPUT_100 | INPUT_50 | INPUT_20

Required: No

transitEncryption

The updated transit encryption settings for the router input.

Type: RouterInputTransitEncryption object

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "routerInput": { 
      "arn": "string",
      "availabilityZone": "string",
      "configuration": { ... },
      "createdAt": "string",
      "id": "string",
      "inputType": "string",
      "ipAddress": "string",
      "maintenanceConfiguration": { ... },
      "maintenanceSchedule": { ... },
      "maintenanceScheduleType": "string",
      "maintenanceType": "string",
      "maximumBitrate": number,
      "maximumRoutedOutputs": number,
      "messages": [ 
         { 
            "code": "string",
            "message": "string"
         }
      ],
      "name": "string",
      "regionName": "string",
      "routedOutputs": number,
      "routingScope": "string",
      "state": "string",
      "streamDetails": { ... },
      "tags": { 
         "string" : "string" 
      },
      "tier": "string",
      "transitEncryption": { 
         "encryptionKeyConfiguration": { ... },
         "encryptionKeyType": "string"
      },
      "updatedAt": "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.

routerInput

The updated router input.

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

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