ListSipRules - Amazon Chime SDK


Lists the SIP rules under the administrator's AWS account.

Request Syntax

GET /sip-rules?max-results=MaxResults&next-token=NextToken&sip-media-application=SipMediaApplicationId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The maximum number of results to return in a single call. Defaults to 100.

Valid Range: Minimum value of 1. Maximum value of 100.


The token used to return the next page of results.

Length Constraints: Maximum length of 65535.


The SIP media application ID.

Pattern: .*\S.*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "SipRules": [ { "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 200 response.

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


The token used to return the next page of results.

Type: String

Length Constraints: Maximum length of 65535.


The list of SIP rules and details.

Type: Array of SipRule objects


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


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

HTTP Status Code: 400


The client is permanently forbidden from making the request.

HTTP Status Code: 403


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429


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: