Other Neptune APIs - Amazon Neptune
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Other Neptune APIs

Structures:

Actions:

CloudwatchLogsExportConfiguration (structure)

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs.

Fields

  • DisableLogTypes – An array of UTF-8 strings.

    The list of log types to disable.

  • EnableLogTypes – An array of UTF-8 strings.

    The list of log types to enable.

DBEngineVersion (structure)

This data type is used as a response element in the action DescribeDBEngineVersions (action).

Fields

  • DBEngineDescription – UTF-8 string.

    The description of the database engine.

  • DBEngineVersionDescription – UTF-8 string.

    The description of the database engine version.

  • DBParameterGroupFamily – UTF-8 string.

    The name of the DB parameter group family for the database engine.

  • Engine – UTF-8 string.

    The name of the database engine.

  • EngineVersion – UTF-8 string.

    The version number of the database engine.

  • ExportableLogTypes – An array of UTF-8 strings.

    The types of logs that the database engine has available for export to CloudWatch Logs.

  • SupportedTimezones – An array of Timezone Timezone objects.

    A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

  • SupportsGlobalDatabases – Boolean.

    A value that indicates whether you can use Aurora global databases with a specific DB engine version.

  • SupportsLogExportsToCloudwatchLogs – Boolean.

    A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

  • SupportsReadReplica – Boolean.

    Indicates whether the database engine version supports read replicas.

  • ValidUpgradeTarget – An array of UpgradeTarget UpgradeTarget objects.

    A list of engine versions that this database engine version can be upgraded to.

EngineDefaults (structure)

Contains the result of a successful invocation of the DescribeEngineDefaultParameters (action) action.

Fields

  • DBParameterGroupFamily – UTF-8 string.

    Specifies the name of the DB parameter group family that the engine default parameters apply to.

  • Marker – UTF-8 string.

    An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

  • Parameters – An array of Parameter Parameter objects.

    Contains a list of engine default parameters.

EngineDefaults is used as the response element for:

PendingMaintenanceAction (structure)

Provides information about a pending maintenance action for a resource.

Fields

  • Action – UTF-8 string.

    The type of pending maintenance action that is available for the resource.

  • AutoAppliedAfterDate – Timestamp.

    The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

  • CurrentApplyDate – Timestamp.

    The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction (action) API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

  • Description – UTF-8 string.

    A description providing more detail about the maintenance action.

  • ForcedApplyDate – Timestamp.

    The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

  • OptInStatus – UTF-8 string.

    Indicates the type of opt-in request that has been received for the resource.

PendingModifiedValues (structure)

This data type is used as a response element in the ModifyDBInstance (action) action.

Fields

  • AllocatedStorage – Number (integer).

    Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

  • BackupRetentionPeriod – Number (integer).

    Specifies the pending number of days for which automated backups are retained.

  • CACertificateIdentifier – UTF-8 string.

    Specifies the identifier of the CA certificate for the DB instance.

  • DBInstanceClass – UTF-8 string.

    Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

  • DBInstanceIdentifier – UTF-8 string.

    Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

  • DBSubnetGroupName – UTF-8 string.

    The new DB subnet group for the DB instance.

  • EngineVersion – UTF-8 string.

    Indicates the database engine version.

  • Iops – Number (integer).

    Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

  • MultiAZ – Boolean.

    Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

  • PendingCloudwatchLogsExports – A PendingCloudwatchLogsExports object.

    This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

  • Port – Number (integer).

    Specifies the pending port for the DB instance.

  • StorageType – UTF-8 string.

    Specifies the storage type to be associated with the DB instance.

PendingCloudwatchLogsExports (structure)

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

Fields

  • LogTypesToDisable – An array of UTF-8 strings.

    Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

  • LogTypesToEnable – An array of UTF-8 strings.

    Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

ResourcePendingMaintenanceActions (structure)

Describes the pending maintenance actions for a resource.

Fields

  • PendingMaintenanceActionDetails – An array of PendingMaintenanceAction PendingMaintenanceAction objects.

    A list that provides details about the pending maintenance actions for the resource.

  • ResourceIdentifier – UTF-8 string.

    The ARN of the resource that has pending maintenance actions.

ResourcePendingMaintenanceActions is used as the response element for:

UpgradeTarget (structure)

The version of the database engine that a DB instance can be upgraded to.

Fields

  • AutoUpgrade – Boolean.

    A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

  • Description – UTF-8 string.

    The version of the database engine that a DB instance can be upgraded to.

  • Engine – UTF-8 string.

    The name of the upgrade target database engine.

  • EngineVersion – UTF-8 string.

    The version number of the upgrade target database engine.

  • IsMajorVersionUpgrade – Boolean.

    A value that indicates whether a database engine is upgraded to a major version.

  • SupportsGlobalDatabases – Boolean.

    A value that indicates whether you can use Neptune global databases with the target engine version.

Tag (structure)

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

Fields

  • Key – UTF-8 string.

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

  • Value – UTF-8 string.

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").

AddTagsToResource (action)

        The Amazon CLI name for this API is: add-tags-to-resource,  and the Python name is: add_tags_to_resource.

Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

Request

  • ResourceName  (in the CLI: --resource-name,  or in Python: resource_name) – Required: UTF-8 string.

    The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

  • Tags  (in the CLI: --tags,  or in Python: tags) – Required: An array of Tag Tag objects.

    The tags to be assigned to the Amazon Neptune resource.

Response

  • No Response parameters.

ListTagsForResource (action)

        The Amazon CLI name for this API is: list-tags-for-resource,  and the Python name is: list_tags_for_resource.

Lists all tags on an Amazon Neptune resource.

Request

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    This parameter is not currently supported.

  • ResourceName  (in the CLI: --resource-name,  or in Python: resource_name) – Required: UTF-8 string.

    The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

Response

  • TagList  (in the CLI: --tag-list,  or in Python: tag_list) – An array of Tag Tag objects.

    List of tags returned by the ListTagsForResource operation.

RemoveTagsFromResource (action)

        The Amazon CLI name for this API is: remove-tags-from-resource,  and the Python name is: remove_tags_from_resource.

Removes metadata tags from an Amazon Neptune resource.

Request

  • ResourceName  (in the CLI: --resource-name,  or in Python: resource_name) – Required: UTF-8 string.

    The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

  • TagKeys  (in the CLI: --tag-keys,  or in Python: tag_keys) – Required: An array of UTF-8 strings.

    The tag key (name) of the tag to be removed.

Response

  • No Response parameters.

ApplyPendingMaintenanceAction (action)

        The Amazon CLI name for this API is: apply-pending-maintenance-action,  and the Python name is: apply_pending_maintenance_action.

Applies a pending maintenance action to a resource (for example, to a DB instance).

Request

  • ApplyAction  (in the CLI: --apply-action,  or in Python: apply_action) – Required: UTF-8 string.

    The pending maintenance action to apply to this resource.

    Valid values: system-update, db-upgrade

  • OptInType  (in the CLI: --opt-in-type,  or in Python: opt_in_type) – Required: UTF-8 string.

    A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.

    Valid values:

    • immediate - Apply the maintenance action immediately.

    • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

    • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

  • ResourceIdentifier  (in the CLI: --resource-identifier,  or in Python: resource_identifier) – Required: UTF-8 string.

    The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

Response

Describes the pending maintenance actions for a resource.

  • PendingMaintenanceActionDetails  (in the CLI: --pending-maintenance-action-details,  or in Python: pending_maintenance_action_details) – An array of PendingMaintenanceAction PendingMaintenanceAction objects.

    A list that provides details about the pending maintenance actions for the resource.

  • ResourceIdentifier  (in the CLI: --resource-identifier,  or in Python: resource_identifier) – UTF-8 string.

    The ARN of the resource that has pending maintenance actions.

DescribePendingMaintenanceActions (action)

        The Amazon CLI name for this API is: describe-pending-maintenance-actions,  and the Python name is: describe_pending_maintenance_actions.

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

Request

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    A filter that specifies one or more resources to return pending maintenance actions for.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

    • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • ResourceIdentifier  (in the CLI: --resource-identifier,  or in Python: resource_identifier) – UTF-8 string.

    The ARN of a resource to return pending maintenance actions for.

Response

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

  • PendingMaintenanceActions  (in the CLI: --pending-maintenance-actions,  or in Python: pending_maintenance_actions) – An array of ResourcePendingMaintenanceActions ResourcePendingMaintenanceActions objects.

    A list of the pending maintenance actions for the resource.

DescribeDBEngineVersions (action)

        The Amazon CLI name for this API is: describe-db-engine-versions,  and the Python name is: describe_db_engine_versions.

Returns a list of the available DB engines.

Request

  • DBParameterGroupFamily  (in the CLI: --db-parameter-group-family,  or in Python: db_parameter_group_family) – UTF-8 string.

    The name of a specific DB parameter group family to return details for.

    Constraints:

    • If supplied, must match an existing DBParameterGroupFamily.

  • DefaultOnly  (in the CLI: --default-only,  or in Python: default_only) – Boolean.

    Indicates that only the default version of the specified engine or engine and major version combination is returned.

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

    The database engine to return.

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    The database engine version to return.

    Example: 5.1.49

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    Not currently supported.

  • ListSupportedCharacterSets  (in the CLI: --list-supported-character-sets,  or in Python: list_supported_character_sets) – Boolean.

    If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

  • ListSupportedTimezones  (in the CLI: --list-supported-timezones,  or in Python: list_supported_timezones) – Boolean.

    If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

Response

  • DBEngineVersions  (in the CLI: --db-engine-versions,  or in Python: db_engine_versions) – An array of DBEngineVersion DBEngineVersion objects.

    A list of DBEngineVersion elements.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.