Neptune 데이터플레인 통계 및 그래프 요약 API

속성 그래프 통계 작업:

• GetPropertygraphStatistics(동작)

• ManagePropertygraphStatistics(동작)

• DeletePropertygraphStatistics(동작)

• GetPropertygraphSummary(동작)

통계 구조:

• Statistics(구조)

• StatisticsSummary(동작)

• StatisticsSummary(구조)

• RefreshStatisticsIdMap(구조)

• NodeStructure(구조)

• NodeStructure(구조)

• SubjectStructure(구조)

• PropertygraphSummaryValueMap(구조)

• PropertygraphSummary(구조)

GetPropertygraphStatistics(동작)

        이 API의 AWS CLI 이름은 get-propertygraph-statistics입니다.

속성 그래프 통계(Gremlin 및 openCypher)를 가져옵니다.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 neptune-db:GetStatisticsStatus IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

요청

• 요청 파라미터가 없습니다.

응답

• payload – 필수: Statistics 객체입니다.

  속성 그래프 데이터에 대한 통계입니다.

• status - 필수: String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  요청의 HTTP 반환 코드입니다. 요청이 성공하면 코드는 200입니다. 일반적인 오류 목록은 DFE 통계 요청의 일반 오류 코드를 참조하세요.

오류

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

ManagePropertygraphStatistics(동작)

        이 API의 AWS CLI 이름은 manage-propertygraph-statistics입니다.

속성 그래프 통계의 생성 및 사용을 관리합니다.

IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 neptune-db:ManageStatistics IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

요청

• mode(CLI에서:--mode) StatisticsAutoGenerationMode, 유형은 string(UTF-8 인코딩 문자열)입니다.

  통계 생성 모드입니다. 다음 중 하나: DISABLE_AUTOCOMPUTE, ENABLE_AUTOCOMPUTE 또는 REFRESH, DFE 통계 생성을 수동으로 트리거하는 마지막 모드입니다.

응답

• payload – RefreshStatisticsIdMap 객체입니다.

  이 값은 새로 고침 모드에서만 반환됩니다.

• status - 필수: String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  요청의 HTTP 반환 코드입니다. 요청이 성공하면 코드는 200입니다.

오류

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

DeletePropertygraphStatistics(동작)

        이 API의 AWS CLI 이름은 delete-propertygraph-statistics입니다.

Gremlin 및 openCypher(속성 그래프) 통계를 삭제합니다.

IAM 인증이 사용 설정된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 생성하는 IAM 사용자 또는 역할에는 해당 클러스터에서 neptune-db:DeleteStatistics IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

요청

• 요청 파라미터가 없습니다.

응답

• payload – StatisticsSummary 객체입니다.

  삭제 페이로드입니다.

• status - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

  취소 상태입니다.

• statusCode - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

  HTTP 응답 코드: 삭제에 성공한 경우 200, 삭제할 통계가 없는 경우 204입니다.

오류

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

GetPropertygraphSummary(동작)

        이 API의 AWS CLI 이름은 get-propertygraph-summary입니다.

속성 그래프의 그래프 요약을 가져옵니다.

IAM 인증이 활성화된 Neptune 클러스터에서 이 작업을 간접적으로 호출하는 경우 요청을 하는 IAM 사용자 또는 역할에는 해당 클러스터에서 neptune-db:GetGraphSummary IAM 작업을 허용하는 정책이 연결되어 있어야 합니다.

요청

• mode(CLI의 경우: --mode) - GraphSummaryType, 유형은 string(UTF-8 인코딩 문자열)입니다.

  모드에는 두 값 BASIC(기본값)과 및 DETAILED 중 하나를 사용할 수 있습니다.

응답

• payload – PropertygraphSummaryValueMap 객체입니다.

  속성 그래프 요약 응답이 포함된 페이로드입니다.

• statusCode - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

  요청의 HTTP 반환 코드입니다. 요청이 성공하면 코드는 200입니다.

오류

• BadRequestException

• InvalidParameterException

• StatisticsNotAvailableException

• ClientTimeoutException

• AccessDeniedException

• IllegalArgumentException

• TooManyRequestsException

• UnsupportedOperationException

• PreconditionsFailedException

• ReadOnlyViolationException

• ConstraintViolationException

• InvalidArgumentException

• MissingParameterException

통계 구조:

Statistics(구조)

통계 정보가 들어 있습니다. DFE 엔진은 Neptune 그래프의 데이터에 대한 정보를 사용하여 쿼리 실행을 계획할 때 효과적인 절충안을 마련합니다. 이 정보는 쿼리 계획의 지침이 될 수 있는 소위 특성 세트와 조건자 통계를 포함하는 통계의 형태를 취합니다. Neptune DFE에서 사용할 통계 관리를 참조하세요.

필드

• active - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

  DFE 통계 생성이 완전히 활성화되었는지 여부를 나타냅니다.

• autoCompute - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

  자동 통계 생성이 활성화되었는지 여부를 나타냅니다.

• date - SyntheticTimestamp_date_time, 유형은 string(UTF-8 인코딩 문자열)입니다.

  DFE 통계가 가장 최근에 생성된 UTC 시간입니다.

• note - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  통계가 유효하지 않은 경우의 문제에 대한 참고 사항입니다.

• signatureInfo - StatisticsSummary 객체입니다.

  다음을 포함하는 StatisticsSummary 구조입니다.

  • signatureCount – 모든 특성 세트의 총 서명 수입니다.

  • instanceCount – 특성 세트 인스턴스의 총 수입니다.

  • predicateCount – 고유한 조건자의 총 수입니다.

• statisticsId - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  현재 통계 생성 실행의 ID를 보고합니다. 값이 -1이면 통계가 생성되지 않았음을 나타냅니다.

StatisticsSummary(동작)

통계에서 생성된 특성 집합에 대한 정보입니다.

필드

• instanceCount - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

  특성 세트 인스턴스의 총 수입니다.

• predicateCount - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

  고유한 조건자의 총 수입니다.

• signatureCount - Integer이며, 유형은 integer(32비트 부호 있는 정수)입니다.

  모든 특성 세트의 총 서명 수입니다.

StatisticsSummary(구조)

DeleteStatistics를 위한 페이로드입니다.

필드

• active - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

  스택의 현재 상태입니다.

• statisticsId - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  현재 진행 중인 통계 생성 실행의 ID입니다.

RefreshStatisticsIdMap(구조)

REFRESH 모드에 대한 통계입니다.

필드

• statisticsId - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  현재 진행 중인 통계 생성 실행의 ID입니다.

NodeStructure(구조)

노드 구조입니다.

필드

• count - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  이 특정 구조를 가진 노드 수입니다.

• distinctOutgoingEdgeLabels - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  이 특정 구조에 있는 고유한 발신 엣지 레이블의 목록입니다.

• nodeProperties - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  이 특정 구조에 있는 노드 속성 목록입니다.

NodeStructure(구조)

엣지 구조입니다.

필드

• count - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  이 특정 구조를 가진 엣지 수입니다.

• edgeProperties - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  이 특정 구조에 있는 엣지 속성 목록입니다.

SubjectStructure(구조)

주제 구조입니다.

필드

• count - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  이 특정 구조의 발생 횟수입니다.

• predicates - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  이 특정 구조에 있는 조건자 목록입니다.

PropertygraphSummaryValueMap(구조)

속성 그래프 요약 응답을 위한 페이로드입니다.

필드

• graphSummary - PropertygraphSummary 객체입니다.

  그래프 요약입니다.

• lastStatisticsComputationTime - SyntheticTimestamp_date_time, 유형은 string(UTF-8 인코딩 문자열)입니다.

  Neptune이 통계를 마지막으로 계산한 시간의 타임스탬프(ISO 8601 형식)입니다.

• version - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  이 그래프 요약 응답의 버전입니다.

PropertygraphSummary(구조)

그래프 요약 API는 노드, 엣지, 속성의 개수와 함께 노드 및 엣지 레이블과 속성 키의 읽기 전용 목록을 반환합니다. 속성 그래프(PG)의 그래프 요약 응답을 참조하세요.

필드

• edgeLabels - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  그래프의 고유한 엣지 레이블 목록입니다.

• edgeProperties - LongValuedMap 객체이며 다음과 같은 키-값 페어의 맵 배열입니다.

      각 키는 String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

      각 값은 Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  각 속성이 사용된 엣지 수와 그래프의 고유한 엣지 속성 목록입니다.

• edgeStructures - NodeStructure 객체 배열입니다.

  이 필드는 요청 모드가 DETAILED인 경우에만 표시됩니다. 여기에는 엣지 구조 목록이 포함됩니다.

• nodeLabels - String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

  그래프의 고유한 노드 레이블 목록입니다.

• nodeProperties - LongValuedMap 객체이며 다음과 같은 키-값 페어의 맵 배열입니다.

      각 키는 String이며, 유형은 string(UTF-8 인코딩 문자열)입니다.

      각 값은 Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  그래프에 있는 고유한 노드 속성의 수입니다.

• nodeStructures - NodeStructure 객체 배열입니다.

  이 필드는 요청 모드가 DETAILED인 경우에만 표시됩니다. 여기에는 노드 구조 목록이 들어 있습니다.

• numEdgeLabels - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  그래프에 있는 고유한 엣지 레이블의 수입니다.

• numEdgeProperties - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  그래프에 있는 고유한 엣지 속성의 수입니다.

• numEdges - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  그래프의 엣지 수입니다.

• numNodeLabels - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  그래프에 있는 고유한 노드 레이블의 수입니다.

• numNodeProperties - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  각 속성이 사용된 노드 수와 그래프의 고유한 노드 속성 목록입니다.

• numNodes - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  그래프의 노드 수입니다.

• totalEdgePropertyValues - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  모든 엣지 속성의 총 사용 횟수입니다.

• totalNodePropertyValues - Long이며, 유형은 long(64비트 부호 있는 정수)입니다.

  모든 노드 속성의 총 사용 횟수입니다.