ChimeSDKVoice / Client / update_sip_rule

update_sip_rule

ChimeSDKVoice.Client.update_sip_rule(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_sip_rule(
    SipRuleId='string',
    Name='string',
    Disabled=True|False,
    TargetApplications=[
        {
            'SipMediaApplicationId': 'string',
            'Priority': 123,
            'AwsRegion': 'string'
        },
    ]
)

Parameters:

• SipRuleId (string) – [REQUIRED]

• Name (string) – [REQUIRED]

• Disabled (boolean) –

• TargetApplications (list) –

  • (dict) –

    • SipMediaApplicationId (string) –

    • Priority (integer) –

    • AwsRegion (string) –

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.ConflictException

• ChimeSDKVoice.Client.exceptions.ThrottledClientException

• ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException

• ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

• ChimeSDKVoice.Client.exceptions.ServiceFailureException