接続タイプ API

• RegisterConnectionType アクション (Python: register_connection_type)

• DeleteConnectionType アクション (Python: delete_connection_type)

• DescribeConnectionType アクション (Python: describe_connection_type)

• ListConnectionTypes アクション (Python: list_connection_types)

• ConnectionTypeBrief 構造

• ConnectionTypeVariant の構造

リクエスト

• ConnectionType – 必須: UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

  接続タイプの名前。字数は 1～255 字以内で、REST ベースの connector であることを示すためプレフィックス「REST-」を付けます。

• IntegrationType – 必須: UTF-8 文字列 (有効な値: REST)。

  接続の統合タイプ。現在は "REST" プロトコルのみがサポートされています。

• Description – UTF-8 文字列、1024 バイト長以下。

  接続タイプの説明。2048 文字以内で、接続タイプの目的と機能の詳細を記します。

• ConnectionProperties – 必須: ConnectionPropertiesConfiguration オブジェクト。

  この接続タイプの接続作成中に必要となる、ベース URL と追加のリクエストパラメータを定義します。

• ConnectorAuthenticationConfiguration – 必須: ConnectorAuthenticationConfiguration オブジェクト。

  この接続タイプでサポートされている認証タイプと必要なプロパティを定義します (Basic、OAuth2、Custom 認証方法など)。

• RestConfiguration – 必須: RestConfiguration オブジェクト。

  REST API インタラクション向けの HTTP リクエストとレスポンスの設定、検証エンドポイント、エンティティの設定を定義します。

• Tags – キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、256 バイト長以下です。

  接続タイプに割り当てるタグです。

応答

新しく登録された接続タイプの Amazon リソースネーム (ARN) が含まれています。

• ConnectionTypeArn – UTF-8 文字列。1～10240 バイト長。Custom string pattern #47 に一致。

  登録済みの接続タイプの Amazon リソースネーム (ARN) が含まれています。この一意の識別子は、他の AWS Glue オペレーションで接続タイプを参照するときに使用できます。

エラー

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InternalServiceException

リクエスト

• ConnectionType – 必須: UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

  削除する接続タイプの名前。既存の登録済み接続タイプを参照する必要があります。

応答

• 応答パラメータはありません。

エラー

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• AccessDeniedException

リクエスト

• ConnectionType – 必須: UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

  説明する接続タイプの名前。

応答

• ConnectionType – UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。

  接続タイプの名前。

• Description – UTF-8 文字列、1024 バイト長以下。

  接続タイプの説明。

• Capabilities – 機能 オブジェクト。

  サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、および connector のデータオペレーション。

• ConnectionProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  コンピューティング環境間で共通の接続プロパティ。

• ConnectionOptions – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  ConnectionInput.ConnectionProperties で接続を作成するときに設定できるプロパティを返します。ConnectionOptions は、データフレームに渡される接続オプションマップの Spark ETL スクリプトで設定できるパラメータを定義します。

• AuthenticationConfiguration – AuthConfiguration オブジェクト。

  接続に使用する認証のタイプ。

• ComputeEnvironmentConfigurations – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A ComputeEnvironmentConfiguration オブジェクトです。

  接続でサポートされているコンピューティング環境。

• PhysicalConnectionRequirements – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  接続の物理的な要件 (VPC、サブネット、セキュリティグループの仕様など)。

• AthenaConnectionProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  Athena コンピューティング環境に固有の接続プロパティ。

• PythonConnectionProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  Python コンピューティング環境に固有の接続プロパティ。

• SparkConnectionProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  Spark コンピューティング環境に固有の接続プロパティ。

• RestConfiguration – RestConfiguration オブジェクト。

  REST ベースのデータソース向けの HTTP リクエストとレスポンスの設定、検証エンドポイント、エンティティの設定。

エラー

• ValidationException

• InvalidInputException

• InternalServiceException

リクエスト

• MaxResults – 1～1000 の数値 (整数)。

  返される結果の最大数。

• NextToken – UTF-8 文字列。1 ～ 2,048 バイト長。Custom string pattern #11 に一致。

  継続トークン (これが継続呼び出しの場合)。

応答

• ConnectionTypes – ConnectionTypeBrief オブジェクトの配列。

  サポートされている接続タイプに関する簡単な情報を含む ConnectionTypeBrief オブジェクトのリスト。

• NextToken – UTF-8 文字列。1 ～ 2,048 バイト長。Custom string pattern #11 に一致。

  継続トークン (現在のリストが最後ではない場合に表示されます)。

エラー

• InternalServiceException

フィールド

• 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 – 機能 オブジェクト。

  サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、および connector のデータオペレーション。

• LogoUrl – UTF–8 文字列。

  接続タイプに関連付けられたロゴの URL。

• ConnectionTypeVariants – ConnectionTypeVariant オブジェクトの配列。

  この接続タイプで利用可能なバリアントのリスト。さまざまなバリアントは、同じ一般的な接続タイプの特定ユースケースや実装に特殊な設定を提供する場合があります。

フィールド

• ConnectionTypeVariantName – UTF-8 文字列、1～128 バイト長。

  接続タイプバリアントの一意の識別子。この名前は、接続タイプの特定バリアントを識別するために内部で使用されます。

• DisplayName – UTF-8 文字列、1～128 バイト長。

  AWS Glue コンソールに表示される接続タイプバリアントにおいて、人間が読み取れる名前。

• Description – UTF-8 文字列、1024 バイト長以下。

  目的、ユースケース、特定の設定要件など、接続タイプバリアントの詳細な説明。

• LogoUrl – UTF–8 文字列。

  接続タイプバリアントに関連付けられたロゴの URL。

• 検証構造

• AuthConfiguration 構造

• Capabilities 構造

• Property 構造

• AllowedValue 構造

• ComputeEnvironmentConfiguration 構造

フィールド

• ValidationType – 必須: UTF-8 文字列 (有効な値: REGEX | RANGE)。

  実行する検証のタイプ (REGEX など)。

• Patterns – UTF-8 文字列の配列。

  検証に適用されるパターンのリスト。

• Description – 必須: UTF-8 文字列、1～1024 バイト長。

  検証の説明。

• MaxLength – 数値 (整数)。

  文字列接続プロパティの最大長。

• Maximum – 数値 (整数)。

  検証の RANGE タイプを指定するときの最大値。

• Minimum – 数値 (整数)。

  検証の RANGE タイプを指定するときの最小値。

フィールド

• AuthenticationType – 必須: プロパティ オブジェクト。

  接続の認証のタイプ。

• SecretArn – プロパティ オブジェクト。

  Secrets Manager の Amazon リソースネーム (ARN)。

• OAuth2Properties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  OAuth2 プロパティのキーと値のペアのマップ。各値は A Property オブジェクトです。

• BasicAuthenticationProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  OAuth2 プロパティのキーと値のペアのマップ。各値は A Property オブジェクトです。

• CustomAuthenticationProperties – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は A プロパティ オブジェクトです。

  カスタム認証プロパティのキーと値のペアのマップ。各値は A Property オブジェクトです。

フィールド

• SupportedAuthenticationTypes – 必須: UTF-8 文字列の配列。

  サポートされている認証タイプのリスト。

• SupportedDataOperations – 必須: UTF-8 文字列の配列。

  サポートされているデータオペレーションのリスト。

• SupportedComputeEnvironments – 必須: UTF-8 文字列の配列。

  サポートされているコンピューティング環境のリスト。

フィールド

• Name – 必須: UTF-8 文字列。1～128 バイト長。

  プロパティの名前。

• Description – 必須: UTF-8 文字列。1024 以下のバイト長。

  プロパティの説明。

• Required – 必須: ブール。

  プロパティが必須かどうかを示します。

• DefaultValue – UTF–8 文字列。

  プロパティのデフォルト値。

• PropertyTypes – 必須: UTF-8 文字列の配列。

  プロパティのタイプを説明します。

• AllowedValues – allowedValues オブジェクトの配列。

  プロパティに許可される値を表す AllowedValue オブジェクトのリスト。

• DataOperationScopes – UTF-8 文字列の配列。

  どのデータオペレーションをプロパティに適用できるかを示します。

• KeyOverride – UTF–8 文字列。

  表示名と異なる場合に、API リクエストでこのプロパティを送信するときに使用するキー名。

• PropertyLocation – UTF-8 文字列 (有効な値: HEADER | BODY | QUERY_PARAM | PATH)。

  ヘッダー、クエリパラメータ、リクエスト本文など、このプロパティを REST リクエストのどこに含めるかを指定します。

フィールド

• Description – UTF-8 文字列、1024 バイト長以下。

  許可される値の説明。

• Value – 必須: UTF-8 文字列。1～128 バイト長。

  プロパティに許可される値。

フィールド

• 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 プロパティ オブジェクトです。

  コンピューティング環境の接続オプションとして使用されるパラメータ。

• ConnectionPropertyNameOverrides – 必須: キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、1～128 バイト長です。

  接続プロパティ名はコンピューティング環境に対して上書きされます。

• ConnectionOptionNameOverrides – 必須: キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1～128 バイト長です。

  各値は UTF-8 文字列で、1～128 バイト長です。

  接続オプション名はコンピューティング環境に対して上書きされます。

• ConnectionPropertiesRequiredOverrides – 必須: UTF-8 文字列の配列。

  コンピューティング環境の上書きとして必要な接続プロパティ。

• PhysicalConnectionPropertiesRequired – ブール。

  コンピューティング環境に PhysicalConnectionProperties が必要かどうかを示します。

• ConnectionPropertiesConfiguration の構造

• ConnectorAuthenticationConfiguration の構造

• ConnectorProperty の構造

• RestConfiguration の構造

• SourceConfiguration の構造

• EntityConfiguration の構造

• ResponseConfiguration の構造

• ResponseExtractionMapping の構造

• PaginationConfiguration の構造

• CursorConfiguration の構造

• OffsetConfiguration の構造

• ExtractedParameter の構造

• FieldDefinition の構造

• ConnectorOAuth2Properties の構造

• ClientCredentialsProperties の構造

• JWTBearerProperties の構造

• ConnectorAuthorizationCodeProperties の構造

• BasicAuthenticationProperties の構造

• CustomAuthenticationProperties の構造

• FilterConfiguration の構造

• FilterOverrides の構造

• BetweenConfiguration の構造

• FilterStringConfiguration の構造

フィールド

• Url – ConnectorProperty オブジェクト。

  この接続タイプの接続先となるエンドポイントのベースインスタンス URL。

• AdditionalRequestParameters – ConnectorProperty オブジェクトの配列。

  API のバージョンやサービス固有の設定オプションなど、接続の作成時に必要となる可能性のある追加のリクエストパラメータのキーと値のペア。

フィールド

• AuthenticationTypes – 必須: UTF-8 文字列の配列。

  この接続タイプでサポートされている認証タイプのリスト (Basic、OAuth2、Custom 認証方法など)。

フィールド

• Name – 必須: UTF-8 文字列。1～128 バイト長。

  プロパティの名前。

• KeyOverride – UTF-8 文字列。1～128 バイト長。Custom string pattern #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})。

フィールド

• GlobalSourceConfiguration – SourceConfiguration オブジェクト。

  この接続タイプのすべての REST API リクエストに適用されるグローバル設定 (一般的なリクエストメソッド、パス、パラメータなど)。

• ValidationEndpointConfiguration – SourceConfiguration オブジェクト。

  接続の作成時に接続認証情報の検証と接続のテストに使用される、エンドポイントの設定。

• EntityConfigurations – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列、1～128 バイト長で、Custom string pattern #12 に一致します。

  各値は A EntityConfiguration オブジェクトです。

  スキーマやアクセスパターンなど、REST API を介して使用できるさまざまなデータエンティティを操作する方法を定義する、エンティティ設定のマップ。

フィールド

• RequestMethod – UTF-8 文字列 (有効な値: GET | POST)。

  このエンドポイントへのリクエストに使用する HTTP メソッド (GET、POST など)。

• RequestPath – UTF-8 文字列。1～512 バイト長。Custom string pattern #14 に一致。

  REST エンドポイントの URL パス。リクエスト中に実際の値に置き換えられるパラメータプレースホルダーが含まれる場合があります。

• RequestParameters – ConnectorProperty オブジェクトの配列。

  クエリパラメータ、ヘッダー、本文のコンテンツなど、API コールに含める必要があるリクエストパラメータの設定。

• ResponseConfiguration – ResponseConfiguration オブジェクト。

  成功および失敗の処理など、API レスポンスからデータを解析して抽出する方法を定義する設定。

• PaginationConfiguration – PaginationConfiguration オブジェクト。

  REST API から送られるページ分割されたレスポンスを処理するための設定。カーソルベースとオフセットベース両方のページ分割戦略をサポートしています。

• FilterConfiguration – FilterConfiguration オブジェクト。

  REST API リクエストにフィルタープッシュダウンを適用し、フィルター述語をクエリパラメータまたはフィルター文字列に変換する方法を定義する設定。

フィールド

• SourceConfiguration – SourceConfiguration オブジェクト。

  REST API を使用してこのエンティティのデータにアクセスするための、リクエスト方法を定義するソース設定。

• Schema – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列 (1 バイト長以上) です。

  各値は A fieldDefinition オブジェクトです。

  フィールド名、タイプ、データ構造を記述するその他メタデータなど、このエンティティのスキーマ定義です。

フィールド

• ResultPath – 必須:UTF-8 文字列。1～512 バイト長。Custom string pattern #10 に一致。

  API レスポンス内の実際の結果データの場所を特定する JSON パス式。

• ErrorPath – UTF-8 文字列。1～512 バイト長。Custom string pattern #10 に一致。

  リクエストが失敗したときに API レスポンス内のエラー情報の場所を特定する JSON パス式。

フィールド

• ContentPath – UTF-8 文字列。1 ～ 512 バイト長。Custom string pattern #10 に一致。

  レスポンスの本文から値を抽出する方法を指定する JSON パス式。

• HeaderKey – UTF-8 文字列。1～128 バイト長。Custom string pattern #15 に一致。

  値の抽出元となる HTTP レスポンスのヘッダー名。

フィールド

• CursorConfiguration – CursorConfiguration オブジェクト。

  カーソルベースのページ分割の設定。API はここに結果の次のページを取得するためのカーソルまたはトークンを記載します。

• OffsetConfiguration – OffsetConfiguration オブジェクト。

  オフセットベースのページ分割の設定。API はここで数値オフセットと制限を使用して、返される結果を制御します。

フィールド

• NextPage – 必須: ExtractedParameter オブジェクト。

  結果の次のページを取得するためのカーソルまたはトークンを含む、パラメータ名または JSON パス。

• LimitParameter – ExtractedParameter オブジェクト。

  返す結果の、1 ページあたりの最大数を指定する際に使用するパラメータの名前。

フィールド

• OffsetParameter – 必須: ExtractedParameter オブジェクト。

  結果を取得するための開始位置またはオフセットを指定する際に使用するパラメータの名前。

• LimitParameter – 必須: ExtractedParameter オブジェクト。

  返す結果の、1 ページあたりの最大数を指定する際に使用するパラメータの名前。

フィールド

• Key – UTF-8 文字列。1～128 バイト長。Custom string pattern #15 に一致。

  後続のリクエストで使用されるパラメータキーの名前。

• DefaultValue – UTF-8 文字列。1～1,024 バイト長。Custom string pattern #16 に一致。

  パラメータをレスポンスから抽出できない場合に使用するデフォルト値。

• PropertyLocation – UTF-8 文字列 (有効な値: HEADER | BODY | QUERY_PARAM | PATH)。

  ヘッダー、クエリパラメータ、リクエスト本文など、抽出されたパラメータを後続のリクエストに配置する場所を指定します。

• Value – ResponseExtractionMapping オブジェクト。

  API レスポンスからパラメータ値を抽出する方法を定義する JSON パスまたは抽出マッピング。

フィールド

• 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 オブジェクト。

  フィルター動作をフィールドごとにオーバーライドします。フィルターを特定のフィールドに適用する方法をカスタマイズできます。

フィールド

• OAuth2GrantType – 必須: UTF-8 文字列 (有効な値: CLIENT_CREDENTIALS | JWT_BEARER | AUTHORIZATION_CODE)。

  認証に使用する OAuth2 の許可タイプ。CLIENT_CREDENTIALS、JWT_BEARER、AUTHORIZATION_CODE など。

• ClientCredentialsProperties – ClientCredentialsProperties オブジェクト。

  OAuth2 クライアント認証情報の付与タイプのフローに固有の設定プロパティ。

• JWTBearerProperties – JWTBearerProperties オブジェクト。

  OAuth2 JWT ベアラー付与タイプのフローに固有の設定プロパティ。

• AuthorizationCodeProperties – ConnectorAuthorizationCodeProperties オブジェクト。

  OAuth2 J 認可コードの付与タイプのフローに固有の設定プロパティ。

フィールド

• TokenUrl – 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 オブジェクト。

  認可サーバーから提供される OAuth2 クライアントの識別子。

• ClientSecret – ConnectorProperty オブジェクト。

  認可サーバーから提供される OAuth2 クライアントのシークレット。

• Scope – ConnectorProperty オブジェクト。

  クライアント認証情報フローに対してリクエストされるアクセスレベルを定義する OAuth2 スコープ。

• TokenUrlParameters – ConnectorProperty オブジェクトの配列。

  キーと値のペアとしてトークン URL リクエストに含める追加のパラメータ。

フィールド

• TokenUrl – 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 オブジェクト。

  認証用のベアラートークン付与フローで使用される JWT トークン。

• TokenUrlParameters – ConnectorProperty オブジェクトの配列。

  キーと値のペアとしてトークン URL リクエストに含める追加のパラメータ。

フィールド

• AuthorizationCodeUrl – ConnectorProperty オブジェクト。

  認可を付与するユーザーがリダイレクトされる認可エンドポイント URL。

• AuthorizationCode – ConnectorProperty オブジェクト。

  ユーザーの同意後に認可サーバーから届いた認可コード。

• RedirectUri – ConnectorProperty オブジェクト。

  リダイレクト URI。認可サーバーに登録されている URI と一致する必要があります。

• TokenUrl – 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 オブジェクト。

  認可サーバーから提供される OAuth2 クライアントの識別子。

• ClientSecret – ConnectorProperty オブジェクト。

  認可サーバーから提供される OAuth2 クライアントのシークレット。

• Scope – ConnectorProperty オブジェクト。

  認可コードフローに対してリクエストされるアクセスレベルを定義する OAuth2 スコープ。

• Prompt – ConnectorProperty オブジェクト。

  ユーザー認証中の認可サーバーの動作を制御する、OAuth2 プロンプトパラメータ。

• TokenUrlParameters – ConnectorProperty オブジェクトの配列。

  キーと値のペアとしてトークン URL リクエストに含める追加のパラメータ。

フィールド

• Username – ConnectorProperty オブジェクト。

  Basic 認証の認証情報に使用するユーザー名プロパティ名。

• Password – ConnectorProperty オブジェクト。

  Basic 認証の認証情報に使用するパスワードプロパティ名。

フィールド

• AuthenticationParameters – 必須: ConnectorProperty オブジェクトの配列。

  特定の認証メカニズムとそれに必要なプロパティを定義する、カスタム認証パラメータのマップ。

フィールド

• 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 オブジェクト。

  BETWEEN 範囲フィルターオペレーションの処理方法の設定。

• FilterStringConfiguration – FilterStringConfiguration オブジェクト。

  FilterMode が FILTER_STRING に設定されている場合の、フィルター式の構築方法の設定。

フィールド

• 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 オブジェクト。

  BETWEEN 範囲フィルターオペレーションの、フィールドに固有の設定。

• DateTimeFormat – UTF–8 文字列。

  このフィールドのフィルター式の日付と時刻の形式。グローバル DateTimeFormat をオーバーライトします。Java DateTimeFormatter パターン (例: EEE, d MMM yyyy HH:mm:ss Z)、Unix エポック秒の場合は EPOCH_SECONDS、Unix エポックミリ秒の場合は EPOCH_MILLIS を使用できます。

フィールド

• LowBoundKey – UTF-8 文字列。

  BETWEEN フィルターオペレーションの下限値に使用されるパラメータの名前。

• HighBoundKey – UTF–8 文字列。

  BETWEEN フィルターオペレーションの上限値に使用されるパラメータの名前。

• Template – UTF–8 文字列。

  BETWEEN フィルター式を構築するためのテンプレート文字列。

フィールド

• QueryParameterName – 必須: UTF–8 文字列。

  API リクエストで構築されたフィルター式文字列を送信するときに使用されるクエリパラメータ名。

• QuoteStringValues – ブール。

  文字列値と日付値をフィルター式で引用符を使って囲むかどうかを示します。

• QuoteCharacter – UTF–8 文字列。

  QuoteStringValues が true のとき、値を引用符で囲むために使用される文字。指定しない場合のデフォルト値は二重引用符です。