UpdateSipRule
Updates the details of the specified SIP rule.
Request Syntax
PUT /sip-rules/sipRuleId HTTP/1.1
Content-type: application/json
{
"Disabled": boolean,
"Name": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- sipRuleId
-
The SIP rule ID.
Pattern:
.*\S.*Required: Yes
Request Body
The request accepts the following data in JSON format.
- Disabled
-
The new value that indicates whether the rule is disabled.
Type: Boolean
Required: No
- Name
-
The new name for the specified SIP rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9 _.-]+Required: Yes
- TargetApplications
-
The new list of target applications.
Type: Array of SipRuleTargetApplication objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"SipRule": {
"CreatedTimestamp": "string",
"Disabled": boolean,
"Name": "string",
"SipRuleId": "string",
"TargetApplications": [
{
"AwsRegion": "string",
"Priority": number,
"SipMediaApplicationId": "string"
}
],
"TriggerType": "string",
"TriggerValue": "string",
"UpdatedTimestamp": "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.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
