연결 유형 API

• RegisterConnectionType 작업(Python: register_connection_type)

• DeleteConnectionType 작업(Python: delete_connection_type)

• DescribeConnectionType 작업(Python: describe_connection_type)

• ListConnectionTypes 작업(Python: list_connection_types)

• ConnectionTypeBrief 구조

• ConnectionTypeVariant 구조

요청

• ConnectionType – 필수(Required): Single-line string pattern과(와) 일치하는 1~255바이트 길이의 UTF-8 문자열입니다.

  연결 유형의 이름입니다. 길이가 1~255자여야 하며, REST 기반 connector임을 나타내도록 'REST-' 접두사가 붙어야 합니다.

• IntegrationType – 필수: UTF-8 문자열입니다(유효한 값: REST).

  연결의 통합 유형입니다. 현재는 'REST' 프로토콜만 지원됩니다.

• Description – UTF-8 문자열(1,024바이트 이하).

  연결 유형에 대한 설명입니다. 최대 2,048자까지 가능하며 연결 유형의 용도 및 기능에 대한 세부 정보를 제공합니다.

• ConnectionProperties – 필수(Required): ConnectionPropertiesConfiguration 객체입니다.

  이 연결 유형에 대한 연결 생성 중에 필요한 기본 URL 및 추가 요청 파라미터를 정의합니다.

• ConnectorAuthenticationConfiguration – 필수(Required): ConnectorAuthenticationConfiguration 객체입니다.

  기본, OAuth2, 사용자 지정 인증 방법을 포함하여 이 연결 유형에 대해 지원되는 인증 유형 및 필수 속성을 정의합니다.

• RestConfiguration – 필수(Required): RestConfiguration 객체입니다.

  REST API 상호 작용에 대한 HTTP 요청 및 응답 구성, 검증 엔드포인트 및 엔터티 구성을 정의합니다.

• Tags – 50개 이하의 페어로 구성된 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 256 바이트 이하 길이의 UTF-8 문자열입니다.

  연결 유형에 할당하는 태그입니다.

응답

새로 등록된 연결 유형의 Amazon 리소스 이름(ARN)을 포함합니다.

• ConnectionTypeArn – 과(와) 일치하는 1~10,240바이트 길이의 UTF-8 문자열입니다..Custom string pattern #47

  등록된 연결 유형의 Amazon 리소스 이름(ARN)입니다. 이 고유 식별자를 사용하여 다른 AWS Glue 작업의 연결 유형을 참조할 수 있습니다.

오류

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InternalServiceException

요청

• ConnectionType – 필수(Required): Single-line string pattern과(와) 일치하는 1~255바이트 길이의 UTF-8 문자열입니다.

  삭제할 연결 유형의 이름입니다. 기존에 등록된 연결 유형을 참조해야 합니다.

응답

• 무응답 파라미터.

오류

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• AccessDeniedException

요청

• ConnectionType – 필수(Required): Single-line string pattern과(와) 일치하는 1~255바이트 길이의 UTF-8 문자열입니다.

  설명할 연결 유형의 이름입니다.

응답

• ConnectionType – 과(와) 일치하는 1~255바이트 길이의 UTF-8 문자열입니다..Single-line string pattern

  연결 유형의 이름입니다.

• Description – UTF-8 문자열(1,024바이트 이하).

  연결 유형에 대한 설명입니다.

• Capabilities – 기능 객체입니다.

  지원되는 인증 유형, 데이터 인터페이스 유형(컴퓨팅 환경), connector의 데이터 작업입니다.

• ConnectionProperties – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  컴퓨팅 환경 전체에서 공통적인 연결 속성입니다.

• ConnectionOptions – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  ConnectionInput.ConnectionProperties에서 연결을 생성할 때 설정할 수 있는 속성을 반환합니다. ConnectionOptions는 데이터프레임에 전달되는 연결 옵션 맵의 Spark ETL 스크립트에서 설정할 수 있는 파라미터를 정의합니다.

• AuthenticationConfiguration – AuthConfiguration 객체입니다.

  연결에 사용되는 인증의 유형입니다.

• ComputeEnvironmentConfigurations – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 ComputeEnvironmentConfiguration 객체입니다.

  연결에서 지원하는 컴퓨팅 환경입니다.

• PhysicalConnectionRequirements – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  VPC, 서브넷, 보안 그룹 사양 등, 연결에 대한 물리적 요구 사항입니다.

• AthenaConnectionProperties – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  Athena 컴퓨팅 환경과 관련된 연결 속성입니다.

• PythonConnectionProperties – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  Python 컴퓨팅 환경과 관련된 연결 속성입니다.

• SparkConnectionProperties – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  Spark 컴퓨팅 환경과 관련된 연결 속성입니다.

• RestConfiguration – RestConfiguration 객체입니다.

  REST 기반 데이터 소스에 대한 HTTP 요청 및 응답 구성, 검증 엔드포인트 및 엔터티 구성입니다.

오류

• ValidationException

• InvalidInputException

• InternalServiceException

요청

• MaxResults – 1~1,000의 숫자(정수)입니다.

  반환할 최대 결과 수입니다.

• NextToken – 과(와) 일치하는 1~2,048바이트 길이의 UTF-8 문자열입니다..Custom string pattern #11

  이것이 지속적으로 호출되면 지속적인 토큰입니다.

응답

• ConnectionTypes – ConnectionTypeBrief 객체의 배열입니다.

  지원되는 연결 유형에 대한 간략한 정보가 포함된 ConnectionTypeBrief 객체의 목록입니다.

• NextToken – 과(와) 일치하는 1~2,048바이트 길이의 UTF-8 문자열입니다..Custom string pattern #11

  현재 list 세그먼트가 마지막이 아닌 경우의 연속 토큰입니다.

오류

• InternalServiceException

Fields

• 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 – 1~128바이트 길이의 UTF-8 문자열입니다.

  AWS Glue 콘솔에 표시되는 연결 유형의 이름이며 인간이 읽을 수 있는 이름입니다.

• Vendor – 1~128바이트 길이의 UTF-8 문자열입니다.

  이 연결 유형을 생성 또는 유지 관리하는 공급업체 또는 공급자의 이름입니다.

• Description – UTF-8 문자열(1,024바이트 이하).

  연결 유형에 대한 설명입니다.

• Categories – UTF-8 문자열의 배열입니다.

  이 연결 유형이 속한 범주 목록입니다. 범주는 사용자가 사용 사례에 기반하여 적절한 연결 유형을 필터링하고 찾는 데 도움이 됩니다.

• Capabilities – 기능 객체입니다.

  지원되는 인증 유형, 데이터 인터페이스 유형(컴퓨팅 환경), connector의 데이터 작업입니다.

• LogoUrl – UTF-8 문자열입니다.

  연결 유형과 연결된 로고의 URL입니다.

• ConnectionTypeVariants – ConnectionTypeVariant 객체의 배열입니다.

  이 연결 유형에 사용할 수 있는 변형 목록입니다. 각 변형은 동일한 일반 연결 유형의 특정 사용 사례 또는 구현에 대한 특별 구성을 제공할 수 있습니다.

Fields

• ConnectionTypeVariantName – 1~128바이트 길이의 UTF-8 문자열입니다.

  연결 유형 변형의 고유 식별자입니다. 이 이름은 내부적으로 연결 유형의 특정 변형을 식별하는 데 사용됩니다.

• DisplayName – 1~128바이트 길이의 UTF-8 문자열입니다.

  AWS Glue 콘솔에 표시되는 연결 유형 변형의 이름이며 인간이 읽을 수 있는 이름입니다.

• Description – UTF-8 문자열(1,024바이트 이하).

  용도, 사용 사례 및 특정 구성 요구 사항 등 연결 유형 변형에 대한 자세한 설명입니다.

• LogoUrl – UTF-8 문자열입니다.

  연결 유형 변형과 연결된 로고의 URL입니다.

• Validation 구조

• AuthConfiguration 구조

• Capabilities 구조

• Property 구조

• AllowedValue 구조

• ComputeEnvironmentConfiguration 구조

Fields

• ValidationType – 필수: UTF-8 문자열입니다(유효한 값: REGEX | RANGE).

  수행할 검증 유형(예: REGEX)입니다.

• Patterns – UTF-8 문자열의 배열입니다.

  검증에 적용되는 패턴의 목록입니다.

• Description – 필수: 1~1,024바이트 길이의 UTF-8 문자열입니다.

  검증에 대한 설명입니다.

• MaxLength - 숫자(정수)입니다.

  문자열 연결 속성의 최대 길이입니다.

• Maximum - 숫자(정수)입니다.

  검증의 RANGE 유형을 지정할 때의 최댓값입니다.

• Minimum - 숫자(정수)입니다.

  검증의 RANGE 유형을 지정할 때의 최솟값입니다.

Fields

• AuthenticationType – 필수: 속성 객체입니다.

  연결의 인증 유형입니다.

• SecretArn – 속성 객체입니다.

  Secrets Manager의 Amazon 리소스 이름(ARN)입니다.

• OAuth2Properties – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  OAuth2 속성의 키-값 페어 맵입니다. 각 값은 Property 객체입니다.

• BasicAuthenticationProperties – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  OAuth2 속성의 키-값 페어 맵입니다. 각 값은 Property 객체입니다.

• CustomAuthenticationProperties – 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  사용자 지정 인증 속성의 키-값 페어 맵입니다. 각 값은 Property 객체입니다.

Fields

• SupportedAuthenticationTypes – 필수: UTF-8 문자열의 배열입니다.

  지원되는 인증 유형의 목록입니다.

• SupportedDataOperations – 필수: UTF-8 문자열의 배열입니다.

  지원되는 데이터 작업의 목록입니다.

• SupportedComputeEnvironments – 필수: UTF-8 문자열의 배열입니다.

  지원되는 컴퓨팅 환경의 목록입니다.

Fields

• Name – 필수: 1~128바이트 길이의 UTF-8 문자열입니다.

  속성의 이름입니다.

• Description – 필수: UTF-8 문자열입니다(1,024바이트 이하).

  속성에 대한 설명입니다.

• Required – 필수(Required): 부울.

  속성이 필요한지 여부를 나타냅니다.

• DefaultValue – UTF-8 문자열입니다.

  속성의 기본값입니다.

• PropertyTypes – 필수: UTF-8 문자열의 배열입니다.

  속성의 유형을 설명합니다.

• AllowedValues – AllowedValue 객체의 배열입니다.

  속성에 허용되는 값을 나타내는 AllowedValue 객체의 목록입니다.

• DataOperationScopes – UTF-8 문자열의 배열입니다.

  속성에 적용할 수 있는 데이터 작업을 나타냅니다.

• KeyOverride – UTF-8 문자열입니다.

  표시 이름과 다른 경우 API 요청에서 이 속성을 전송할 때 사용할 키 이름입니다.

• PropertyLocation – UTF-8 문자열입니다(유효한 값: HEADER | BODY | QUERY_PARAM | PATH).

  헤더, 쿼리 파라미터 또는 요청 본문과 같은 REST 요청에 이 속성을 포함할 위치를 지정합니다.

Fields

• Description – UTF-8 문자열(1,024바이트 이하).

  허용되는 값에 대한 설명입니다.

• Value – 필수: 1~128바이트 길이의 UTF-8 문자열입니다.

  속성에 허용되는 값입니다.

Fields

• Name – 필수: 1~128바이트 길이의 UTF-8 문자열입니다.

  컴퓨팅 환경 구성의 이름입니다.

• Description – 필수: UTF-8 문자열입니다(1,024바이트 이하).

  컴퓨팅 환경에 대한 설명입니다.

• ComputeEnvironment – 필수: UTF-8 문자열입니다(유효한 값: SPARK | ATHENA | PYTHON).

  컴퓨팅 환경의 유형입니다.

• SupportedAuthenticationTypes – 필수: UTF-8 문자열의 배열입니다.

  컴퓨팅 환경에 지원되는 인증 유형입니다.

• ConnectionOptions – 필수(Required): 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 속성 객체입니다.

  컴퓨팅 환경의 연결 옵션으로 사용되는 파라미터입니다.

• ConnectionPropertyNameOverrides – 필수(Required): 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 길이가 1~128바이트인 UTF-8 문자열입니다.

  연결 속성 이름은 컴퓨팅 환경에 대해 재정의됩니다.

• ConnectionOptionNameOverrides – 필수(Required): 키-값 페어의 맵 배열입니다.

  각 키는 길이가 1~128바이트인 UTF-8 문자열입니다.

  각 값은 길이가 1~128바이트인 UTF-8 문자열입니다.

  연결 옵션 이름은 컴퓨팅 환경에 대해 재정의됩니다.

• 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 구조

Fields

• Url – ConnectorProperty 객체입니다.

  이 연결 유형이 연결할 엔드포인트의 기본 인스턴스 URL입니다.

• AdditionalRequestParameters – ConnectorProperty 객체의 배열입니다.

  API 버전 또는 서비스별 구성 옵션과 같이 연결 생성 중에 필요할 수 있는 추가 요청 파라미터의 키-값 페어입니다.

Fields

• AuthenticationTypes – 필수: UTF-8 문자열의 배열입니다.

  기본, OAuth2 또는 사용자 지정 인증 방법과 같이 이 연결 유형에서 지원하는 인증 유형의 목록입니다.

Fields

• Name – 필수: 1~128바이트 길이의 UTF-8 문자열입니다.

  속성의 이름입니다.

• KeyOverride – 과(와) 일치하는 1~128바이트 길이의 UTF-8 문자열입니다..Custom string pattern #15

  표시 이름과 다른 경우 API 요청에서 이 속성을 전송할 때 사용할 키 이름입니다.

• Required – 필수(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}).

Fields

• GlobalSourceConfiguration – SourceConfiguration 객체입니다.

  일반적인 요청 방법, 경로, 파라미터를 포함하여 이 연결 유형에 대한 모든 REST API 요청에 적용되는 전역 구성 설정입니다.

• ValidationEndpointConfiguration – SourceConfiguration 객체입니다.

  연결 생성 중에 연결 자격 증명을 검증하고 연결을 테스트하는 데 사용되는 엔드포인트에 대한 구성입니다.

• EntityConfigurations – 키-값 페어의 맵 배열입니다.

  각 키는 Custom string pattern #12과(와) 일치하는 1~128바이트 길이의 UTF-8 문자열입니다.

  각 값은 EntityConfiguration 객체입니다.

  스키마 및 액세스 패턴을 포함하여 REST API를 통해 사용할 수 있는 다양한 데이터 엔터티와 상호 작용하는 방법을 정의하는 엔터티 구성의 맵입니다.

Fields

• RequestMethod – UTF-8 문자열입니다(유효한 값: GET | POST).

  GET, POST와 같이 이 엔드포인트에 대한 요청에 사용할 HTTP 메서드입니다.

• RequestPath – 과(와) 일치하는 1~512바이트 길이의 UTF-8 문자열입니다..Custom string pattern #14

  REST 엔드포인트의 URL 경로입니다. 여기에는 요청 중에 실제 값으로 대체될 파라미터 자리 표시자가 포함될 수 있습니다.

• RequestParameters – ConnectorProperty 객체의 배열입니다.

  쿼리 파라미터, 헤더 또는 본문 내용과 같이 API 직접 호출에 포함되어야 하는 요청 파라미터에 대한 구성입니다.

• ResponseConfiguration – ResponseConfiguration 객체입니다.

  성공 및 오류 처리를 포함하여 API 응답에서 데이터를 구문 분석하고 추출하는 방법을 정의하는 구성입니다.

• PaginationConfiguration – PaginationConfiguration 객체입니다.

  REST API의 페이지 매김된 응답을 처리하기 위한 구성입니다. 커서 기반 및 오프셋 기반 페이지 매김 전략을 모두 지원합니다.

• FilterConfiguration – FilterConfiguration 객체입니다.

  REST API 요청에 필터 푸시다운을 적용하여 필터 조건자를 쿼리 파라미터 또는 필터 문자열로 변환하는 방법을 정의하는 구성입니다.

Fields

• SourceConfiguration – SourceConfiguration 객체입니다.

  REST API를 통해 이 엔터티의 데이터에 액세스하도록 요청하는 방법을 정의하는 소스 구성입니다.

• Schema – 키-값 페어의 맵 배열입니다.

  각 키는 최소 1바이트 길이의 UTF-8 문자열입니다.

  각 값은 FieldDefinition 객체입니다.

  필드 이름, 유형, 데이터 구조를 설명하는 기타 메타데이터를 포함하여 이 엔터티에 대한 스키마 정의입니다.

Fields

• ResultPath – 필수: Custom string pattern #10과(와) 일치하는 1~512바이트 길이의 UTF-8 문자열입니다.

  API 응답 내에서 실제 결과 데이터가 있는 위치를 식별하는 JSON 경로 표현식입니다.

• ErrorPath – 과(와) 일치하는 1~512바이트 길이의 UTF-8 문자열입니다..Custom string pattern #10

  요청이 실패할 때 API 응답 내에서 오류 정보가 있는 위치를 식별하는 JSON 경로 표현식입니다.

Fields

• ContentPath – 과(와) 일치하는 1~512바이트 길이의 UTF-8 문자열입니다..Custom string pattern #10

  응답 본문 내용에서 값을 추출하는 방법을 지정하는 JSON 경로 표현식입니다.

• HeaderKey – 과(와) 일치하는 1~128바이트 길이의 UTF-8 문자열입니다..Custom string pattern #15

  값을 추출할 HTTP 응답 헤더의 이름입니다.

Fields

• CursorConfiguration – CursorConfiguration 객체입니다.

  API가 다음 결과 페이지를 검색하기 위한 커서 또는 토큰을 제공하는 커서 기반 페이지 매김에 대한 구성입니다.

• OffsetConfiguration – OffsetConfiguration 객체입니다.

  API가 숫자 오프셋 및 제한을 사용하여 반환되는 결과를 제어하는 오프셋 기반 페이지 매김에 대한 구성입니다.

Fields

• NextPage – 필수(Required): ExtractedParameter 객체입니다.

  결과의 다음 페이지를 검색하기 위한 커서 또는 토큰이 포함된 파라미터 이름 또는 JSON 경로입니다.

• LimitParameter – ExtractedParameter 객체입니다.

  페이지당 반환할 최대 결과 수를 지정하는 데 사용되는 파라미터 이름입니다.

Fields

• OffsetParameter – 필수(Required): ExtractedParameter 객체입니다.

  결과 검색을 위한 시작 위치 또는 오프셋을 지정하는 데 사용되는 파라미터 이름입니다.

• LimitParameter – 필수(Required): ExtractedParameter 객체입니다.

  페이지당 반환할 최대 결과 수를 지정하는 데 사용되는 파라미터 이름입니다.

Fields

• Key – 과(와) 일치하는 1~128바이트 길이의 UTF-8 문자열입니다..Custom string pattern #15

  후속 요청에 사용할 파라미터 키 이름입니다.

• DefaultValue – 과(와) 일치하는 1~1,024바이트 길이의 UTF-8 문자열입니다..Custom string pattern #16

  응답에서 파라미터를 추출할 수 없는 경우 사용할 기본값입니다.

• PropertyLocation – UTF-8 문자열입니다(유효한 값: HEADER | BODY | QUERY_PARAM | PATH).

  이 추출된 파라미터를 헤더, 쿼리 파라미터 또는 요청 본문과 같은 후속 요청에서 배치할 위치를 지정합니다.

• Value – ResponseExtractionMapping 객체입니다.

  API 응답에서 파라미터 값을 추출하는 방법을 정의하는 JSON 경로 또는 추출 매핑입니다.

Fields

• 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 객체입니다.

  필터 동작에 대한 필드별 재정의로, 이 특정 필드에 필터를 적용하는 방법을 사용자 지정할 수 있습니다.

Fields

• OAuth2GrantType – 필수: UTF-8 문자열입니다(유효한 값: CLIENT_CREDENTIALS | JWT_BEARER | AUTHORIZATION_CODE).

  CLIENT_CREDENTIALS, JWT_BEARER, AUTHORIZATION_CODE와 같이 인증에 사용할 OAuth2 권한 부여 유형입니다.

• ClientCredentialsProperties – ClientCredentialsProperties 객체입니다.

  OAuth2 클라이언트 자격 증명 권한 부여 유형 흐름과 관련된 구성 속성입니다.

• JWTBearerProperties – JWTBearerProperties 객체입니다.

  OAuth2 JWT 보유자 권한 부여 유형 흐름과 관련된 구성 속성입니다.

• AuthorizationCodeProperties – ConnectorAuthorizationCodeProperties 객체입니다.

  OAuth2 권한 부여 코드 권한 부여 유형 흐름과 관련된 구성 속성입니다.

Fields

• 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 요청에 키-값 페어로 포함할 추가 파라미터입니다.

Fields

• 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 요청에 키-값 페어로 포함할 추가 파라미터입니다.

Fields

• 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 요청에 키-값 페어로 포함할 추가 파라미터입니다.

Fields

• Username – ConnectorProperty 객체입니다.

  기본 인증 자격 증명에 사용할 사용자 이름 속성 이름입니다.

• Password – ConnectorProperty 객체입니다.

  기본 인증 자격 증명에 사용할 암호 속성 이름입니다.

Fields

• AuthenticationParameters – 필수(Required): ConnectorProperty 객체의 배열입니다.

  특정 인증 메커니즘 및 필수 속성을 정의하는 사용자 지정 인증 파라미터의 맵입니다.

Fields

• FilterMode – 필수: UTF-8 문자열입니다(유효한 값: QUERY_PARAMS | FILTER_STRING).

  요청에 필터를 적용하기 위한 전략입니다. 필터를 개별 쿼리 파라미터로 전달하려면 QUERY_PARAMS를 사용하고, 단일 필터 표현식 문자열을 구성하려면 FILTER_STRING을 사용합니다.

• 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으로 설정된 경우 필터 표현식을 구성하기 위한 구성입니다.

Fields

• 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를 사용할 수 있습니다.

Fields

• LowBoundKey – UTF-8 문자열입니다.

  BETWEEN 필터 작업의 하한 값에 사용되는 파라미터 이름입니다.

• HighBoundKey – UTF-8 문자열입니다.

  BETWEEN 필터 작업의 상한 값에 사용되는 파라미터 이름입니다.

• Template – UTF-8 문자열입니다.

  BETWEEN 필터 표현식을 구성하기 위한 템플릿 문자열입니다.

Fields

• QueryParameterName – 필수: UTF-8 문자열입니다.

  API 요청에서 구성된 필터 표현식 문자열을 보내는 데 사용되는 쿼리 파라미터 이름입니다.

• QuoteStringValues – 부울입니다.

  필터 표현식에서 문자열 및 날짜 값을 따옴표로 묶어야 하는지 여부를 나타냅니다.

• QuoteCharacter – UTF-8 문자열입니다.

  QuoteStringValues가 true일 때 값을 따옴표로 묶는 데 사용되는 문자입니다. 지정하지 않으면 기본적으로 큰따옴표가 사용됩니다.