Chime / Client / update_sip_rule

update_sip_rule#

Chime.Client.update_sip_rule(**kwargs)#

Updates the details of the specified SIP rule.

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]

    The SIP rule ID.

  • Name (string) –

    [REQUIRED]

    The new name for the specified SIP rule.

  • Disabled (boolean) – The new value specified to indicate whether the rule is disabled.

  • TargetApplications (list) –

    The new value of the list of target applications.

    • (dict) –

      Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

      • SipMediaApplicationId (string) –

        The SIP media application ID.

      • Priority (integer) –

        Priority of the SIP media application in the target list.

      • AwsRegion (string) –

        The AWS Region of the target application.

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) –

      Updated SIP rule details.

      • SipRuleId (string) –

        The SIP rule ID.

      • Name (string) –

        The name of the SIP rule.

      • Disabled (boolean) –

        Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

      • TriggerType (string) –

        The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

      • TriggerValue (string) –

        If TriggerType is RequestUriHostname, then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber, then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

      • TargetApplications (list) –

        Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

        • (dict) –

          Target SIP media application and other details, such as priority and AWS Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId (string) –

            The SIP media application ID.

          • Priority (integer) –

            Priority of the SIP media application in the target list.

          • AwsRegion (string) –

            The AWS Region of the target application.

      • CreatedTimestamp (datetime) –

        The time at which the SIP rule was created, in ISO 8601 format.

      • UpdatedTimestamp (datetime) –

        The time at which the SIP rule was last updated, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ConflictException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ResourceLimitExceededException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException