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

UpdateSipMediaApplication

Updates the details of the specified SIP media application.

Request Syntax


PUT /sip-media-applications/sipMediaApplicationId HTTP/1.1
Content-type: application/json

{
   "Endpoints": [ 
      { 
         "LambdaArn": "string"
      }
   ],
   "Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

sipMediaApplicationId

The SIP media application ID.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Endpoints

The new set of endpoints for the specified SIP media application.

Type: Array of SipMediaApplicationEndpoint objects

Array Members: Fixed number of 1 item.

Required: No

Name

The new name for the specified SIP media application.

Type: String

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

Pattern: [a-zA-Z0-9 _.-]+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplication": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "Endpoints": [ 
         { 
            "LambdaArn": "string"
         }
      ],
      "Name": "string",
      "SipMediaApplicationArn": "string",
      "SipMediaApplicationId": "string",
      "UpdatedTimestamp": "string"
   }
}

Response Elements

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

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

SipMediaApplication

The updated SIP media application’s details.

Type: SipMediaApplication object

Errors

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

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ConflictException

Multiple instances of the same request were made simultaneously.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

The requested resource couldn't be found.

HTTP Status Code: 404

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client isn't authorized to request a resource.

HTTP Status Code: 401