The Amazon Chime SDK Identity, Media Pipelines, Meetings, and Messaging APIs are now published on the new Amazon Chime SDK API Reference. For more information, see the Amazon Chime SDK API Reference.
UpdateSipRule
Updates the details of the specified SIP rule.
Important
This API is no longer supported and will not be updated. We recommend using the latest version, UpdateSipRule, 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-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 specified to indicate 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.
Required: Yes
- TargetApplications
-
The new value of the 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
-
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
- 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 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: