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

UpdateDestinationEndpoint

Updates the configuration of a destination endpoint.

Request Syntax


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

{
   "configuration": { ... },
   "description": "string"
}

URI Request Parameters

The request uses the following URI parameters.

arn

The Amazon Resource Name (ARN) of the destination endpoint to update.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

configuration

The updated configuration settings for the destination endpoint.

Type: DestinationEndpointConfiguration object

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

Required: No

description

A description to help you identify the destination endpoint.

Type: String

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

Pattern: [ a-zA-Z_0-9\-.',@:;\(\)\[\]*]+

Required: No

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "destinationEndpoint": { 
      "arn": "string",
      "associatedResourceDetails": { ... },
      "availabilityZone": "string",
      "availabilityZoneId": "string",
      "configuration": { ... },
      "connectedSource": "string",
      "connectionDetails": { ... },
      "connectionState": "string",
      "createdAt": "string",
      "decryptionConfiguration": { ... },
      "decryptionType": "string",
      "description": "string",
      "destinationType": "string",
      "id": "string",
      "lifecycleManagement": "string",
      "messages": [ 
         { 
            "code": "string",
            "message": "string"
         }
      ],
      "name": "string",
      "regionName": "string",
      "registrationState": "string",
      "resourceShareDetails": { ... },
      "resourceShareOwnership": "string",
      "tags": { 
         "string" : "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.

destinationEndpoint

The details of the updated destination endpoint.

Type: DestinationEndpoint object

Errors

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

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