get_sip_rule

ChimeSDKVoice.Client.get_sip_rule(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_sip_rule(
    SipRuleId='string'
)

Parameters

SipRuleId (string) -- [REQUIRED]

Return type

dict

Returns

Response Syntax

{
    'SipRule': {
        'SipRuleId': 'string',
        'Name': 'string',
        'Disabled': True|False,
        'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
        'TriggerValue': 'string',
        'TargetApplications': [
            {
                'SipMediaApplicationId': 'string',
                'Priority': 123,
                'AwsRegion': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --
  • SipRule (dict) --
    • SipRuleId (string) --
    • Name (string) --
    • Disabled (boolean) --
    • TriggerType (string) --
    • TriggerValue (string) --
    • TargetApplications (list) --
      • (dict) --
        • SipMediaApplicationId (string) --
        • Priority (integer) --
        • AwsRegion (string) --
    • CreatedTimestamp (datetime) --
    • UpdatedTimestamp (datetime) --

Exceptions

• ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
• ChimeSDKVoice.Client.exceptions.NotFoundException
• ChimeSDKVoice.Client.exceptions.ForbiddenException
• ChimeSDKVoice.Client.exceptions.BadRequestException
• ChimeSDKVoice.Client.exceptions.ThrottledClientException
• ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
• ChimeSDKVoice.Client.exceptions.ServiceFailureException