

# Twilio に対する接続
<a name="connecting-to-data-twilio"></a>

Twilio は、ウェブサービス API を使用して、通話の送受信、テキストメッセージの送受信、その他の通信機能を実行するためのプログラム可能な通信ツールを提供します。Twilio の API は、通信用のプラットフォームを強化します。これらの API の背後にあるのは、世界中の通信ネットワークを接続し最適化するソフトウェアレイヤーです。これにより、ユーザーはグローバルに誰でも呼び出し、メッセージを送信できます。Twilio ユーザーとして、Twilio アカウントに AWS Glue を接続できます。その後、Twilio を ETL ジョブのデータソースとして使用できます。これらのジョブを実行して、Twilio と AWS サービス、またはその他のサポートされているアプリケーション間でデータを転送します。

**Topics**
+ [Twilio 向けの AWS Glue サポート](twilio-support.md)
+ [接続を作成および使用するための API オペレーションを含むポリシー](twilio-configuring-iam-permissions.md)
+ [Twilio の設定](twilio-configuring.md)
+ [Twilio 接続の設定](twilio-configuring-connections.md)
+ [Twilio エンティティからの読み取り](twilio-reading-from-entities.md)
+ [Twilio 接続オプション](twilio-connection-options.md)
+ [Twilio コネクタの制限と注意事項](twilio-connector-limitations.md)

# Twilio 向けの AWS Glue サポート
<a name="twilio-support"></a>

AWS Glue は、次のように Twilio をにサポートします。

**ソースとしてサポートされていますか?**  
はい。AWS Glue ETL ジョブを使用して、Twilio からデータをクエリできます。

**ターゲットとしてサポートされていますか?**  
いいえ。

**サポートされている Twilio API バージョン**  
次の Twilio API バージョンがサポートされています。
+ v1
+ 2010-04-01

# 接続を作成および使用するための API オペレーションを含むポリシー
<a name="twilio-configuring-iam-permissions"></a>

次のサンプル ポリシーで、接続の作成と使用に必要な AWS IAM 権限について説明します。新しいロールを作成する場合は、以下を含むポリシーを作成します。

------
#### [ JSON ]

****  

```
{
  "Version":"2012-10-17",		 	 	 
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "glue:ListConnectionTypes",
        "glue:DescribeConnectionType",
        "glue:RefreshOAuth2Tokens",
        "glue:ListEntities",
        "glue:DescribeEntity"
      ],
      "Resource": "*"
    }
  ]
}
```

------

上記の方法を使用しない場合は、代わりに次のマネージド IAM ポリシーを使用します:
+ [AWSGlueServiceRole](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/service-role/AWSGlueServiceRole) – さまざまな AWS Glue プロセスを実行するために必要なリソースへのアクセス権をユーザーに代わって付与します。これらのリソースには AWS Glue 、Amazon S3、IAM、CloudWatch Logs、および Amazon EC2 が含まれます。このポリシーで指定されたリソースの命名規則に従った場合、AWS Glue プロセスは必要なアクセス権限を使用できます。このポリシーは、通常、クローラ、ジョブ、開発エンドポイントを定義するときに指定されたロールにアタッチされます。
+ [AWSGlueConsoleFullAccess](https://console.aws.amazon.com/iam/home#policies/arn:aws:iam::aws:policy/AWSGlueConsoleFullAccess) — ポリシーがアタッチされているアイデンティティが AWS マネージメントコンソールを使用するときは、AWS Glue リソースへのフルアクセスを許可します。このポリシーで指定されたリソースの命名規則に従った場合、ユーザーは完全なコンソール機能を使用できます。このポリシーは、通常 AWS Glue コンソールのユーザーにアタッチされています。

# Twilio の設定
<a name="twilio-configuring"></a>

AWS Glue を使用して Twilio からデータを転送できるようにするには、次の要件を満たす必要があります。

## 最小要件
<a name="twilio-configuring-min-requirements"></a>

以下に、最小要件を示します。
+ ユーザー名とパスワードを持つ Twilio アカウントがある。
+ Twilio アカウントで API アクセスが有効になっている。

これらの要件を満たすと、Twilio アカウントに AWS Glue を接続する準備が整います。一般的な接続では、Twilio で他に何もする必要はありません。

# Twilio 接続の設定
<a name="twilio-configuring-connections"></a>

Twilio は、基本認証のユーザー名とパスワードをサポートしています。基本認証は、クライアントが保護されたリソースにアクセスするための認証情報を直接提供する簡単な認証方法です。AWS Glue はユーザー名 (アカウント SID) とパスワード (認証トークン) を使用して Twilio API を認証できます。

基本的な認証フローに関する Twilio のパブリックドキュメントについては、「[基本認証 \$1 Twilio](https://www.twilio.com/docs/glossary/what-is-basic-authentication)」を参照してください。

Twilio 接続を設定するには:

1. AWS Secrets Manager で、次の詳細を含むシークレットを作成します。
   + 基本認証の場合: シークレットには、**[アカウント SID]** (ユーザー名) と **[認証トークン]** (パスワード) を使用して接続されたアプリケーションのコンシューマーシークレットを含める必要があります。
**注記**  
AWS Glue で接続ごとにシークレットを作成する必要があります。

1. AWS Glue Glue Studio で、以下の手順に従って **[データ接続]** の下に接続を作成します。

   1. **[接続タイプ]** を選択する際に、[Twilio] を選択します。

   1. 接続先の Twilio インスタンスの `[Edge\$1Location](https://www.twilio.com/docs/global-infrastructure/edge-locations)` を指定します。

   1. 次のアクションを実行でき、AWS Glue がその権限を持つ AWS IAM ロールを選択します。

------
#### [ JSON ]

****  

      ```
      {
        "Version":"2012-10-17",		 	 	 
        "Statement": [
          {
            "Effect": "Allow",
            "Action": [
              "secretsmanager:DescribeSecret",
              "secretsmanager:GetSecretValue",
              "secretsmanager:PutSecretValue",
              "ec2:CreateNetworkInterface",
              "ec2:DescribeNetworkInterfaces",
              "ec2:DeleteNetworkInterface"
            ],
            "Resource": "*"
          }
        ]
      }
      ```

------

   1. AWS Glue でこの接続に使用する `secretName` を選択して、トークンを配置します。

   1. ネットワークを使用する場合は、ネットワークオプションを選択します。

1. AWS Glue ジョブに関連付けられている IAM ロールに `secretName` を読み取るアクセス許可を付与します。

# Twilio エンティティからの読み取り
<a name="twilio-reading-from-entities"></a>

**前提条件**

読み取り元の Twilio オブジェクト。`SMS-Message` または `SMS-CountryPricing` などのオブジェクト名が必要です。

**ソースに対応するエンティティ**:


| エンティティ | インターフェイス | フィルタリング可能 | 制限をサポートする | Order By をサポートする | Select \$1 をサポートする | パーティション分割をサポートする | 
| --- | --- | --- | --- | --- | --- | --- | 
| SMS-Message | REST | はい | あり | なし | あり | あり | 
| SMS-CountryPricing | REST | なし | なし | なし | あり | なし | 
| Voice-Call | REST | はい | あり | なし | あり | なし | 
| Voice-Application | REST | はい | あり | なし | あり | なし | 
| Voice-OutgoingCallerID | REST | はい | あり | なし | あり | なし | 
| Voice-Queue | REST | はい | あり | なし | あり | なし | 
| Conversations-Conversation | REST | はい | あり | なし | あり | なし | 
| Conversations-User | REST | なし | あり | なし | あり | なし | 
| Conversations-Role | REST | なし | あり | なし | あり | なし | 
| Conversations-Configuration | REST | なし | なし | なし | あり | なし | 
| Conversations-AddressConfiguration | REST | はい | あり | なし | あり | なし | 
| Conversations-WebhookConfiguration | REST | なし | なし | なし | あり | なし | 
| Conversations-ParticipantConversation | REST | なし | なし | なし | あり | なし | 
| Conversations-Credential | REST | なし | あり | なし | あり | なし | 
| Conversations-ConversationService | REST | なし | あり | なし | あり | なし | 

**例**:

```
twilio_read = glueContext.create_dynamic_frame.from_options(
    connection_type="twilio",
    connection_options={
        "connectionName": "connectionName",
        "ENTITY_NAME": "sms-message",
        "API_VERSION": "2010-04-01",
        "Edge_Location": "sydney.us1"
    }
```

**Twilio エンティティとフィールドの詳細**:

[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/glue/latest/dg/twilio-reading-from-entities.html)

## パーティショニングクエリ
<a name="twilio-reading-partitioning-queries"></a>

**パーティション分割をサポートするフィールド**:

Twilio では、DateTime データ型フィールドはフィールドベースのパーティシン分割をサポートしています。

Spark で同時実行を使用する場合は、追加の Spark オプション `PARTITION_FIELD`、`LOWER_BOUND`、`UPPER_BOUND`、および `NUM_PARTITIONS` を指定できます。これらのパラメータを使用すると、元のクエリは Spark タスクで同時に実行できるサブクエリの `NUM_PARTITIONS` の数に分割されます。
+ `PARTITION_FIELD`: クエリのパーティション化に使用するフィールドの名前。
+ `LOWER_BOUND`: 選択したパーティションフィールドの**包括的な**下限値。

  Datetime フィールドでは、Spark SQL クエリで使用される Spark タイムスタンプ形式を受け入れます。

  有効な値の例は次のとおりです:

  ```
  "2024-05-01T20:55:02.000Z"
  ```
+ `UPPER_BOUND`: 選択したパーティションフィールドの**排他的**上限値。
+ `NUM_PARTITIONS`: パーティション数。

例:

```
twilio_read = glueContext.create_dynamic_frame.from_options(
    connection_type="twilio",
    connection_options={
        "connectionName": "connectionName",
        "ENTITY_NAME": "sms-message",
        "API_VERSION": "2010-04-01",
        "PARTITION_FIELD": "date_sent"
        "LOWER_BOUND": "2024-05-01T20:55:02.000Z"
        "UPPER_BOUND": "2024-06-01T20:55:02.000Z"
        "NUM_PARTITIONS": "10"
    }
```

# Twilio 接続オプション
<a name="twilio-connection-options"></a>

Twilio の接続オプションは次のとおりです。
+ `ENTITY_NAME`(文字列) – (必須) 読み取りに使用されます。Twilio のオブジェクトの名前。
+ `EDGE_LOCATION`(文字列) – (必須) 有効な Twilio エッジロケーション。
+ `API_VERSION`(文字列) – (必須) 読み取りに使用されます。使用する Twilio Rest API バージョン。Twilio は、「v1」と「2010-04-01」の 2 つの API バージョンをサポートしています。
+ `SELECTED_FIELDS`(List<String>) – Default: empty(SELECT \$1). 読み込みに使用されます。オブジェクトに選択する列です。
+ `FILTER_PREDICATE`(文字列) – デフォルト: 空 読み込みに使用されます。Spark SQL 形式である必要があります。
+ `QUERY`(文字列) - デフォルト: 空 読み込みに使用されます。完全な Spark SQL クエリです。
+ `PARTITION_FIELD`(文字列) - 読み取りに使用されます。クエリをパーティション化するために使用するフィールドです。
+ `LOWER_BOUND`(文字列) - 読み取りに使用されます。選択したパーティションフィールドの包括的な下限値。
+ `UPPER_BOUND` (文字列) - 読み取りに使用されます。選択したパーティションフィールドの排他的上限値。
+ `NUM_PARTITIONS`(整数) – デフォルト: 1。読み込みに使用されます。読み取り用のパーティションの数。
+ `INSTANCE_URL` (文字列) – (必須) 読み取りに使用されます。有効な Twilio インスタンス URL。

# Twilio コネクタの制限と注意事項
<a name="twilio-connector-limitations"></a>

Twilio コネクタの制限事項または注意事項は次のとおりです。
+ レコードベースのパーティション分割はサポートされていないのは、Twilio からレコードの合計数を取得するためのプロビジョニングがないためです
+ フィールド `date_sent`、`start_time`、`end_time` は Datetime データ型ですが、フィルタリング時には日付値のみをサポートします (時間コンポーネントは考慮されません)。
+ 「from」フィールドまたは「to」フィールドのフィルタリングは、値にプレフィックス (プロトコルやラベルなど) が含まれていない場合にのみ機能します。プレフィックスが存在する場合、それぞれのフィールドのフィルタリングは機能しません。たとえば、「to」:「whatsapp:\$114xxxxxxxxxx」をフィルターとして渡すと、Twilio はレスポンスを返しません。「to」:「\$114xxxxxxxx」として渡す必要があります。レコードが存在する場合はレコードが返されます。
+ `conversation-participant-conversation` エンティティをクエリするときは、「identity」フィールドフィルターは必須です。