其他 Neptune API - Amazon Neptune
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

其他 Neptune API

结构:

操作:

CloudwatchLogsExportConfiguration(结构)

要启用日志类型的配置设置,以便针对特定数据库实例或数据库集群导出到 CloudWatch Logs。

EnableLogTypesDisableLogTypes 数组确定要将哪些日志导出(或不导出)到 CloudWatch Logs。

字段

  • DisableLogTypes – UTF-8 字符串数组。

    要禁用的日志类型列表。

  • EnableLogTypes – UTF-8 字符串数组。

    要启用的日志类型的列表。

DBEngineVersion(结构)

此数据类型用作 DescribeDBEngineVersions(操作) 操作中的响应元素。

字段

  • DBEngineDescription – UTF-8 字符串。

    数据库引擎的描述。

  • DBEngineVersionDescription – UTF-8 字符串。

    数据库引擎版本的描述。

  • DBParameterGroupFamily – UTF-8 字符串。

    要用于数据库引擎的数据库参数组系列的名称。

  • Engine – UTF-8 字符串。

    数据库引擎的名称。

  • EngineVersion – UTF-8 字符串。

    数据库引擎的版本号。

  • ExportableLogTypes – UTF-8 字符串数组。

    数据库引擎可用于导出到 CloudWatch Logs 的日志的类型。

  • SupportedTimezones— 数组时区时区对象。

    用于 CreateDBInstance 操作的 Timezone 参数且受此引擎支持的时区列表。

  • SupportsLogExportsToCloudwatchLogs – 布尔值。

    一个值,指示引擎版本是否支持将 ExportableLogTypes 指定的日志类型导出到 CloudWatch Logs。

  • SupportsReadReplica – 布尔值。

    指示数据库引擎版本是否支持只读副本。

  • ValidUpgradeTarget— 数组UpgradeTargetUpgradeTarget 对象。

    此数据库引擎版本可以升级到的引擎版本列表。

EngineDefaults(结构)

包含 DescribeEngineDefaultParameters(操作) 操作的成功调用的结果。

字段

  • DBParameterGroupFamily – UTF-8 字符串。

    指定引擎默认参数应用到的数据库参数组系列的名称。

  • Marker – UTF-8 字符串。

    由之前的 EngineDefaults 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • Parameters— 数组参数参数对象。

    包含引擎默认参数的列表。

EngineDefaults 用作下列对象的响应元素:

PendingMaintenanceAction(结构)

提供有关资源的待处理维护操作的信息。

字段

  • Action – UTF-8 字符串。

    可用于资源的待处理维护操作的类型。

  • AutoAppliedAfterDate – 时间戳。

    应用操作时维护时段的日期。维护操作在此日期之后的第一个维护时段期间应用于资源。如果指定了此日期,则忽略任何 next-maintenance 加入请求。

  • CurrentApplyDate – 时间戳。

    待处理维护操作应用于资源的生效日期。此日期考虑了从 ApplyPendingMaintenanceAction(操作) API、AutoAppliedAfterDateForcedApplyDate 收到的加入请求。如果未收到加入请求且未将任何内容指定为 AutoAppliedAfterDateForcedApplyDate,则此值为空。

  • Description – UTF-8 字符串。

    提供有关维护操作的更多详细信息的描述。

  • ForcedApplyDate – 时间戳。

    自动应用维护操作时的日期。无论资源的维护时段如何,维护操作都将在此日期应用于资源。如果指定了此日期,则忽略任何 immediate 加入请求。

  • OptInStatus – UTF-8 字符串。

    指示已为资源接收的加入请求的类型。

PendingModifiedValues(结构)

此数据类型用作 ModifyDBInstance(操作) 操作中的响应元素。

字段

  • AllocatedStorage – 数字 (integer)。

    包含将要应用或当前正在应用的数据库实例的新 AllocatedStorage 大小。

  • BackupRetentionPeriod – 数字 (integer)。

    指定保留自动备份的挂起天数。

  • CACertificateIdentifier – UTF-8 字符串。

    指定数据库实例的 CA 证书的标识符。

  • DBInstanceClass – UTF-8 字符串。

    包含将要应用或当前正在应用的数据库实例的新 DBInstanceClass

  • DBInstanceIdentifier – UTF-8 字符串。

    包含将要应用或当前正在应用的数据库实例的新 DBInstanceIdentifier

  • DBSubnetGroupName – UTF-8 字符串。

    数据库实例的新数据库子网组。

  • EngineVersion – UTF-8 字符串。

    指示数据库引擎版本。

  • Iops – 数字 (integer)。

    指定将应用或当前正在应用的数据库实例的新预配置 IOPS 值。

  • MultiAZ – 布尔值。

    指示单可用区数据库实例将更改为多可用区部署。

  • PendingCloudwatchLogsExports – 一个 PendingCloudwatchLogsExports 对象。

    PendingCloudwatchLogsExports 结构指定了已启用和已禁用 CloudWatch Logs 的待处理更改。

  • Port – 数字 (integer)。

    指定数据库实例的挂起端口。

  • StorageType – UTF-8 字符串。

    指定要与数据库实例关联的存储类型。

PendingCloudwatchLogsExports(结构)

其配置仍处于待处理状态的日志类型的列表。换句话说,这些日志类型正处于激活或停用过程中。

字段

  • LogTypesToDisable – UTF-8 字符串数组。

    处于启用过程中的日志类型。启用之后,这些日志类型会导出到 CloudWatch Logs。

  • LogTypesToEnable – UTF-8 字符串数组。

    处于停用过程中的日志类型。停用之后,这些日志类型不会导出到 CloudWatch Logs。

ResourcePendingMaintenanceActions(结构)

描述资源的待处理维护操作。

字段

  • PendingMaintenanceActionDetails— 数组PendingMaintenanceActionPendingMaintenanceAction 对象。

    一个列表,提供有关资源的待处理维护操作的详细信息。

  • ResourceIdentifier – UTF-8 字符串。

    具有待处理维护操作的资源的 ARN。

ResourcePendingMaintenanceActions 用作下列对象的响应元素:

UpgradeTarget(结构)

数据库实例可以升级到的数据库引擎的版本。

字段

  • AutoUpgrade – 布尔值。

    一个值,指示目标版本是否应用于 AutoMinorVersionUpgrade 设置为 true 的任何源数据库实例。

  • Description – UTF-8 字符串。

    数据库实例可以升级到的数据库引擎的版本。

  • Engine – UTF-8 字符串。

    升级目标数据库引擎的名称。

  • EngineVersion – UTF-8 字符串。

    升级目标数据库引擎的版本号。

  • IsMajorVersionUpgrade – 布尔值。

    一个值,用于指示数据库引擎是否已升级到主要版本。

Tag(结构)

分配给包含键值对的 Amazon Neptune 资源的元数据。

字段

  • Key – UTF-8 字符串。

    密钥是标签必需的名称。该字符串值的长度可以在 1 到 128 个 Unicode 字符之间,并且不能带有前缀。aws:要么rds:. 该字符串只能包含 Unicode 字母、数字、空格、“_”、“_”、“” 的集合。 . “、”、“/”、“=”、“+”、“-”(Java 正则表达式:“^ ([\\ p {L}\\ p {Z}\\ p {N} _.: /=+\\-] *) $”)。

  • Value – UTF-8 字符串。

    值是标签的可选内容。该字符串值的长度可以在 1 到 256 个 Unicode 字符之间,并且不能带有前缀。aws:要么rds:. 该字符串只能包含 Unicode 字母、数字、空格、“_”、“_”、“” 的集合。 . “、”、“/”、“=”、“+”、“-”(Java 正则表达式:“^ ([\\ p {L}\\ p {Z}\\ p {N} _.: /=+\\-] *) $”)。

AddTagsToResource(操作)

        此 API 的 Amazon CLI 名称为:add-tags-to-resource,Python 的名字是:add_tags_to_resource.

向 Amazon Neptune 资源中添加元数据标签。这些标签还可以与成本分配报告一起使用,以跟踪与 Amazon Neptune 资源相关的成本,或者在 Amazon Neptune 的 IAM 策略中的条件语句内使用。

请求

  • ResourceName(在 CLI 中:--resource-name,或者在 Python 中:resource_name) –:必填项:UTF-8 字符串。

    将标签添加到的 Amazon Neptune 资源。此值是 Amazon 资源名称 (ARN)。有关创建 ARN 的信息,请参阅构造 Amazon 资源名称 (ARN)

  • Tags(在 CLI 中:--tags,或者在 Python 中:tags) –:必填项:数组标签标记对象。

    要分配给 Amazon Neptune 资源的标签。

响应

  • 无响应参数。

ListTagsForResource(操作)

        此 API 的 Amazon CLI 名称为:list-tags-for-resource,Python 的名字是:list_tags_for_resource.

列出 Amazon Neptune 资源上的所有标签。

请求

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持此参数。

  • ResourceName(在 CLI 中:--resource-name,或者在 Python 中:resource_name) –:必填项:UTF-8 字符串。

    带有要列出的标签的 Amazon Neptune 资源。此值是 Amazon 资源名称 (ARN)。有关创建 ARN 的信息,请参阅构造 Amazon 资源名称 (ARN)

响应

  • TagList(在 CLI 中:--tag-list,或者在 Python 中:tag_list) — 数组标签标记对象。

    ListTagsForResource 操作返回的标签列表。

RemoveTagsFromResource(操作)

        此 API 的 Amazon CLI 名称为:remove-tags-from-resource,Python 的名字是:remove_tags_from_resource.

从 Amazon Neptune 资源中删除元数据标签。

请求

  • ResourceName(在 CLI 中:--resource-name,或者在 Python 中:resource_name) –:必填项:UTF-8 字符串。

    从其中删除标签的 Amazon Neptune 资源。此值是 Amazon 资源名称 (ARN)。有关创建 ARN 的信息,请参阅构造 Amazon 资源名称 (ARN)

  • TagKeys(在 CLI 中:--tag-keys,或者在 Python 中:tag_keys) –:必填项:UTF-8 字符串数组。

    要删除的标签的标签键(名称)。

响应

  • 无响应参数。

ApplyPendingMaintenanceAction(操作)

        此 API 的 Amazon CLI 名称为:apply-pending-maintenance-action,Python 的名字是:apply_pending_maintenance_action.

将待处理的维护操作应用于资源(例如,应用于数据库实例)。

请求

  • ApplyAction(在 CLI 中:--apply-action,或者在 Python 中:apply_action) –:必填项:UTF-8 字符串。

    应用于此资源的待处理的维护操作。

    有效值:system-updatedb-upgrade

  • OptInType(在 CLI 中:--opt-in-type,或者在 Python 中:opt_in_type) –:必填项:UTF-8 字符串。

    用于指定加入请求类型或撤消加入请求的值。不能撤消 immediate 类型的加入请求。

    有效值:

    • immediate - 立即应用维护操作。

    • next-maintenance - 在资源的下一个维护时段内应用维护操作。

    • undo-opt-in - 取消任何现有的 next-maintenance 加入请求。

  • ResourceIdentifier(在 CLI 中:--resource-identifier,或者在 Python 中:resource_identifier) –:必填项:UTF-8 字符串。

    待处理的维护操作应用于的资源的 Amazon 资源名称 (ARN)。有关创建 ARN 的信息,请参阅构造 Amazon 资源名称 (ARN)

响应

描述资源的待处理维护操作。

  • PendingMaintenanceActionDetails(在 CLI 中:--pending-maintenance-action-details,或者在 Python 中:pending_maintenance_action_details) — 数组PendingMaintenanceActionPendingMaintenanceAction 对象。

    一个列表,提供有关资源的待处理维护操作的详细信息。

  • ResourceIdentifier(在 CLI 中:--resource-identifier,或者在 Python 中:resource_identifier) – UTF-8 字符串。

    具有待处理维护操作的资源的 ARN。

DescribePendingMaintenanceActions(操作)

        此 API 的 Amazon CLI 名称为:describe-pending-maintenance-actions,Python 的名字是:describe_pending_maintenance_actions.

返回至少具有一个待处理的维护操作的资源(例如,数据库实例)的列表。

请求

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    一个筛选条件,用于指定一个或多个资源以返回其待处理的维护操作。

    支持的筛选条件:

    • db-cluster-id - 接受数据库集群标识符和数据库集群 Amazon 资源名称 (ARN)。结果列表将仅包括由这些 ARN 标识的数据库集群的待处理维护操作。

    • db-instance-id - 接受数据库实例标识符和数据库实例 ARN。结果列表将仅包括由这些 ARN 标识的数据库实例的待处理维护操作。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribePendingMaintenanceActions 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数为 MaxRecords 指定的记录数。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:最低为 20,最高为 100。

  • ResourceIdentifier(在 CLI 中:--resource-identifier,或者在 Python 中:resource_identifier) – UTF-8 字符串。

    用于返回其待处理维护操作的资源的 ARN。

响应

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribePendingMaintenanceActions 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数为 MaxRecords 指定的记录数。

  • PendingMaintenanceActions(在 CLI 中:--pending-maintenance-actions,或者在 Python 中:pending_maintenance_actions) — 数组ResourcePendingMaintenanceActionsResourcePendingMaintenanceActions 对象。

    资源的待处理维护操作的列表。

DescribeDBEngineVersions(操作)

        此 API 的 Amazon CLI 名称为:describe-db-engine-versions,Python 的名字是:describe_db_engine_versions.

返回可用数据库引擎的列表。

请求

  • DBParameterGroupFamily(在 CLI 中:--db-parameter-group-family,或者在 Python 中:db_parameter_group_family) – UTF-8 字符串。

    要返回其详细信息的特定数据库参数组系列的名称。

    约束:

    • 如果提供,则必须匹配现有 DBParameterGroupFamily。

  • DefaultOnly(在 CLI 中:--default-only,或者在 Python 中:default_only) – Boolean.

    指示仅返回指定引擎的默认版本还是返回引擎与主要版本的组合。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    要返回的数据库引擎。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    要返回的数据库引擎版本。

    示例:5.1.49

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选条件过滤对象。

    当前不支持。

  • ListSupportedCharacterSets(在 CLI 中:--list-supported-character-sets,或者在 Python 中:list_supported_character_sets) – Boolean.

    如果指定了此参数且请求的引擎支持 CreateDBInstanceCharacterSetName 参数,则响应包括每个引擎版本支持的字符集列表。

  • ListSupportedTimezones(在 CLI 中:--list-supported-timezones,或者在 Python 中:list_supported_timezones) – Boolean.

    如果指定了此参数且请求的引擎支持 CreateDBInstanceTimeZone 参数,则响应包括每个引擎版本支持的时区列表。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果允许超过 MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索以下结果。

    默认值:100

    约束:最低为 20,最高为 100。

响应

  • DBEngineVersions(在 CLI 中:--db-engine-versions,或者在 Python 中:db_engine_versions) — 数组DBEngineVersiondbGenVersion 对象。

    DBEngineVersion 元素的列表。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。