Skip to content
AWS for Query.Farm

aws.pinpoint.get_sms_channel

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_sms_channel
WHERE
"application_id" = 'VALUE';

Description

Retrieves information about the status and settings of the SMS channel for an application.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
sms_channel_response

Provides information about the status and settings of the SMS channel for an application.

STRUCT(
    "application_id" VARCHAR,
    "creation_date" VARCHAR,
    "enabled" BOOLEAN,
    "has_credential" BOOLEAN,
    "id" VARCHAR,
    "is_archived" BOOLEAN,
    "last_modified_by" VARCHAR,
    "last_modified_date" VARCHAR,
    "platform" VARCHAR,
    "promotional_messages_per_second" BIGINT,
    "sender_id" VARCHAR,
    "short_code" VARCHAR,
    "transactional_messages_per_second" BIGINT,
    "version" BIGINT
)
Show child fields
sms_channel_response.application_id

The unique identifier for the application that the SMS channel applies to.

sms_channel_response.creation_date

The date and time, in ISO 8601 format, when the SMS channel was enabled.

sms_channel_response.enabled

Specifies whether the SMS channel is enabled for the application.

sms_channel_response.has_credential

(Not used) This property is retained only for backward compatibility.

sms_channel_response.id

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

sms_channel_response.is_archived

Specifies whether the SMS channel is archived.

sms_channel_response.last_modified_by

The user who last modified the SMS channel.

sms_channel_response.last_modified_date

The date and time, in ISO 8601 format, when the SMS channel was last modified.

sms_channel_response.platform

The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

sms_channel_response.promotional_messages_per_second

The maximum number of promotional messages that you can send through the SMS channel each second.

sms_channel_response.sender_id

The identity that displays on recipients' devices when they receive messages from the SMS channel.

sms_channel_response.short_code

The registered short code to use when you send messages through the SMS channel.

sms_channel_response.transactional_messages_per_second

The maximum number of transactional messages that you can send through the SMS channel each second.

sms_channel_response.version

The current version of the SMS channel.