# 接続タイプ API
この「接続タイプ API」では、接続タイプを登録、記述、削除、一覧表示する AWS Glue API について説明します。
## 接続管理 API
+ [RegisterConnectionType アクション (Python: register\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-RegisterConnectionType)
+ [DeleteConnectionType アクション (Python: delete\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-DeleteConnectionType)
+ [DescribeConnectionType アクション (Python: describe\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes アクション (Python: list\_connection\_types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [ConnectionTypeBrief 構造](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [ConnectionTypeVariant の構造](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)
## RegisterConnectionType アクション (Python: register\_connection\_type)
AWS Glue に、指定された設定に基づいてカスタム接続タイプを登録します。このオペレーションを行えば REST ベースの API を使用して任意のデータソース向けにカスタムコネクタを設定でき、カスタム Lambda コネクタを構築する必要がなくなります。
登録された接続タイプには、REST ソースによるリクエストと応答の解釈方法 (接続プロパティ、認証設定、エンティティ定義を使用した REST 設定など) の詳細が保存されます。登録後、お客様はこの接続タイプを使用して接続を作成し、ネイティブにサポートされている AWS Glue コネクタと同じ方法でそれらを操作できます。
Basic、OAuth2 (クライアント認証情報、JWT ベアラー、認可コード)、Custom Auth 設定など、複数の認証タイプがサポートされています。
**リクエスト**
+ `ConnectionType` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続タイプの名前。字数は 1～255 字以内で、REST ベースの connector であることを示すためプレフィックス「REST-」を付けます。
+ `IntegrationType` – *必須:* UTF-8 文字列 (有効な値: `REST`)。
接続の統合タイプ。現在は "REST" プロトコルのみがサポートされています。
+ `Description` – UTF-8 文字列、1024 バイト長以下。
接続タイプの説明。2048 文字以内で、接続タイプの目的と機能の詳細を記します。
+ `ConnectionProperties` – *必須:* [ConnectionPropertiesConfiguration](#aws-glue-api-catalog-connections-connections-type-ConnectionPropertiesConfiguration) オブジェクト。
この接続タイプの接続作成中に必要となる、ベース URL と追加のリクエストパラメータを定義します。
+ `ConnectorAuthenticationConfiguration` – *必須:* [ConnectorAuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthenticationConfiguration) オブジェクト。
この接続タイプでサポートされている認証タイプと必要なプロパティを定義します (Basic、OAuth2、Custom 認証方法など)。
+ `RestConfiguration` – *必須:* [RestConfiguration](#aws-glue-api-catalog-connections-connections-type-RestConfiguration) オブジェクト。
REST API インタラクション向けの HTTP リクエストとレスポンスの設定、検証エンドポイント、エンティティの設定を定義します。
+ `Tags` – キーと値のペアのマップ配列。50 ペア以下。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
接続タイプに割り当てるタグです。
**応答**
新しく登録された接続タイプの Amazon リソースネーム (ARN) が含まれています。
+ `ConnectionTypeArn` – UTF-8 文字列。1～10240 バイト長。[Custom string pattern #47](aws-glue-api-common.md#regex_47) に一致。
登録済みの接続タイプの Amazon リソースネーム (ARN) が含まれています。この一意の識別子は、他の AWS Glue オペレーションで接続タイプを参照するときに使用できます。
**エラー**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
## DeleteConnectionType アクション (Python: delete\_connection\_type)
AWS Glue のカスタム接続タイプを削除します。
削除できるのは、その時点で存在し登録されている接続タイプです。この操作は、接続タイプのリソースのクリーンアップをサポートしており、カスタム接続タイプのライフサイクルを適切に管理するのに役立ちます。
**リクエスト**
+ `ConnectionType` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除する接続タイプの名前。既存の登録済み接続タイプを参照する必要があります。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `AccessDeniedException`
## DescribeConnectionType アクション (Python: describe\_connection\_type)
`DescribeConnectionType` API は、AWS Glue の特定の接続タイプでサポートされているオプションの詳細を提供します。応答には、サポートされている認証タイプとプロパティを示す認証設定の詳細、および `RegisterConnectionType` を介して登録されたカスタム REST ベースの接続タイプの RestConfiguration が含まれています。
も参照してください。`ListConnectionTypes``RegisterConnectionType``DeleteConnectionType`
**リクエスト**
+ `ConnectionType` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
説明する接続タイプの名前。
**応答**
+ `ConnectionType` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続タイプの名前。
+ `Description` – UTF-8 文字列、1024 バイト長以下。
接続タイプの説明。
+ `Capabilities` – [機能](#aws-glue-api-catalog-connections-connections-type-Capabilities) オブジェクト。
サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、および connector のデータオペレーション。
+ `ConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
コンピューティング環境間で共通の接続プロパティ。
+ `ConnectionOptions` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
`ConnectionInput.ConnectionProperties` で接続を作成するときに設定できるプロパティを返します。`ConnectionOptions` は、データフレームに渡される接続オプションマップの Spark ETL スクリプトで設定できるパラメータを定義します。
+ `AuthenticationConfiguration` – [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration) オブジェクト。
接続に使用する認証のタイプ。
+ `ComputeEnvironmentConfigurations` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) オブジェクトです。
接続でサポートされているコンピューティング環境。
+ `PhysicalConnectionRequirements` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
接続の物理的な要件 (VPC、サブネット、セキュリティグループの仕様など)。
+ `AthenaConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
Athena コンピューティング環境に固有の接続プロパティ。
+ `PythonConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
Python コンピューティング環境に固有の接続プロパティ。
+ `SparkConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
Spark コンピューティング環境に固有の接続プロパティ。
+ `RestConfiguration` – [RestConfiguration](#aws-glue-api-catalog-connections-connections-type-RestConfiguration) オブジェクト。
REST ベースのデータソース向けの HTTP リクエストとレスポンスの設定、検証エンドポイント、エンティティの設定。
**エラー**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`
## ListConnectionTypes アクション (Python: list\_connection\_types)
`ListConnectionTypes` API は、AWS Glue で使用可能な接続タイプを学習するための検出メカニズムを提供します。応答には、接続タイプの一覧が、各接続タイプでサポートされている内容の大まかな詳細をとともに記され、これには `RegisterConnectionType` を介して登録された組み込み接続タイプとカスタム接続タイプの両方も含まれます。リストに挙げられている接続タイプは、`CreateConnection` API の `ConnectionType` 値に対してサポートされているオプションのセットです。
も参照してください。`DescribeConnectionType``RegisterConnectionType``DeleteConnectionType`
**リクエスト**
+ `MaxResults` – 1～1000 の数値 (整数)。
返される結果の最大数。
+ `NextToken` – UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (これが継続呼び出しの場合)。
**応答**
+ `ConnectionTypes` – [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief) オブジェクトの配列。
サポートされている接続タイプに関する簡単な情報を含む `ConnectionTypeBrief` オブジェクトのリスト。
+ `NextToken` – UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (現在のリストが最後ではない場合に表示されます)。
**エラー**
+ `InternalServiceException`
## ConnectionTypeBrief 構造
`ListConnectionTypes` API によって返される、サポートされている接続タイプに関する簡単な情報。
**フィールド**
+ `ConnectionType` – UTF-8 文字列です (有効な値: `JDBC` \| `SFTP` \| `MONGODB` \| `KAFKA` \| `NETWORK` \| `MARKETPLACE` \| `CUSTOM` \| `SALESFORCE` \| `VIEW_VALIDATION_REDSHIFT` \| `VIEW_VALIDATION_ATHENA` \| `GOOGLEADS` \| `GOOGLESHEETS` \| `GOOGLEANALYTICS4` \| `SERVICENOW` \| `MARKETO` \| `SAPODATA` \| `ZENDESK` \| `JIRACLOUD` \| `NETSUITEERP` \| `HUBSPOT` \| `FACEBOOKADS` \| `INSTAGRAMADS` \| `ZOHOCRM` \| `SALESFORCEPARDOT` \| `SALESFORCEMARKETINGCLOUD` \| `ADOBEANALYTICS` \| `SLACK` \| `LINKEDIN` \| `MIXPANEL` \| `ASANA` \| `STRIPE` \| `SMARTSHEET` \| `DATADOG` \| `WOOCOMMERCE` \| `INTERCOM` \| `SNAPCHATADS` \| `PAYPAL` \| `QUICKBOOKS` \| `FACEBOOKPAGEINSIGHTS` \| `FRESHDESK` \| `TWILIO` \| `DOCUSIGNMONITOR` \| `FRESHSALES` \| `ZOOM` \| `GOOGLESEARCHCONSOLE` \| `SALESFORCECOMMERCECLOUD` \| `SAPCONCUR` \| `DYNATRACE` \| `MICROSOFTDYNAMIC365FINANCEANDOPS` \| `MICROSOFTTEAMS` \| `BLACKBAUDRAISEREDGENXT` \| `MAILCHIMP` \| `GITLAB` \| `PENDO` \| `PRODUCTBOARD` \| `CIRCLECI` \| `PIPEDIVE` \| `SENDGRID` \| `AZURECOSMOS` \| `AZURESQL` \| `BIGQUERY` \| `BLACKBAUD` \| `CLOUDERAHIVE` \| `CLOUDERAIMPALA` \| `CLOUDWATCH` \| `CLOUDWATCHMETRICS` \| `CMDB` \| `DATALAKEGEN2` \| `DB2` \| `DB2AS400` \| `DOCUMENTDB` \| `DOMO` \| `DYNAMODB` \| `GOOGLECLOUDSTORAGE` \| `HBASE` \| `KUSTOMER` \| `MICROSOFTDYNAMICS365CRM` \| `MONDAY` \| `MYSQL` \| `OKTA` \| `OPENSEARCH` \| `ORACLE` \| `PIPEDRIVE` \| `POSTGRESQL` \| `SAPHANA` \| `SQLSERVER` \| `SYNAPSE` \| `TERADATA` \| `TERADATANOS` \| `TIMESTREAM` \| `TPCDS` \| `VERTICA`)。
接続タイプの名前。
+ `DisplayName` – UTF-8 文字列、1～128 バイト長。
AWS Glue コンソールに表示される接続タイプの人間が読み取れる名前。
+ `Vendor` – UTF-8 文字列、1～128 バイト長。
この接続タイプを作成または管理するベンダーまたはプロバイダーの名前。
+ `Description` – UTF-8 文字列、1024 バイト長以下。
接続タイプの説明。
+ `Categories` – UTF-8 文字列の配列。
この接続タイプが属するカテゴリのリスト。カテゴリは、ユーザーがユースケースに基づいて適切な接続タイプをフィルタリングして見つけるために役立ちます。
+ `Capabilities` – [機能](#aws-glue-api-catalog-connections-connections-type-Capabilities) オブジェクト。
サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、および connector のデータオペレーション。
+ `LogoUrl` – UTF–8 文字列。
接続タイプに関連付けられたロゴの URL。
+ `ConnectionTypeVariants` – [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) オブジェクトの配列。
この接続タイプで利用可能なバリアントのリスト。さまざまなバリアントは、同じ一般的な接続タイプの特定ユースケースや実装に特殊な設定を提供する場合があります。
## ConnectionTypeVariant の構造
AWS Glue の接続タイプバリアントを表します。接続タイプバリアントは、同じ一般的な接続タイプのさまざまな実装に特定の設定および動作があります。
**フィールド**
+ `ConnectionTypeVariantName` – UTF-8 文字列、1～128 バイト長。
接続タイプバリアントの一意の識別子。この名前は、接続タイプの特定バリアントを識別するために内部で使用されます。
+ `DisplayName` – UTF-8 文字列、1～128 バイト長。
AWS Glue コンソールに表示される接続タイプバリアントにおいて、人間が読み取れる名前。
+ `Description` – UTF-8 文字列、1024 バイト長以下。
目的、ユースケース、特定の設定要件など、接続タイプバリアントの詳細な説明。
+ `LogoUrl` – UTF–8 文字列。
接続タイプバリアントに関連付けられたロゴの URL。
## データ型
+ [検証構造](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [AuthConfiguration 構造](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [Capabilities 構造](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [Property 構造](#aws-glue-api-catalog-connections-connections-type-Property)
+ [AllowedValue 構造](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [ComputeEnvironmentConfiguration 構造](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)
## 検証構造
接続プロパティでの検証の実行方法を定義します。
**フィールド**
+ `ValidationType` – *必須:* UTF-8 文字列 (有効な値: `REGEX` \| `RANGE`)。
実行する検証のタイプ (`REGEX` など)。
+ `Patterns` – UTF-8 文字列の配列。
検証に適用されるパターンのリスト。
+ `Description` – *必須:* UTF-8 文字列、1～1024 バイト長。
検証の説明。
+ `MaxLength` – 数値 (整数)。
文字列接続プロパティの最大長。
+ `Maximum` – 数値 (整数)。
検証の `RANGE` タイプを指定するときの最大値。
+ `Minimum` – 数値 (整数)。
検証の `RANGE` タイプを指定するときの最小値。
## AuthConfiguration 構造
`DescribeConnectionType` API によって返される接続の認証設定。
**フィールド**
+ `AuthenticationType` – *必須:* [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクト。
接続の認証のタイプ。
+ `SecretArn` – [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクト。
Secrets Manager の Amazon リソースネーム (ARN)。
+ `OAuth2Properties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
OAuth2 プロパティのキーと値のペアのマップ。各値は A `Property` オブジェクトです。
+ `BasicAuthenticationProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
OAuth2 プロパティのキーと値のペアのマップ。各値は A `Property` オブジェクトです。
+ `CustomAuthenticationProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
カスタム認証プロパティのキーと値のペアのマップ。各値は A `Property` オブジェクトです。
## Capabilities 構造
`DescribeConnectionType` API によって返される、サポートされている認証タイプを指定します。
**フィールド**
+ `SupportedAuthenticationTypes` – *必須:* UTF-8 文字列の配列。
サポートされている認証タイプのリスト。
+ `SupportedDataOperations` – *必須:* UTF-8 文字列の配列。
サポートされているデータオペレーションのリスト。
+ `SupportedComputeEnvironments` – *必須:* UTF-8 文字列の配列。
サポートされているコンピューティング環境のリスト。
## Property 構造
コンピューティング環境の接続タイプを定義するオブジェクト。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～128 バイト長。
プロパティの名前。
+ `Description` – *必須:* UTF-8 文字列。1024 以下のバイト長。
プロパティの説明。
+ `Required` – *必須:* ブール。
プロパティが必須かどうかを示します。
+ `DefaultValue` – UTF–8 文字列。
プロパティのデフォルト値。
+ `PropertyTypes` – *必須:* UTF-8 文字列の配列。
プロパティのタイプを説明します。
+ `AllowedValues` – [allowedValues](#aws-glue-api-catalog-connections-connections-type-AllowedValue) オブジェクトの配列。
プロパティに許可される値を表す `AllowedValue` オブジェクトのリスト。
+ `DataOperationScopes` – UTF-8 文字列の配列。
どのデータオペレーションをプロパティに適用できるかを示します。
+ `KeyOverride` – UTF–8 文字列。
表示名と異なる場合に、API リクエストでこのプロパティを送信するときに使用するキー名。
+ `PropertyLocation` – UTF-8 文字列 (有効な値: `HEADER` \| `BODY` \| `QUERY_PARAM` \| `PATH`)。
ヘッダー、クエリパラメータ、リクエスト本文など、このプロパティを REST リクエストのどこに含めるかを指定します。
## AllowedValue 構造
プロパティに許可される値を表すオブジェクト。
**フィールド**
+ `Description` – UTF-8 文字列、1024 バイト長以下。
許可される値の説明。
+ `Value` – *必須:* UTF-8 文字列。1～128 バイト長。
プロパティに許可される値。
## ComputeEnvironmentConfiguration 構造
`DescribeConnectionType` API によって返されるコンピューティング環境 (Spark、Python、Athena など) の設定を含むオブジェクト。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～128 バイト長。
コンピューティング環境設定の名前。
+ `Description` – *必須:* UTF-8 文字列。1,024 以下のバイト長。
コンピューティング環境の説明。
+ `ComputeEnvironment` – *必須:* UTF-8 文字列 (有効な値: `SPARK` \| `ATHENA` \| `PYTHON`)。
コンピューティング環境のタイプ。
+ `SupportedAuthenticationTypes` – *必須:* UTF-8 文字列の配列。
コンピューティング環境でサポートされている認証タイプ。
+ `ConnectionOptions` – *必須:* キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
コンピューティング環境の接続オプションとして使用されるパラメータ。
+ `ConnectionPropertyNameOverrides` – *必須:* キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～128 バイト長です。
接続プロパティ名はコンピューティング環境に対して上書きされます。
+ `ConnectionOptionNameOverrides` – *必須:* キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～128 バイト長です。
接続オプション名はコンピューティング環境に対して上書きされます。
+ `ConnectionPropertiesRequiredOverrides` – *必須:* UTF-8 文字列の配列。
コンピューティング環境の上書きとして必要な接続プロパティ。
+ `PhysicalConnectionPropertiesRequired` – ブール。
コンピューティング環境に `PhysicalConnectionProperties` が必要かどうかを示します。
## カスタムコネクタのデータ型
+ [ConnectionPropertiesConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-ConnectionPropertiesConfiguration)
+ [ConnectorAuthenticationConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthenticationConfiguration)
+ [ConnectorProperty の構造](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty)
+ [RestConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-RestConfiguration)
+ [SourceConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration)
+ [EntityConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-EntityConfiguration)
+ [ResponseConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-ResponseConfiguration)
+ [ResponseExtractionMapping の構造](#aws-glue-api-catalog-connections-connections-type-ResponseExtractionMapping)
+ [PaginationConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-PaginationConfiguration)
+ [CursorConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-CursorConfiguration)
+ [OffsetConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-OffsetConfiguration)
+ [ExtractedParameter の構造](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter)
+ [FieldDefinition の構造](#aws-glue-api-catalog-connections-connections-type-FieldDefinition)
+ [ConnectorOAuth2Properties の構造](#aws-glue-api-catalog-connections-connections-type-ConnectorOAuth2Properties)
+ [ClientCredentialsProperties の構造](#aws-glue-api-catalog-connections-connections-type-ClientCredentialsProperties)
+ [JWTBearerProperties の構造](#aws-glue-api-catalog-connections-connections-type-JWTBearerProperties)
+ [ConnectorAuthorizationCodeProperties の構造](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthorizationCodeProperties)
+ [BasicAuthenticationProperties の構造](#aws-glue-api-catalog-connections-connections-type-BasicAuthenticationProperties)
+ [CustomAuthenticationProperties の構造](#aws-glue-api-catalog-connections-connections-type-CustomAuthenticationProperties)
+ [FilterConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-FilterConfiguration)
+ [FilterOverrides の構造](#aws-glue-api-catalog-connections-connections-type-FilterOverrides)
+ [BetweenConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration)
+ [FilterStringConfiguration の構造](#aws-glue-api-catalog-connections-connections-type-FilterStringConfiguration)
## ConnectionPropertiesConfiguration の構造
接続の作成中に必要となる、ベース URL と追加のリクエストパラメータを定義する設定。
**フィールド**
+ `Url` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
この接続タイプの接続先となるエンドポイントのベースインスタンス URL。
+ `AdditionalRequestParameters` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクトの配列。
API のバージョンやサービス固有の設定オプションなど、接続の作成時に必要となる可能性のある追加のリクエストパラメータのキーと値のペア。
## ConnectorAuthenticationConfiguration の構造
この接続タイプでサポートされている認証タイプと必要なプロパティを定義する設定。
**フィールド**
+ `AuthenticationTypes` – *必須:* UTF-8 文字列の配列。
この接続タイプでサポートされている認証タイプのリスト (Basic、OAuth2、Custom 認証方法など)。
## ConnectorProperty の構造
接続タイプ、デフォルト値、リクエスト内でプロパティを使用する場所などのプロパティ設定を定義します。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～128 バイト長。
プロパティの名前。
+ `KeyOverride` – UTF-8 文字列。1～128 バイト長。[Custom string pattern #15](aws-glue-api-common.md#regex_15) に一致。
表示名と異なる場合に、API リクエストでこのプロパティを送信するときに使用するキー名。
+ `Required` – *必須:* ブール。
プロパティが必須かどうかを示します。
+ `DefaultValue` – UTF–8 文字列。
プロパティのデフォルト値。
+ `AllowedValues` – UTF-8 文字列の配列。
プロパティに許可される値を表す `AllowedValue` オブジェクトのリスト。
+ `PropertyLocation` – UTF-8 文字列 (有効な値: `HEADER` \| `BODY` \| `QUERY_PARAM` \| `PATH`)。
ヘッダー、クエリパラメータ、リクエスト本文など、このプロパティを REST リクエストのどこに含めるかを指定します。
+ `PropertyType` – *必須:* UTF-8 文字列 (有効な値: `USER_INPUT` \| `SECRET` \| `READ_ONLY` \| `UNUSED` \| `SECRET_OR_USER_INPUT`)。
このプロパティのデータタイプ。
+ `Format` – UTF–8 文字列。
API リクエストで送信する前に値をフォーマットする方法を定義する、プロパティ値の形式テンプレート。実際のプロパティ値のプレースホルダーとして `{value}` を使用します (例: `SSWS {value}`)。
## RestConfiguration の構造
REST API インタラクション向けの HTTP リクエストとレスポンスの処理、検証エンドポイント、エンティティの設定を定義します。
**フィールド**
+ `GlobalSourceConfiguration` – [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration) オブジェクト。
この接続タイプのすべての REST API リクエストに適用されるグローバル設定 (一般的なリクエストメソッド、パス、パラメータなど)。
+ `ValidationEndpointConfiguration` – [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration) オブジェクト。
接続の作成時に接続認証情報の検証と接続のテストに使用される、エンドポイントの設定。
+ `EntityConfigurations` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列、1～128 バイト長で、[Custom string pattern #12](aws-glue-api-common.md#regex_12) に一致します。
各値は A [EntityConfiguration](#aws-glue-api-catalog-connections-connections-type-EntityConfiguration) オブジェクトです。
スキーマやアクセスパターンなど、REST API を介して使用できるさまざまなデータエンティティを操作する方法を定義する、エンティティ設定のマップ。
## SourceConfiguration の構造
リクエストメソッド、パス、パラメータ、レスポンス処理など、エンドポイントにリクエストを行う方法を定義する設定。
**フィールド**
+ `RequestMethod` – UTF-8 文字列 (有効な値: `GET` \| `POST`)。
このエンドポイントへのリクエストに使用する HTTP メソッド (GET、POST など)。
+ `RequestPath` – UTF-8 文字列。1～512 バイト長。[Custom string pattern #14](aws-glue-api-common.md#regex_14) に一致。
REST エンドポイントの URL パス。リクエスト中に実際の値に置き換えられるパラメータプレースホルダーが含まれる場合があります。
+ `RequestParameters` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクトの配列。
クエリパラメータ、ヘッダー、本文のコンテンツなど、API コールに含める必要があるリクエストパラメータの設定。
+ `ResponseConfiguration` – [ResponseConfiguration](#aws-glue-api-catalog-connections-connections-type-ResponseConfiguration) オブジェクト。
成功および失敗の処理など、API レスポンスからデータを解析して抽出する方法を定義する設定。
+ `PaginationConfiguration` – [PaginationConfiguration](#aws-glue-api-catalog-connections-connections-type-PaginationConfiguration) オブジェクト。
REST API から送られるページ分割されたレスポンスを処理するための設定。カーソルベースとオフセットベース両方のページ分割戦略をサポートしています。
+ `FilterConfiguration` – [FilterConfiguration](#aws-glue-api-catalog-connections-connections-type-FilterConfiguration) オブジェクト。
REST API リクエストにフィルタープッシュダウンを適用し、フィルター述語をクエリパラメータまたはフィルター文字列に変換する方法を定義する設定。
## EntityConfiguration の構造
アクセスパターンやスキーマ定義など、REST API を使用して特定のデータエンティティとの対話方法を定義する設定。
**フィールド**
+ `SourceConfiguration` – [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration) オブジェクト。
REST API を使用してこのエンティティのデータにアクセスするための、リクエスト方法を定義するソース設定。
+ `Schema` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列 (1 バイト長以上) です。
各値は A [fieldDefinition](#aws-glue-api-catalog-connections-connections-type-FieldDefinition) オブジェクトです。
フィールド名、タイプ、データ構造を記述するその他メタデータなど、このエンティティのスキーマ定義です。
## ResponseConfiguration の構造
結果データやエラー情報へのパスなど、REST API コールから送られる JSON レスポンスを解析する方法を定義する設定。
**フィールド**
+ `ResultPath` – *必須:*UTF-8 文字列。1～512 バイト長。[Custom string pattern #10](aws-glue-api-common.md#regex_10) に一致。
API レスポンス内の実際の結果データの場所を特定する JSON パス式。
+ `ErrorPath` – UTF-8 文字列。1～512 バイト長。[Custom string pattern #10](aws-glue-api-common.md#regex_10) に一致。
リクエストが失敗したときに API レスポンス内のエラー情報の場所を特定する JSON パス式。
## ResponseExtractionMapping の構造
HTTP レスポンスのコンテンツまたはヘッダーから、後続のリクエストまたはパラメータマッピングで使用する値を、抽出する方法を定義する設定。
**フィールド**
+ `ContentPath` – UTF-8 文字列。1 ～ 512 バイト長。[Custom string pattern #10](aws-glue-api-common.md#regex_10) に一致。
レスポンスの本文から値を抽出する方法を指定する JSON パス式。
+ `HeaderKey` – UTF-8 文字列。1～128 バイト長。[Custom string pattern #15](aws-glue-api-common.md#regex_15) に一致。
値の抽出元となる HTTP レスポンスのヘッダー名。
## PaginationConfiguration の構造
REST API から送られるページ分割されたレスポンスの処理方法を定義する設定。さまざまなサービスで使用される各種ページ分割戦略をサポートしています。
**フィールド**
+ `CursorConfiguration` – [CursorConfiguration](#aws-glue-api-catalog-connections-connections-type-CursorConfiguration) オブジェクト。
カーソルベースのページ分割の設定。API はここに結果の次のページを取得するためのカーソルまたはトークンを記載します。
+ `OffsetConfiguration` – [OffsetConfiguration](#aws-glue-api-catalog-connections-connections-type-OffsetConfiguration) オブジェクト。
オフセットベースのページ分割の設定。API はここで数値オフセットと制限を使用して、返される結果を制御します。
## CursorConfiguration の構造
カーソルトークンまたは次のページの識別子を使用してページ分割を処理する方法を定義する、カーソルベースのページ分割設定。
**フィールド**
+ `NextPage` – *必須:* [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) オブジェクト。
結果の次のページを取得するためのカーソルまたはトークンを含む、パラメータ名または JSON パス。
+ `LimitParameter` – [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) オブジェクト。
返す結果の、1 ページあたりの最大数を指定する際に使用するパラメータの名前。
## OffsetConfiguration の構造
数値オフセットと制限を使用してページ分割を処理する方法を定義する、オフセットベースのページ分割設定。
**フィールド**
+ `OffsetParameter` – *必須:* [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) オブジェクト。
結果を取得するための開始位置またはオフセットを指定する際に使用するパラメータの名前。
+ `LimitParameter` – *必須:* [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) オブジェクト。
返す結果の、1 ページあたりの最大数を指定する際に使用するパラメータの名前。
## ExtractedParameter の構造
API レスポンスから値を抽出してリクエストパラメータにマッピングするための方法を定義する、パラメータ抽出設定。
**フィールド**
+ `Key` – UTF-8 文字列。1～128 バイト長。[Custom string pattern #15](aws-glue-api-common.md#regex_15) に一致。
後続のリクエストで使用されるパラメータキーの名前。
+ `DefaultValue` – UTF-8 文字列。1～1,024 バイト長。[Custom string pattern #16](aws-glue-api-common.md#regex_16) に一致。
パラメータをレスポンスから抽出できない場合に使用するデフォルト値。
+ `PropertyLocation` – UTF-8 文字列 (有効な値: `HEADER` \| `BODY` \| `QUERY_PARAM` \| `PATH`)。
ヘッダー、クエリパラメータ、リクエスト本文など、抽出されたパラメータを後続のリクエストに配置する場所を指定します。
+ `Value` – [ResponseExtractionMapping](#aws-glue-api-catalog-connections-connections-type-ResponseExtractionMapping) オブジェクト。
API レスポンスからパラメータ値を抽出する方法を定義する JSON パスまたは抽出マッピング。
## FieldDefinition の構造
REST コネクタデータソースのエンティティスキーマのフィールドを定義し、フィールド名とデータ型を指定します。
**フィールド**
+ `Name` – *必須:* UTF–8 文字列。
エンティティスキーマのフィールドの名前。
+ `FieldDataType` – *必須:* UTF-8 文字列 (有効な値: `INT` \| `SMALLINT` \| `BIGINT` \| `FLOAT` \| `LONG` \| `DATE` \| `BOOLEAN` \| `MAP` \| `ARRAY` \| `STRING` \| `TIMESTAMP` \| `DECIMAL` \| `BYTE` \| `SHORT` \| `DOUBLE` \| `STRUCT` \| `BINARY` \| `UNION`).
フィールドのデータ型。
+ `ResponseDateFormat` – UTF–8 文字列。
API レスポンスの日付値を解析するための形式パターン。API が ISO-8601 以外の形式を使用している場合に必要になります。Java `DateTimeFormatter` パターン (例: `EEE, d MMM yyyy HH:mm:ss Z`)、Unix エポック秒の場合は `EPOCH_SECONDS`、Unix エポックミリ秒の場合は `EPOCH_MILLIS` を使用できます。
+ `IsPartitionable` – ブール。
このフィールドをデータソースへのクエリのパーティショニングに使用できるかを示します。
+ `IsNullable` – ブール。
このフィールドに null 値を含められるかを示します。
+ `IsQueryable` – ブール。
このフィールドをデータのクエリ時にフィルター述語で使用できるかを示します。
+ `IsOrderable` – ブール。
このフィールドを結果の順序付けに使用できるかを示します。
+ `FilterOverrides` – [FilterOverrides](#aws-glue-api-catalog-connections-connections-type-FilterOverrides) オブジェクト。
フィルター動作をフィールドごとにオーバーライドします。フィルターを特定のフィールドに適用する方法をカスタマイズできます。
## ConnectorOAuth2Properties の構造
OAuth2 ベースの接続の認証プロパティとフロー固有の設定を定義する OAuth2 設定コンテナ。
**フィールド**
+ `OAuth2GrantType` – *必須:* UTF-8 文字列 (有効な値: `CLIENT_CREDENTIALS` \| `JWT_BEARER` \| `AUTHORIZATION_CODE`)。
認証に使用する OAuth2 の許可タイプ。CLIENT\_CREDENTIALS、JWT\_BEARER、AUTHORIZATION\_CODE など。
+ `ClientCredentialsProperties` – [ClientCredentialsProperties](#aws-glue-api-catalog-connections-connections-type-ClientCredentialsProperties) オブジェクト。
OAuth2 クライアント認証情報の付与タイプのフローに固有の設定プロパティ。
+ `JWTBearerProperties` – [JWTBearerProperties](#aws-glue-api-catalog-connections-connections-type-JWTBearerProperties) オブジェクト。
OAuth2 JWT ベアラー付与タイプのフローに固有の設定プロパティ。
+ `AuthorizationCodeProperties` – [ConnectorAuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthorizationCodeProperties) オブジェクト。
OAuth2 J 認可コードの付与タイプのフローに固有の設定プロパティ。
## ClientCredentialsProperties の構造
クライアント認証情報付与タイプのフローに必要なプロパティを定義する OAuth2 クライアント認証情報設定。
**フィールド**
+ `TokenUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
クライアントがクライアント認証情報を使用してアクセストークンをリクエストする場合のトークンエンドポイント URL。
+ `RequestMethod` – UTF-8 文字列 (有効な値: `GET` \| `POST`)。
トークンリクエストを行うときに使用する HTTP メソッド (通常は POST)。
+ `ContentType` – UTF-8 文字列 (有効な値: `APPLICATION_JSON` \| `URL_ENCODED`)。
トークンリクエストに使用するコンテンツタイプ。application/x-www-form-urlencoded や application/json など。
+ `ClientId` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認可サーバーから提供される OAuth2 クライアントの識別子。
+ `ClientSecret` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認可サーバーから提供される OAuth2 クライアントのシークレット。
+ `Scope` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
クライアント認証情報フローに対してリクエストされるアクセスレベルを定義する OAuth2 スコープ。
+ `TokenUrlParameters` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクトの配列。
キーと値のペアとしてトークン URL リクエストに含める追加のパラメータ。
## JWTBearerProperties の構造
JWT ベアラー付与タイプフローに必要なプロパティを定義する JWT ベアラートークン設定。
**フィールド**
+ `TokenUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
JWT ベアラートークンがアクセストークンと交換される、トークンエンドポイント URL。
+ `RequestMethod` – UTF-8 文字列 (有効な値: `GET` \| `POST`)。
JWT ベアラートークンリクエストを行うときに使用する HTTP メソッド (通常は POST)。
+ `ContentType` – UTF-8 文字列 (有効な値: `APPLICATION_JSON` \| `URL_ENCODED`)。
JWT ベアラートークンリクエストに使用するコンテンツタイプ。application/x-www-form-urlencoded や application/json など。
+ `JwtToken` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認証用のベアラートークン付与フローで使用される JWT トークン。
+ `TokenUrlParameters` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクトの配列。
キーと値のペアとしてトークン URL リクエストに含める追加のパラメータ。
## ConnectorAuthorizationCodeProperties の構造
認可コード付与タイプのフローに必要なプロパティを定義する、OAuth2 認可コード設定。
**フィールド**
+ `AuthorizationCodeUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認可を付与するユーザーがリダイレクトされる認可エンドポイント URL。
+ `AuthorizationCode` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
ユーザーの同意後に認可サーバーから届いた認可コード。
+ `RedirectUri` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
リダイレクト URI。認可サーバーに登録されている URI と一致する必要があります。
+ `TokenUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認可コードがアクセストークンと交換される、トークンエンドポイント URL。
+ `RequestMethod` – UTF-8 文字列 (有効な値: `GET` \| `POST`)。
トークン交換リクエストを行うときに使用する HTTP メソッド (通常は POST)。
+ `ContentType` – UTF-8 文字列 (有効な値: `APPLICATION_JSON` \| `URL_ENCODED`)。
トークン交換に使用するコンテンツタイプ。application/x-www-form-urlencoded や application/json など。
+ `ClientId` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認可サーバーから提供される OAuth2 クライアントの識別子。
+ `ClientSecret` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認可サーバーから提供される OAuth2 クライアントのシークレット。
+ `Scope` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
認可コードフローに対してリクエストされるアクセスレベルを定義する OAuth2 スコープ。
+ `Prompt` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
ユーザー認証中の認可サーバーの動作を制御する、OAuth2 プロンプトパラメータ。
+ `TokenUrlParameters` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクトの配列。
キーと値のペアとしてトークン URL リクエストに含める追加のパラメータ。
## BasicAuthenticationProperties の構造
HTTP 基本認証のユーザー名とパスワードプロパティを定義する Basic 認証の認証情報。
**フィールド**
+ `Username` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
Basic 認証の認証情報に使用するユーザー名プロパティ名。
+ `Password` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクト。
Basic 認証の認証情報に使用するパスワードプロパティ名。
## CustomAuthenticationProperties の構造
標準の Basic フローと OAuth2 フロー以外でも認証メカニズムを柔軟に行うことができるカスタム認証の設定。
**フィールド**
+ `AuthenticationParameters` – *必須:* [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) オブジェクトの配列。
特定の認証メカニズムとそれに必要なプロパティを定義する、カスタム認証パラメータのマップ。
## FilterConfiguration の構造
REST API リクエストにフィルター述語を適用するための方法を定義する設定。クエリパラメータとフィルター文字列戦略の両方をサポート。
**フィールド**
+ `FilterMode` – *必須:* UTF-8 文字列 (有効な値: `QUERY_PARAMS` \| `FILTER_STRING`)。
フィルターをリクエストに適用するための戦略。`QUERY_PARAMS` を使用して各フィルターを個別のクエリパラメータとして渡すか、`FILTER_STRING` を使用して 1 個のフィルター式の文字列を作成します。
+ `OperatorMappings` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列。
各値は UTF-8 文字列。
論理フィルター演算子の、それに対応した API 固有の文字列表現へのマップ。サポートされている演算子キーは、`EQUAL_TO`、`NOT_EQUAL_TO`、`LESS_THAN`、`GREATER_THAN`、`LESS_THAN_OR_EQUAL_TO`、`GREATER_THAN_OR_EQUAL_TO`、`CONTAINS`、`BETWEEN`、`AND`、`OR`。
+ `DateTimeFormat` – UTF–8 文字列。
フィルター式のグローバルな日付と時刻の形式。Java `DateTimeFormatter` パターン (例: `EEE, d MMM yyyy HH:mm:ss Z`)、Unix エポック秒の場合は `EPOCH_SECONDS`、Unix エポックミリ秒の場合は `EPOCH_MILLIS` を使用できます。指定しない場合、値は ISO-8601 形式のまま渡されます。
+ `StripQuotes` – ブール。
処理前に、フィルター値から二重引用符を削除するかどうかを示します。
+ `BetweenConfiguration` – [BetweenConfiguration](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration) オブジェクト。
BETWEEN 範囲フィルターオペレーションの処理方法の設定。
+ `FilterStringConfiguration` – [FilterStringConfiguration](#aws-glue-api-catalog-connections-connections-type-FilterStringConfiguration) オブジェクト。
`FilterMode` が `FILTER_STRING` に設定されている場合の、フィルター式の構築方法の設定。
## FilterOverrides の構造
フィルター動作のオーバーライドをフィールドごとに定義する設定。フィルターオペレーションの適用方法をフィールドごとにカスタマイズできます。
**フィールド**
+ `FieldName` – UTF-8 文字列。
フィルター式で使用するフィールド名がスキーマフィールド名と異なる場合のオーバーライド。
+ `OperatorMappings` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列。
各値は UTF-8 文字列。
論理フィルター演算子と、それに対応するフィールド固有の API 表現とのマップ。グローバル演算子マッピングをオーバーライトします。サポートされている演算子キーは、`EQUAL_TO`、`NOT_EQUAL_TO`、`LESS_THAN`、`GREATER_THAN`、`LESS_THAN_OR_EQUAL_TO`、`GREATER_THAN_OR_EQUAL_TO`、`CONTAINS`、`BETWEEN`、`AND`、`OR`。
+ `BetweenConfiguration` – [BetweenConfiguration](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration) オブジェクト。
BETWEEN 範囲フィルターオペレーションの、フィールドに固有の設定。
+ `DateTimeFormat` – UTF–8 文字列。
このフィールドのフィルター式の日付と時刻の形式。グローバル `DateTimeFormat` をオーバーライトします。Java `DateTimeFormatter` パターン (例: `EEE, d MMM yyyy HH:mm:ss Z`)、Unix エポック秒の場合は `EPOCH_SECONDS`、Unix エポックミリ秒の場合は `EPOCH_MILLIS` を使用できます。
## BetweenConfiguration の構造
BETWEEN 範囲フィルターオペレーションを REST API リクエストパラメータに変換する方法を定義する設定。
**フィールド**
+ `LowBoundKey` – UTF-8 文字列。
BETWEEN フィルターオペレーションの下限値に使用されるパラメータの名前。
+ `HighBoundKey` – UTF–8 文字列。
BETWEEN フィルターオペレーションの上限値に使用されるパラメータの名前。
+ `Template` – UTF–8 文字列。
BETWEEN フィルター式を構築するためのテンプレート文字列。
## FilterStringConfiguration の構造
`FILTER_STRING` フィルターモードを使用する場合にフィルター式文字列を作成するための設定。
**フィールド**
+ `QueryParameterName` – *必須:* UTF–8 文字列。
API リクエストで構築されたフィルター式文字列を送信するときに使用されるクエリパラメータ名。
+ `QuoteStringValues` – ブール。
文字列値と日付値をフィルター式で引用符を使って囲むかどうかを示します。
+ `QuoteCharacter` – UTF–8 文字列。
`QuoteStringValues` が true のとき、値を引用符で囲むために使用される文字。指定しない場合のデフォルト値は二重引用符です。