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

UpdateSipMediaApplication

Updates the details of the specified SIP media application.

Important

This API is no longer supported and will not be updated. We recommend using the latest version, UpdateSipMediaApplication, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

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.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SipMediaApplication": { 
      "AwsRegion": "string",
      "CreatedTimestamp": "string",
      "Endpoints": [ 
         { 
            "LambdaArn": "string"
         }
      ],
      "Name": "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 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

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

NotFoundException

One or more of the resources in the request does not exist in the system.

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 client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401