Skip to content
AWS for Query.Farm

aws.chime_sdk_voice.get_sip_rule

Example SQL Queries

SELECT * FROM
aws.chime_sdk_voice.get_sip_rule
WHERE
"sip_rule_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
sip_rule_id Required Input Column

The SIP rule ID.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

sip_rule

The SIP rule details.

STRUCT(
    "sip_rule_id" VARCHAR,
    "name" VARCHAR,
    "disabled" BOOLEAN,
    "trigger_type" VARCHAR,
    "trigger_value" VARCHAR,
    "target_applications" STRUCT(
        "sip_media_application_id" VARCHAR,
        "priority" BIGINT,
        "aws_region" VARCHAR
    )[],
    "created_timestamp" TIMESTAMP_S,
    "updated_timestamp" TIMESTAMP_S
)
Show child fields
sip_rule.created_timestamp

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

sip_rule.disabled

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

sip_rule.name

A SIP rule's name.

sip_rule.sip_rule_id

A SIP rule's ID.

sip_rule.target_applications[]
Show child fields
sip_rule.target_applications[].aws_region

The AWS Region of a rule's target SIP media application.

sip_rule.target_applications[].priority

The priority setting of a rule's target SIP media application.

sip_rule.target_applications[].sip_media_application_id

The ID of a rule's target SIP media application.

sip_rule.trigger_type

The type of trigger set for a SIP rule, either a phone number or a URI request host name.

sip_rule.trigger_value

The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.

sip_rule.updated_timestamp

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