Skip to content
AWS for Query.Farm

aws.chime.list_sip_rules

Example SQL Queries

SELECT * FROM
aws.chime.list_sip_rules;

Description

Lists the SIP rules under the administrator's AWS account.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListSipRules, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Table Definition

Column NameColumn Data Type
max_results Input Column

The maximum number of results to return in a single call. Defaults to 100.

BIGINT
next_token Input Column

The token to use to retrieve the next page of results.

VARCHAR
sip_media_application_id Input Column

The SIP media application 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_rules

List of SIP rules and 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_rules[]
Show child fields
sip_rules[].created_timestamp

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

sip_rules[].disabled

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

sip_rules[].name

The name of the SIP rule.

sip_rules[].sip_rule_id

The SIP rule ID.

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

The AWS Region of the target application.

sip_rules[].target_applications[].priority

Priority of the SIP media application in the target list.

sip_rules[].target_applications[].sip_media_application_id

The SIP media application ID.

sip_rules[].trigger_type

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

sip_rules[].trigger_value

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.

sip_rules[].updated_timestamp

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