AWS End User Messaging SMS ですべての電話プールを表示する - AWS End User Messaging SMS

AWS End User Messaging SMS ですべての電話プールを表示する

既存のプールに関する情報を表示するには、describe-pools CLI を使用できます。

このオペレーションでは、AWS End User Messaging SMS アカウントのすべてのプールの完全なリスト、特定のプールに関する情報、または定義した条件に基づいてフィルタリングされたプールのリストを表示できます。

AWS CLI を使用してすべてのプールのリストを取得するには

  • コマンドラインで以下のコマンドを入力します。

    $ aws pinpoint-sms-voice-v2 describe-pools

特定のプールに関する情報を検索するには、PoolId パラメータを使用します。

AWS CLI を使用して特定のプールに関する情報を取得するには

  • コマンドラインで以下のコマンドを入力します。

    $ aws pinpoint-sms-voice-v2 describe-pools \ 
> --pool-id poolId

前述のコマンドで、poolId を、プールの一意の ID または Amazon リソースネーム (ARN) に置き換えます。

フィルタリングされたプールのリストを表示するには、Filters パラメータを使用します。フィルターには次の値を使用できます。

  • status – プールの現在のステータス (ACTIVE など)。

  • message-type – プールを使用して送信するメッセージのタイプ。想定される値は、TRANSACTIONAL または PROMOTIONAL です。

  • two-way-enabled – プール内の番号に対して双方向 SMS メッセージングが有効になっているかどうかを示すブール値。

  • self-managed-opt-outs-enabled – プール内の番号に対してセルフマネージド型 SMS オプトアウトが有効になっているかどうかを示すブール値。

  • opt-out-list-name – プールに関連付けられているオプトアウトリストの名前。

  • shared-routes-enabled – プールに対して共有ルートが有効になっているかどうかを示すブール値。

  • deletion-protection-enabled – DeletePhoneNumber オペレーションを使用して電話番号を削除できるかどうかを示すブール値。

例えば、双方向メッセージングをサポートするトランザクションメッセージのプールを一覧表示するには、コマンドラインで次のコマンドを入力します。

$ aws pinpoint-sms-voice-v2 describe-pools \
> --filters Name=message-type,Values=TRANSACTIONAL \
> --filters Name=two-way-enabled,Values=true