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

CreateSipMediaApplication

Creates a SIP media application. For more information about SIP media applications, see Managing SIP media applications and rules in the Amazon Chime SDK Administrator Guide.

Request Syntax


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

{
   "AwsRegion": "string",
   "Endpoints": [ 
      { 
         "LambdaArn": "string"
      }
   ],
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AwsRegion

The AWS Region assigned to the SIP media application.

Type: String

Required: Yes

Endpoints

List of endpoints (Lambda ARNs) specified for the SIP media application.

Type: Array of SipMediaApplicationEndpoint objects

Array Members: Fixed number of 1 item.

Required: Yes

Name

The SIP media application's name.

Type: String

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

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

Required: Yes

Tags

The tags assigned to the SIP media application.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax


HTTP/1.1 201
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 201 response.

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

SipMediaApplication

The SIP media application details.

Type: SipMediaApplication object

Errors

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

AccessDeniedException

You don't have the permissions needed to run this action.

HTTP Status Code: 403

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

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

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