ChimeSDKVoice / Client / get_sip_rule

get_sip_rule#

ChimeSDKVoice.Client.get_sip_rule(**kwargs)#

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

Request Syntax

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

Parameters:

SipRuleId (string) –

[REQUIRED]

The SIP rule ID.

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) –
  
  The SIP rule details.
  - SipRuleId (string) –
    
    A SIP rule’s ID.
  - Name (string) –
    
    A SIP rule’s name.
  - 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 set for a SIP rule, either a phone number or a URI request host name.
  - TriggerValue (string) –
    
    The value set for a SIP rule’s trigger type. Either a phone number or a URI hostname.
  - TargetApplications (list) –
    
    The 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) –
      
      A 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 ID of a rule’s target SIP media application.
      - Priority (integer) –
        
        The priority setting of a rule’s target SIP media application.
      - AwsRegion (string) –
        
        The AWS Region of a rule’s target SIP media 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 updated, in ISO 8601 format.

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