기타 Neptune API - Amazon Neptune
AddTagsToResourceListTagsForResourceRemoveTagsFromResourceApplyPendingMaintenanceActionDescribePendingMaintenanceActionsDescribeDBEngineVersions________________________DBEngineVersionEngineDefaultsPendingMaintenanceActionResourcePendingMaintenanceActionsUpgradeTarget태그

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

기타 Neptune API

작업

구조:

AddTagsToResource(작업)

        이 API의 AWS CLI 이름은 add-tags-to-resource입니다.

Amazon Neptune 리소스에 메타데이터 태그를 추가합니다. 비용 할당 보고서와 함께 이 태그를 사용하여 Amazon Neptune 리소스 관련 비용을 추적하거나, Amazon Neptune에 대한 IAM 정책의 조건문에 이 태그를 사용할 수 있습니다.

요청

  • ResourceName(CLI의 경우: --resource-name) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    태그가 추가된 Amazon Neptune 리소스입니다. 이 값은 Amazon 리소스 이름(ARN)입니다. ARN을 생성하는 방법에 대한 자세한 내용은 Amazon 리소스 이름(ARN) 생성을 참조하십시오.

  • Tags(CLI의 경우: --tags) - 필수: 태그 객체의 배열입니다.

    Amazon Neptune 리소스에 할당할 태그입니다.

응답

  • 무응답 파라미터.

오류

ListTagsForResource(작업)

        이 API의 AWS CLI 이름은 list-tags-for-resource입니다.

Amazon Neptune 리소스의 모든 태그를 나열합니다.

요청

  • Filters(CLI의 경우: --filters) - 필터 객체의 배열입니다.

    현재 지원되지 않는 파라미터입니다.

  • ResourceName(CLI의 경우: --resource-name) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    목록으로 나열할 태그가 있는 Amazon Neptune 리소스입니다. 이 값은 Amazon 리소스 이름(ARN)입니다. ARN을 생성하는 방법에 대한 자세한 내용은 Amazon 리소스 이름(ARN) 생성을 참조하십시오.

응답:

  • TagList – 태그 객체의 배열입니다.

    ListTagsForResource 작업으로 반환된 태그의 목록입니다.

오류

RemoveTagsFromResource(작업)

        이 API의 AWS CLI 이름은 remove-tags-from-resource입니다.

Amazon Neptune 리소스에서 메타데이터 태그를 제거합니다.

요청

  • ResourceName(CLI의 경우: --resource-name) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    태그를 제거한 Amazon Neptune 리소스입니다. 이 값은 Amazon 리소스 이름(ARN)입니다. ARN을 생성하는 방법에 대한 자세한 내용은 Amazon 리소스 이름(ARN) 생성을 참조하십시오.

  • TagKeys(CLI의 경우: --tag-keys) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    제거할 태그의 태그 키(이름)입니다.

응답

  • 무응답 파라미터.

오류

ApplyPendingMaintenanceAction(작업)

        이 API의 AWS CLI 이름은 apply-pending-maintenance-action입니다.

대기 중인 유지 관리 작업을 리소스(예: DB 인스턴스)에 적용합니다.

요청

  • ApplyAction(CLI의 경우: --apply-action) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    이 리소스에 적용할 대기 중인 유지 관리 작업입니다.

    유효값: system-update, db-upgrade

  • OptInType(CLI의 경우: --opt-in-type) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    옵트인 요청의 유형을 지정하거나 옵트인 요청을 실행 취소하는 값입니다. immediate 유형의 옵트인 요청은 실행 취소할 수 없습니다.

    유효한 값:

    • immediate - 유지 관리 작업을 즉시 적용합니다.

    • next-maintenance - 리소스의 다음번 유지 관리 기간 중에 유지 관리 작업을 적용합니다.

    • undo-opt-in - 기존의 next-maintenance 옵트인 요청을 모두 취소합니다.

  • ResourceIdentifier(CLI의 경우: --resource-identifier) - 필수: String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    대기 중인 유지 관리 작업이 적용되는 리소스의 Amazon 리소스 이름(ARN)입니다. ARN을 생성하는 방법에 대한 자세한 내용은 Amazon 리소스 이름(ARN) 생성을 참조하십시오.

응답:

리소스에 대해 대기 중인 유지 관리 작업을 설명합니다.

  • PendingMaintenanceActionDetails – PendingMaintenanceAction 객체의 배열입니다.

    리소스에 대해 대기 중인 유지 관리 작업의 세부 정보를 담은 목록입니다.

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

    대기 중인 유지 관리 작업이 있는 리소스의 ARN입니다.

오류

DescribePendingMaintenanceActions(작업)

        이 API의 AWS CLI 이름은 describe-pending-maintenance-actions입니다.

대기 중인 유지 관리 작업이 하나 이상 있는 리소스(예: DB 인스턴스)의 목록을 반환합니다.

요청

  • Filters(CLI의 경우: --filters) - 필터 객체의 배열입니다.

    대기 중인 유지 관리 작업을 반환할 리소스를 하나 이상 지정하는 필터입니다.

    지원되는 필터:

    • db-cluster-id - DB 클러스터 식별자 및 DB 클러스터의 Amazon 리소스 이름(ARN)을 사용할 수 있습니다. 결과 목록에는 이러한 ARN으로 식별된 DB 클러스터에 대해 대기 중인 유지 관리 작업만 포함됩니다.

    • db-instance-id - DB 인스턴스 식별자 및 DB 인스턴스 ARN을 허용합니다. 결과 목록에는 이러한 ARN으로 식별된 DB 인스턴스에 대해 대기 중인 유지 관리 작업만 포함됩니다.

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

    이전의 DescribePendingMaintenanceActions 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 다소의 레코드까지만 응답에 포함됩니다.

  • MaxRecords(CLI의 경우: --max-records) - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    응답에 포함되는 최대 레코드 수입니다. 지정된 MaxRecords 값보다 레코드 수가 많으면 마커라고 부르는 페이지 매김 토큰을 응답에 포함시켜 나머지 결과를 검색할 수 있도록 합니다.

    기본값: 100

    제약: 최소 20, 최대 100입니다.

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

    대기 중인 유지 관리 작업을 반환할 리소스의 ARN입니다.

응답:

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

    이전의 DescribePendingMaintenanceActions 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 다소의 레코드까지만 응답에 포함됩니다.

  • PendingMaintenanceActions – ResourcePendingMaintenanceActions 객체의 배열입니다.

    리소스에 대해 대기 중인 유지 관리 작업의 목록입니다.

오류

DescribeDBEngineVersions(작업)

        이 API의 AWS CLI 이름은 describe-db-engine-versions입니다.

사용 가능한 DB 엔진의 목록을 반환합니다.

요청

  • DBParameterGroupFamily(CLI의 경우: --db-parameter-group-family) - String, 유형은 string(UTF-8 인코딩 문자열)입니다.

    세부 정보를 반환할 특정 DB 파라미터 그룹 패밀리의 이름입니다.

    제약 조건:

    • 입력하는 경우, 기존 DBParameterGroupFamily와 일치해야 합니다.

  • DefaultOnly(CLI의 경우: --default-only) - Boolean, 유형은 boolean(부울(true 또는 false) 값)입니다.

    지정된 엔진의 기본 버전 또는 지정된 엔진과 메이저 버전의 조합만 반환됨을 나타냅니다.

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

    반환할 데이터베이스 엔진입니다.

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

    반환할 데이터베이스 버전입니다.

    예시: 5.1.49

  • Filters(CLI의 경우: --filters) - 필터 객체의 배열입니다.

    현재 지원되지 않습니다.

  • ListSupportedCharacterSets(CLI의 경우: --list-supported-character-sets) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    이 파라미터를 지정했으며 요청한 엔진이 CharacterSetName에 대해 CreateDBInstance 파라미터를 지원하는 경우, 엔진 버전별로 지원되는 문자 세트 목록이 응답에 포함됩니다.

  • ListSupportedTimezones(CLI의 경우: --list-supported-timezones) - BooleanOptional, 유형은 boolean(부울(true 또는 false) 값)입니다.

    이 파라미터를 지정했으며 요청한 엔진이 TimeZone에 대해 CreateDBInstance 파라미터를 지원하는 경우, 엔진 버전별로 지원되는 시간대 목록이 응답에 포함됩니다.

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

    이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.

  • MaxRecords(CLI의 경우: --max-records) - IntegerOptional, 유형은 integer(32비트 부호 있는 정수)입니다.

    응답에 포함되는 최대 레코드 수입니다. MaxRecords 값 이상을 사용 가능한 경우, 다음과 같은 결과를 검색할 수 있도록 마커라고 부르는 페이지 매김 토큰을 응답에 포함시킵니다.

    기본값: 100

    제약: 최소 20, 최대 100입니다.

응답:

  • DBEngineVersions – DBEngineVersion 객체의 배열입니다.

    DBEngineVersion 요소의 목록입니다.

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

    이전의 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.

구조:

DBEngineVersion(구조)

이 데이터 형식은 DescribeDBEngineVersions(작업) 작업에서 응답 요소로 사용됩니다.

Fields

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

    데이터베이스 엔진에 대한 설명입니다.

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

    데이터베이스 엔진 버전에 대한 설명입니다.

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

    데이터베이스 엔진에 사용할 DB 파라미터 그룹 패밀리의 이름입니다.

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

    데이터베이스 엔진의 이름입니다.

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

    데이터베이스 엔진의 버전 번호입니다.

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

    데이터베이스 엔진에서 CloudWatch Logs로 내보낼 수 있는 로그 유형입니다.

  • SupportedTimezones - Timezone 객체 배열입니다.

    Timezone 작업의 CreateDBInstance 파라미터에 대해 이 엔진에서 지원하는 시간대 목록입니다.

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

    Aurora 글로벌 데이터베이스를 특정 DB 엔진 버전과 사용할 수 있는지 여부를 나타내는 값입니다.

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

    CloudWatch Logs로 내보내도록 ExportableLogTypes에 지정된 로그 유형을 해당 엔진 버전에서 지원하는지 여부를 나타내는 값입니다.

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

    데이터베이스 엔진 버전에서 읽기 전용 복제본을 지원하는지 여부를 나타냅니다.

  • ValidUpgradeTarget - UpgradeTarget 객체 배열입니다.

    이 데이터베이스 엔진 버전을 업그레이드할 수 있는 엔진 버전의 목록입니다.

EngineDefaults(구조)

성공한 DescribeEngineDefaultParameters(작업) 작업 호출의 결과가 포함되어 있습니다.

Fields

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

    엔진의 기본 파라미터를 적용할 DB 파라미터 그룹 패밀리의 이름을 지정합니다.

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

    이전의 EngineDefaults 요청에서 제공된 선택적 페이지 매김 토큰입니다. 이 파라미터를 지정한 경우, 마커 이후부터 MaxRecords에 지정된 값까지의 레코드만 응답에 포함됩니다.

  • Parameters - 파라미터 객체 배열입니다.

    엔진 기본 파라미터의 목록이 포함되어 있습니다.

EngineDefaults는 다음의 응답 요소로 사용됩니다.

PendingMaintenanceAction(구조)

대기 중인 리소스 유지 관리 작업에 대한 정보를 제공합니다.

Fields

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

    해당 리소스에 사용 가능한 대기 중 유지 관리 작업의 유형입니다.

  • AutoAppliedAfterDate - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    작업을 적용할 유지 관리 기간의 날짜입니다. 이 날짜 이후의 첫 번째 유지 관리 기간에 해당 리소스에 유지 관리 작업을 적용합니다. 이 날짜를 지정하면 모든 next-maintenance 옵트인 요청은 무시됩니다.

  • CurrentApplyDate - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    대기 중 유지 관리 작업을 리소스에 적용한 발효 날짜입니다. 이 날짜는 ApplyPendingMaintenanceAction(작업) API, AutoAppliedAfterDate 및 ForcedApplyDate에서 수신한 계정 옵트인 요청을 고려하여 결정됩니다. 옵트인 요청이 수신되지 않았고 AutoAppliedAfterDate 또는 ForcedApplyDate로 아무것도 지정하지 않은 경우, 이 값은 비어 있습니다.

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

    유지 관리 작업에 대한 세부 정보를 담은 설명입니다.

  • ForcedApplyDate - TStamp, 유형은 timestamp(특정 시점, 일반적으로 1970-01-01 자정까지의 오프셋으로 정의됨)입니다.

    유지 관리 작업이 자동으로 적용되는 날짜입니다. 해당 리소스의 유지 관리 기간과 관계없이 이 날짜에 해당 리소스에 유지 관리 작업을 적용합니다. 이 날짜를 지정하면 모든 immediate 옵트인 요청은 무시됩니다.

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

    해당 리소스에 대해 수신된 옵트인 요청의 유형을 나타냅니다.

ResourcePendingMaintenanceActions(구조)

리소스에 대해 대기 중인 유지 관리 작업을 설명합니다.

Fields

  • PendingMaintenanceActionDetails - PendingMaintenanceAction 객체 배열입니다.

    리소스에 대해 대기 중인 유지 관리 작업의 세부 정보를 담은 목록입니다.

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

    대기 중인 유지 관리 작업이 있는 리소스의 ARN입니다.

ResourcePendingMaintenanceActions는 다음의 응답 요소로 사용됩니다.

UpgradeTarget(구조)

DB 인스턴스를 업그레이드할 수 있는 데이터베이스 엔진의 버전입니다.

Fields

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

    AutoMinorVersionUpgrade가 true로 설정되어 있는 소스 DB 인스턴스에 대상 버전을 적용할 것인지 여부를 나타내는 값입니다.

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

    DB 인스턴스를 업그레이드할 수 있는 데이터베이스 엔진의 버전입니다.

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

    업그레이드 대상인 데이터베이스 엔진의 이름입니다.

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

    업그레이드 대상인 데이터베이스 엔진의 버전 번호입니다.

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

    데이터베이스 엔진을 메이저 버전으로 업그레이드할 것인지 여부를 나타내는 값입니다.

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

    Neptune 글로벌 데이터베이스를 대상 엔진 버전과 사용할 수 있는지 여부를 나타내는 값입니다.

Tag(구조)

키-값 페어로 구성된 Amazon Neptune 리소스에 할당되는 메타데이터입니다.

Fields

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

    키는 태그의 필수 이름입니다. 문자열 값은 길이가 1~128자인 유니코드 문자이며 aws: 또는 rds:를 접두사로 사용할 수 없습니다. 문자열에는 유니코드 문자 집합, 숫자, 공백, '_', '.', '/', '=', '+', '-'(Java 정규식: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$") 기호만 포함될 수 있습니다.

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

    값은 태그의 선택적 값입니다. 문자열 값은 길이가 1~256자인 유니코드 문자이며 aws: 또는 rds:를 접두사로 사용할 수 없습니다. 문자열에는 유니코드 문자 집합, 숫자, 공백, '_', '.', '/', '=', '+', '-'(Java 정규식: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$") 기호만 포함될 수 있습니다.