연결 유형 API - AWS Glue
 —  연결 관리 API  —DescribeConnectionType(describe_connection_type)ListConnectionTypes(list_connection_types)ConnectionTypeBriefConnectionTypeVariant —  데이터 유형  —검증AuthConfiguration기능속성AllowedValueComputeEnvironmentConfiguration

연결 유형 API

연결 유형 API는 연결 유형 설명과 관련된 AWS Glue API를 설명합니다.

연결 관리 API

DescribeConnectionType 작업(Python: describe_connection_type)

DescribeConnectionType API는 AWS Glue에 지정된 연결 유형에 대해 지원되는 옵션에 대한 전체 세부 정보를 제공합니다.

요청

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

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

응답

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

    연결 유형의 이름입니다.

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

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

  • Capabilities – 기능 객체입니다.

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

  • 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 컴퓨팅 환경과 관련된 연결 속성입니다.

오류

  • ValidationException

  • InvalidInputException

  • InternalServiceException

ListConnectionTypes 작업(Python: list_connection_types)

ListConnectionTypes API는 AWS Glue에서 사용 가능한 연결 유형을 학습하는 검색 메커니즘을 제공합니다. 응답에는 각 연결 유형에 지원되는 항목에 대한 상위 수준 세부 정보가 포함된 연결 유형 목록이 포함되어 있습니다. 나열된 연결 유형은 CreateConnection API의 ConnectionType 값에 지원되는 옵션 세트입니다.

요청

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

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

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

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

응답

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

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

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

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

오류

  • 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 | SLACK | STRIPE | INTERCOM | SNAPCHATADS).

    연결 유형의 이름입니다.

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

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

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

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

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

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

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

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

  • Capabilities – 기능 객체입니다.

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

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

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

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

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

ConnectionTypeVariant 구조

AWS Glue 데이터 카탈로그에서 연결 유형의 변형을 나타냅니다. 연결 유형 변형은 동일한 일반 연결 유형의 다양한 구현을 위한 특정 구성 및 동작을 제공합니다.

필드

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

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

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

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

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

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

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

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

데이터 유형

Validation 구조

연결 속성에서 검증이 수행되는 방법을 정의합니다.

필드

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

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

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

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

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

    검증에 대한 설명입니다.

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

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

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

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

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

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

AuthConfiguration 구조

DescribeConnectionType API에서 반환되는 연결에 대한 인증 구성입니다.

필드

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

Capabilities 구조

DescribeConnectionType API에서 반환하는 지원되는 인증 유형을 지정합니다.

필드

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

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

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

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

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

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

Property 구조

컴퓨팅 환경의 연결 유형을 정의하는 객체입니다.

필드

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

    속성의 이름입니다.

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

    속성에 대한 설명입니다.

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

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

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

    속성의 기본값입니다.

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

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

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

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

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

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

AllowedValue 구조

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

필드

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

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

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

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

ComputeEnvironmentConfiguration 구조

DescribeConnectionType API에서 반환하는 컴퓨팅 환경(예: Spark, Python 또는 Athena)에 대한 구성이 포함되는 객체입니다.

필드

  • 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가 컴퓨팅 환경에 필요한지 여부를 나타냅니다.