# Actions The following actions are supported: + [AddRoleToDBCluster](API_AddRoleToDBCluster.md) + [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) + [AddTagsToResource](API_AddTagsToResource.md) + [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) + [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md) + [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md) + [CopyDBParameterGroup](API_CopyDBParameterGroup.md) + [CreateDBCluster](API_CreateDBCluster.md) + [CreateDBClusterEndpoint](API_CreateDBClusterEndpoint.md) + [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md) + [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md) + [CreateDBInstance](API_CreateDBInstance.md) + [CreateDBParameterGroup](API_CreateDBParameterGroup.md) + [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md) + [CreateEventSubscription](API_CreateEventSubscription.md) + [CreateGlobalCluster](API_CreateGlobalCluster.md) + [DeleteDBCluster](API_DeleteDBCluster.md) + [DeleteDBClusterEndpoint](API_DeleteDBClusterEndpoint.md) + [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md) + [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md) + [DeleteDBInstance](API_DeleteDBInstance.md) + [DeleteDBParameterGroup](API_DeleteDBParameterGroup.md) + [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md) + [DeleteEventSubscription](API_DeleteEventSubscription.md) + [DeleteGlobalCluster](API_DeleteGlobalCluster.md) + [DescribeDBClusterEndpoints](API_DescribeDBClusterEndpoints.md) + [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) + [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) + [DescribeDBClusters](API_DescribeDBClusters.md) + [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) + [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) + [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md) + [DescribeDBInstances](API_DescribeDBInstances.md) + [DescribeDBParameterGroups](API_DescribeDBParameterGroups.md) + [DescribeDBParameters](API_DescribeDBParameters.md) + [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) + [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md) + [DescribeEngineDefaultParameters](API_DescribeEngineDefaultParameters.md) + [DescribeEventCategories](API_DescribeEventCategories.md) + [DescribeEvents](API_DescribeEvents.md) + [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) + [DescribeGlobalClusters](API_DescribeGlobalClusters.md) + [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) + [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md) + [DescribeValidDBInstanceModifications](API_DescribeValidDBInstanceModifications.md) + [FailoverDBCluster](API_FailoverDBCluster.md) + [FailoverGlobalCluster](API_FailoverGlobalCluster.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ModifyDBCluster](API_ModifyDBCluster.md) + [ModifyDBClusterEndpoint](API_ModifyDBClusterEndpoint.md) + [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md) + [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) + [ModifyDBInstance](API_ModifyDBInstance.md) + [ModifyDBParameterGroup](API_ModifyDBParameterGroup.md) + [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md) + [ModifyEventSubscription](API_ModifyEventSubscription.md) + [ModifyGlobalCluster](API_ModifyGlobalCluster.md) + [PromoteReadReplicaDBCluster](API_PromoteReadReplicaDBCluster.md) + [RebootDBInstance](API_RebootDBInstance.md) + [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) + [RemoveRoleFromDBCluster](API_RemoveRoleFromDBCluster.md) + [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) + [RemoveTagsFromResource](API_RemoveTagsFromResource.md) + [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md) + [ResetDBParameterGroup](API_ResetDBParameterGroup.md) + [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md) + [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md) + [StartDBCluster](API_StartDBCluster.md) + [StopDBCluster](API_StopDBCluster.md) + [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md) # AddRoleToDBCluster Associates an Identity and Access Management (IAM) role with an Neptune DB cluster. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The name of the DB cluster to associate the IAM role with. Type: String Required: Yes ** FeatureName ** The name of the feature for the Neptune DB cluster that the IAM role is to be associated with. For the list of supported feature names, see [DBEngineVersion](API_DBEngineVersion.md). Type: String Required: No ** RoleArn ** The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example `arn:aws:iam::123456789012:role/NeptuneAccessRole`. Type: String Required: Yes ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBClusterRoleAlreadyExists ** The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster. HTTP Status Code: 400 ** DBClusterRoleQuotaExceeded ** You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/AddRoleToDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/AddRoleToDBCluster) # AddSourceIdentifierToSubscription Adds a source identifier to an existing event notification subscription. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** SourceIdentifier ** The identifier of the event source to be added. Constraints: + If the source type is a DB instance, then a `DBInstanceIdentifier` must be supplied. + If the source type is a DB security group, a `DBSecurityGroupName` must be supplied. + If the source type is a DB parameter group, a `DBParameterGroupName` must be supplied. + If the source type is a DB snapshot, a `DBSnapshotIdentifier` must be supplied. Type: String Required: Yes ** SubscriptionName ** The name of the event notification subscription you want to add a source identifier to. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** EventSubscription ** Contains the results of a successful invocation of the [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) action. Type: [EventSubscription](API_EventSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** SourceNotFound ** The source could not be found. HTTP Status Code: 404 ** SubscriptionNotFound ** The designated subscription could not be found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/AddSourceIdentifierToSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/AddSourceIdentifierToSubscription) # AddTagsToResource 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 Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** ResourceName ** 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)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). Type: String Required: Yes **Tags.Tag.N** The tags to be assigned to the Amazon Neptune resource. Type: Array of [Tag](API_Tag.md) objects Required: Yes ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** DBSnapshotNotFound ** *DBSnapshotIdentifier* does not refer to an existing DB snapshot. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/AddTagsToResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/AddTagsToResource) # ApplyPendingMaintenanceAction Applies a pending maintenance action to a resource (for example, to a DB instance). ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** ApplyAction ** The pending maintenance action to apply to this resource. Valid values: `system-update`, `db-upgrade` Type: String Required: Yes ** OptInType ** 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. Type: String Required: Yes ** ResourceIdentifier ** 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)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). Type: String Required: Yes ## Response Elements The following element is returned by the service. ** ResourcePendingMaintenanceActions ** Describes the pending maintenance actions for a resource. Type: [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundFault ** The specified resource ID was not found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ApplyPendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ApplyPendingMaintenanceAction) # CopyDBClusterParameterGroup Copies the specified DB cluster parameter group. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** SourceDBClusterParameterGroupIdentifier ** The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see [ Constructing an Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). Constraints: + Must specify a valid DB cluster parameter group. + If the source DB cluster parameter group is in the same Amazon Region as the copy, specify a valid DB parameter group identifier, for example `my-db-cluster-param-group`, or a valid ARN. + If the source DB parameter group is in a different Amazon Region than the copy, specify a valid DB cluster parameter group ARN, for example `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`. Type: String Required: Yes **Tags.Tag.N** The tags to be assigned to the copied DB cluster parameter group. Type: Array of [Tag](API_Tag.md) objects Required: No ** TargetDBClusterParameterGroupDescription ** A description for the copied DB cluster parameter group. Type: String Required: Yes ** TargetDBClusterParameterGroupIdentifier ** The identifier for the copied DB cluster parameter group. Constraints: + Cannot be null, empty, or blank + Must contain from 1 to 255 letters, numbers, or hyphens + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens Example: `my-cluster-param-group1` Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBClusterParameterGroup ** Contains the details of an Amazon Neptune DB cluster parameter group. This data type is used as a response element in the [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) action. Type: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupAlreadyExists ** A DB parameter group with the same name exists. HTTP Status Code: 400 ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** DBParameterGroupQuotaExceeded ** Request would result in user exceeding the allowed number of DB parameter groups. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CopyDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CopyDBClusterParameterGroup) # CopyDBClusterSnapshot Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** CopyTags ** True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false. Type: Boolean Required: No ** KmsKeyId ** The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key. If you copy an encrypted DB cluster snapshot from your Amazon account, you can specify a value for `KmsKeyId` to encrypt the copy with a new KMS encryption key. If you don't specify a value for `KmsKeyId`, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for `KmsKeyId`. KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region. You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned. Type: String Required: No ** PreSignedUrl ** Not currently supported. Type: String Required: No ** SourceDBClusterSnapshotIdentifier ** The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. If the source DB cluster snapshot is in a different region or owned by another account, specify the snapshot ARN. Constraints: + Must specify a valid system snapshot in the "available" state. + Specify a valid DB snapshot identifier. Example: `my-cluster-snapshot1` Type: String Required: Yes **Tags.Tag.N** The tags to assign to the new DB cluster snapshot copy. Type: Array of [Tag](API_Tag.md) objects Required: No ** TargetDBClusterSnapshotIdentifier ** The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + First character must be a letter. + Cannot end with a hyphen or contain two consecutive hyphens. Example: `my-cluster-snapshot2` Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBClusterSnapshot ** Contains the details for an Amazon Neptune DB cluster snapshot This data type is used as a response element in the [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) action. Type: [DBClusterSnapshot](API_DBClusterSnapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterSnapshotAlreadyExistsFault ** User already has a DB cluster snapshot with the given identifier. HTTP Status Code: 400 ** DBClusterSnapshotNotFoundFault ** *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot. HTTP Status Code: 404 ** InvalidDBClusterSnapshotStateFault ** The supplied value is not a valid DB cluster snapshot state. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** KMSKeyNotAccessibleFault ** Error accessing KMS key. HTTP Status Code: 400 ** SnapshotQuotaExceeded ** Request would result in user exceeding the allowed number of DB snapshots. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CopyDBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CopyDBClusterSnapshot) # CopyDBParameterGroup Copies the specified DB parameter group. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** SourceDBParameterGroupIdentifier ** The identifier or ARN for the source DB parameter group. For information about creating an ARN, see [ Constructing an Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). Constraints: + Must specify a valid DB parameter group. + Must specify a valid DB parameter group identifier, for example `my-db-param-group`, or a valid ARN. Type: String Required: Yes **Tags.Tag.N** The tags to be assigned to the copied DB parameter group. Type: Array of [Tag](API_Tag.md) objects Required: No ** TargetDBParameterGroupDescription ** A description for the copied DB parameter group. Type: String Required: Yes ** TargetDBParameterGroupIdentifier ** The identifier for the copied DB parameter group. Constraints: + Cannot be null, empty, or blank. + Must contain from 1 to 255 letters, numbers, or hyphens. + First character must be a letter. + Cannot end with a hyphen or contain two consecutive hyphens. Example: `my-db-parameter-group` Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBParameterGroup ** Contains the details of an Amazon Neptune DB parameter group. This data type is used as a response element in the [DescribeDBParameterGroups](API_DescribeDBParameterGroups.md) action. Type: [DBParameterGroup](API_DBParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupAlreadyExists ** A DB parameter group with the same name exists. HTTP Status Code: 400 ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** DBParameterGroupQuotaExceeded ** Request would result in user exceeding the allowed number of DB parameter groups. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CopyDBParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CopyDBParameterGroup) # CreateDBCluster Creates a new Amazon Neptune DB cluster. You can use the `ReplicationSourceIdentifier` parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance. Note that when you create a new cluster using `CreateDBCluster` directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its `DeletionProtection` field is set to `false`. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). **AvailabilityZones.AvailabilityZone.N** A list of EC2 Availability Zones that instances in the DB cluster can be created in. Type: Array of strings Required: No ** BackupRetentionPeriod ** The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: + Must be a value from 1 to 35 Type: Integer Required: No ** CharacterSetName ** *(Not supported by Neptune)* Type: String Required: No ** CopyTagsToSnapshot ** *If set to `true`, tags are copied to any snapshot of the DB cluster that is created.* Type: Boolean Required: No ** DatabaseName ** The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating. Type: String Required: No ** DBClusterIdentifier ** The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + First character must be a letter. + Cannot end with a hyphen or contain two consecutive hyphens. Example: `my-cluster1` Type: String Required: Yes ** DBClusterParameterGroupName ** The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used. Constraints: + If supplied, must match the name of an existing DBClusterParameterGroup. Type: String Required: No ** DBSubnetGroupName ** A DB subnet group to associate with this DB cluster. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: `mySubnetgroup` Type: String Required: No ** DeletionProtection ** A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled. Type: Boolean Required: No **EnableCloudwatchLogsExports.member.N** A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: `audit` (to publish audit logs) and `slowquery` (to publish slow-query logs). See [Publishing Neptune logs to Amazon CloudWatch logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html). Type: Array of strings Required: No ** EnableIAMDatabaseAuthentication ** If set to `true`, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level). Default: `false`. Type: Boolean Required: No ** Engine ** The name of the database engine to be used for this DB cluster. Valid Values: `neptune` Type: String Required: Yes ** EngineVersion ** The version number of the database engine to use for the new DB cluster. Example: `1.2.1.0` Type: String Required: No ** GlobalClusterIdentifier ** The ID of the Neptune global database to which this new DB cluster should be added. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ** KmsKeyId ** The Amazon KMS key identifier for an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If an encryption key is not specified in `KmsKeyId`: + If `ReplicationSourceIdentifier` identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key. + If the `StorageEncrypted` parameter is true and `ReplicationSourceIdentifier` is not specified, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region. If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set `KmsKeyId` to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region. Type: String Required: No ** MasterUsername ** Not supported by Neptune. Type: String Required: No ** MasterUserPassword ** Not supported by Neptune. Type: String Required: No ** OptionGroupName ** *(Not supported by Neptune)* Type: String Required: No ** Port ** The port number on which the instances in the DB cluster accept connections. Default: `8182` Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see [Neptune Maintenance Window](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) in the *Amazon Neptune User Guide.* Constraints: + Must be in the format `hh24:mi-hh24:mi`. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Type: String Required: No ** PreferredMaintenanceWindow ** The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: `ddd:hh24:mi-ddd:hh24:mi` The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see [Neptune Maintenance Window](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) in the *Amazon Neptune User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Type: String Required: No ** PreSignedUrl ** This parameter is not currently supported. Type: String Required: No ** ReplicationSourceIdentifier ** The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. Type: String Required: No ** ServerlessV2ScalingConfiguration ** Contains the scaling configuration of a Neptune Serverless DB cluster. For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*. Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object Required: No ** StorageEncrypted ** Specifies whether the DB cluster is encrypted. Type: Boolean Required: No ** StorageType ** The storage type for the new DB cluster. Valid Values: + ** `standard` **   –   ( *the default* ) Configures cost-effective database storage for applications with moderate to small I/O usage. When set to `standard`, the storage type is not returned in the response. + ** `iopt1` **   –   Enables [I/O-Optimized storage](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0. Type: String Required: No **Tags.Tag.N** The tags to assign to the new DB cluster. Type: Array of [Tag](API_Tag.md) objects Required: No **VpcSecurityGroupIds.VpcSecurityGroupId.N** A list of EC2 VPC security groups to associate with this DB cluster. Type: Array of strings Required: No ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterAlreadyExistsFault ** User already has a DB cluster with the given identifier. HTTP Status Code: 400 ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBClusterParameterGroupNotFound ** *DBClusterParameterGroupName* does not refer to an existing DB Cluster parameter group. HTTP Status Code: 404 ** DBClusterQuotaExceededFault ** User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. HTTP Status Code: 403 ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** DBSubnetGroupDoesNotCoverEnoughAZs ** Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. HTTP Status Code: 400 ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** GlobalClusterNotFoundFault ** The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster. HTTP Status Code: 404 ** InsufficientStorageClusterCapacity ** There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ** InvalidDBSubnetGroupStateFault ** The DB subnet group cannot be deleted because it is in use. HTTP Status Code: 400 ** InvalidGlobalClusterStateFault ** The global cluster is in an invalid state and can't perform the requested operation. HTTP Status Code: 400 ** InvalidSubnet ** The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** DB subnet group does not cover all Availability Zones after it is created because users' change. HTTP Status Code: 400 ** KMSKeyNotAccessibleFault ** Error accessing KMS key. HTTP Status Code: 400 ** StorageQuotaExceeded ** Request would result in user exceeding the allowed amount of storage available across all DB instances. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateDBCluster) # CreateDBClusterEndpoint Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterEndpointIdentifier ** The identifier to use for the new endpoint. This parameter is stored as a lowercase string. Type: String Required: Yes ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. Type: String Required: Yes ** EndpointType ** The type of the endpoint. One of: `READER`, `WRITER`, `ANY`. Type: String Required: Yes **ExcludedMembers.member.N** List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Type: Array of strings Required: No **StaticMembers.member.N** List of DB instance identifiers that are part of the custom endpoint group. Type: Array of strings Required: No **Tags.Tag.N** The tags to be assigned to the Amazon Neptune resource. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Elements The following elements are returned by the service. ** CustomEndpointType ** The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`. Type: String ** DBClusterEndpointArn ** The Amazon Resource Name (ARN) for the endpoint. Type: String ** DBClusterEndpointIdentifier ** The identifier associated with the endpoint. This parameter is stored as a lowercase string. Type: String ** DBClusterEndpointResourceIdentifier ** A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint. Type: String ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. Type: String ** Endpoint ** The DNS address of the endpoint. Type: String ** EndpointType ** The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`. Type: String **ExcludedMembers.member.N** List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Type: Array of strings **StaticMembers.member.N** List of DB instance identifiers that are part of the custom endpoint group. Type: Array of strings ** Status ** The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that cannot be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterEndpointAlreadyExistsFault ** The specified custom endpoint cannot be created because it already exists. HTTP Status Code: 400 ** DBClusterEndpointQuotaExceededFault ** The cluster already has the maximum number of custom endpoints. HTTP Status Code: 403 ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateDBClusterEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateDBClusterEndpoint) # CreateDBClusterParameterGroup Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md). Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using [ModifyDBCluster](API_ModifyDBCluster.md). When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. **Important** After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the `character_set_database` parameter. You can use the *Parameter Groups* option of the [Amazon Neptune console](https://console.aws.amazon.com/rds/) or the [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) command to verify that your DB cluster parameter group has been created or modified. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterParameterGroupName ** The name of the DB cluster parameter group. Constraints: + Must match the name of an existing DBClusterParameterGroup. This value is stored as a lowercase string. Type: String Required: Yes ** DBParameterGroupFamily ** The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Type: String Required: Yes ** Description ** The description for the DB cluster parameter group. Type: String Required: Yes **Tags.Tag.N** The tags to be assigned to the new DB cluster parameter group. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Elements The following element is returned by the service. ** DBClusterParameterGroup ** Contains the details of an Amazon Neptune DB cluster parameter group. This data type is used as a response element in the [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) action. Type: [DBClusterParameterGroup](API_DBClusterParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupAlreadyExists ** A DB parameter group with the same name exists. HTTP Status Code: 400 ** DBParameterGroupQuotaExceeded ** Request would result in user exceeding the allowed number of DB parameter groups. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateDBClusterParameterGroup) # CreateDBClusterSnapshot Creates a snapshot of a DB cluster. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. Constraints: + Must match the identifier of an existing DBCluster. Example: `my-cluster1` Type: String Required: Yes ** DBClusterSnapshotIdentifier ** The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + First character must be a letter. + Cannot end with a hyphen or contain two consecutive hyphens. Example: `my-cluster1-snapshot1` Type: String Required: Yes **Tags.Tag.N** The tags to be assigned to the DB cluster snapshot. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Elements The following element is returned by the service. ** DBClusterSnapshot ** Contains the details for an Amazon Neptune DB cluster snapshot This data type is used as a response element in the [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) action. Type: [DBClusterSnapshot](API_DBClusterSnapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBClusterSnapshotAlreadyExistsFault ** User already has a DB cluster snapshot with the given identifier. HTTP Status Code: 400 ** InvalidDBClusterSnapshotStateFault ** The supplied value is not a valid DB cluster snapshot state. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** SnapshotQuotaExceeded ** Request would result in user exceeding the allowed number of DB snapshots. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateDBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateDBClusterSnapshot) # CreateDBInstance Creates a new DB instance. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** AllocatedStorage ** Not supported by Neptune. Type: Integer Required: No ** AutoMinorVersionUpgrade ** Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window. Default: `true` Type: Boolean Required: No ** AvailabilityZone ** The EC2 Availability Zone that the DB instance is created in Default: A random, system-chosen Availability Zone in the endpoint's Amazon Region. Example: `us-east-1d` Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to `true`. The specified Availability Zone must be in the same Amazon Region as the current endpoint. Type: String Required: No ** BackupRetentionPeriod ** The number of days for which automated backups are retained. Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see [CreateDBCluster](API_CreateDBCluster.md). Default: 1 Constraints: + Must be a value from 0 to 35 + Cannot be set to 0 if the DB instance is a source to Read Replicas Type: Integer Required: No ** CharacterSetName ** *(Not supported by Neptune)* Type: String Required: No ** CopyTagsToSnapshot ** True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. Type: Boolean Required: No ** DBClusterIdentifier ** The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see [CreateDBCluster](API_CreateDBCluster.md). Type: String Type: String Required: Yes ** DBInstanceClass ** The compute and memory capacity of the DB instance, for example, `db.m4.large`. Not all DB instance classes are available in all Amazon Regions. Type: String Required: Yes ** DBInstanceIdentifier ** The DB instance identifier. This parameter is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + First character must be a letter. + Cannot end with a hyphen or contain two consecutive hyphens. Example: `mydbinstance` Type: String Required: Yes ** DBName ** Not supported. Type: String Required: No ** DBParameterGroupName ** The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used. Constraints: + Must be 1 to 255 letters, numbers, or hyphens. + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens Type: String Required: No **DBSecurityGroups.DBSecurityGroupName.N** A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. Type: Array of strings Required: No ** DBSubnetGroupName ** A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance. Type: String Required: No ** DeletionProtection ** A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See [Deleting a DB Instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster. Type: Boolean Required: No ** Domain ** Specify the Active Directory Domain to create the instance in. Type: String Required: No ** DomainIAMRoleName ** Specify the name of the IAM role to be used when making API calls to the Directory Service. Type: String Required: No **EnableCloudwatchLogsExports.member.N** The list of log types that need to be enabled for exporting to CloudWatch Logs. Type: Array of strings Required: No ** EnableIAMDatabaseAuthentication ** Not supported by Neptune (ignored). Type: Boolean Required: No ** EnablePerformanceInsights ** *(Not supported by Neptune)* Type: Boolean Required: No ** Engine ** The name of the database engine to be used for this instance. Valid Values: `neptune` Type: String Required: Yes ** EngineVersion ** The version number of the database engine to use. Currently, setting this parameter has no effect. Type: String Required: No ** Iops ** The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Type: Integer Required: No ** KmsKeyId ** The Amazon KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same Amazon account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key. Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see [CreateDBCluster](API_CreateDBCluster.md). If the `StorageEncrypted` parameter is true, and you do not specify a value for the `KmsKeyId` parameter, then Amazon Neptune will use your default encryption key. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region. Type: String Required: No ** LicenseModel ** License model information for this DB instance. Valid values: `license-included` \$1 `bring-your-own-license` \$1 `general-public-license` Type: String Required: No ** MasterUsername ** Not supported by Neptune. Type: String Required: No ** MasterUserPassword ** Not supported by Neptune. Type: String Required: No ** MonitoringInterval ** The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If `MonitoringRoleArn` is specified, then you must also set `MonitoringInterval` to a value other than 0. Valid Values: `0, 1, 5, 10, 15, 30, 60` Type: Integer Required: No ** MonitoringRoleArn ** The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. If `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value. Type: String Required: No ** MultiAZ ** Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Type: Boolean Required: No ** OptionGroupName ** *(Not supported by Neptune)* Type: String Required: No ** PerformanceInsightsKMSKeyId ** *(Not supported by Neptune)* Type: String Required: No ** Port ** The port number on which the database accepts connections. Not applicable. The port is managed by the DB cluster. For more information, see [CreateDBCluster](API_CreateDBCluster.md). Default: `8182` Type: Integer Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created. Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see [CreateDBCluster](API_CreateDBCluster.md). Type: String Required: No ** PreferredMaintenanceWindow ** The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: `ddd:hh24:mi-ddd:hh24:mi` The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Type: String Required: No ** PromotionTier ** A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid Values: 0 - 15 Type: Integer Required: No ** PubliclyAccessible ** Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. Type: Boolean Required: No ** StorageEncrypted ** Specifies whether the DB instance is encrypted. Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see [CreateDBCluster](API_CreateDBCluster.md). Default: false Type: Boolean Required: No ** StorageType ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: String Required: No **Tags.Tag.N** The tags to assign to the new instance. Type: Array of [Tag](API_Tag.md) objects Required: No ** TdeCredentialArn ** The ARN from the key store with which to associate the instance for TDE encryption. Type: String Required: No ** TdeCredentialPassword ** The password for the given ARN from the key store in order to access the device. Type: String Required: No ** Timezone ** The time zone of the DB instance. Type: String Required: No **VpcSecurityGroupIds.VpcSecurityGroupId.N** A list of EC2 VPC security groups to associate with this DB instance. Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see [CreateDBCluster](API_CreateDBCluster.md). Default: The default EC2 VPC security group for the DB subnet group's VPC. Type: Array of strings Required: No ## Response Elements The following element is returned by the service. ** DBInstance ** Contains the details of an Amazon Neptune DB instance. This data type is used as a response element in the [DescribeDBInstances](API_DescribeDBInstances.md) action. Type: [DBInstance](API_DBInstance.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AuthorizationNotFound ** Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. Neptune may not also be authorized via IAM to perform necessary actions on your behalf. HTTP Status Code: 404 ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBInstanceAlreadyExists ** User already has a DB instance with the given identifier. HTTP Status Code: 400 ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** DBSecurityGroupNotFound ** *DBSecurityGroupName* does not refer to an existing DB security group. HTTP Status Code: 404 ** DBSubnetGroupDoesNotCoverEnoughAZs ** Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. HTTP Status Code: 400 ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** DomainNotFoundFault ** *Domain* does not refer to an existing Active Directory Domain. HTTP Status Code: 404 ** InstanceQuotaExceeded ** Request would result in user exceeding the allowed number of DB instances. HTTP Status Code: 400 ** InsufficientDBInstanceCapacity ** Specified DB instance class is not available in the specified Availability Zone. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidSubnet ** The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** DB subnet group does not cover all Availability Zones after it is created because users' change. HTTP Status Code: 400 ** KMSKeyNotAccessibleFault ** Error accessing KMS key. HTTP Status Code: 400 ** OptionGroupNotFoundFault ** The designated option group could not be found. HTTP Status Code: 404 ** ProvisionedIopsNotAvailableInAZFault ** Provisioned IOPS not available in the specified Availability Zone. HTTP Status Code: 400 ** StorageQuotaExceeded ** Request would result in user exceeding the allowed amount of storage available across all DB instances. HTTP Status Code: 400 ** StorageTypeNotSupported ** *StorageType* specified cannot be associated with the DB Instance. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateDBInstance) # CreateDBParameterGroup Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using *ModifyDBParameterGroup*. Once you've created a DB parameter group, you need to associate it with your DB instance using *ModifyDBInstance*. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. **Important** After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the `character_set_database` parameter. You can use the *Parameter Groups* option of the Amazon Neptune console or the *DescribeDBParameters* command to verify that your DB parameter group has been created or modified. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupFamily ** The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. Type: String Required: Yes ** DBParameterGroupName ** The name of the DB parameter group. Constraints: + Must be 1 to 255 letters, numbers, or hyphens. + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. Type: String Required: Yes ** Description ** The description for the DB parameter group. Type: String Required: Yes **Tags.Tag.N** The tags to be assigned to the new DB parameter group. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Elements The following element is returned by the service. ** DBParameterGroup ** Contains the details of an Amazon Neptune DB parameter group. This data type is used as a response element in the [DescribeDBParameterGroups](API_DescribeDBParameterGroups.md) action. Type: [DBParameterGroup](API_DBParameterGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupAlreadyExists ** A DB parameter group with the same name exists. HTTP Status Code: 400 ** DBParameterGroupQuotaExceeded ** Request would result in user exceeding the allowed number of DB parameter groups. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateDBParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateDBParameterGroup) # CreateDBSubnetGroup Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBSubnetGroupDescription ** The description for the DB subnet group. Type: String Required: Yes ** DBSubnetGroupName ** The name for the DB subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default. Example: `mySubnetgroup` Type: String Required: Yes **SubnetIds.SubnetIdentifier.N** The EC2 Subnet IDs for the DB subnet group. Type: Array of strings Required: Yes **Tags.Tag.N** The tags to be assigned to the new DB subnet group. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Elements The following element is returned by the service. ** DBSubnetGroup ** Contains the details of an Amazon Neptune DB subnet group. This data type is used as a response element in the [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) action. Type: [DBSubnetGroup](API_DBSubnetGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBSubnetGroupAlreadyExists ** *DBSubnetGroupName* is already used by an existing DB subnet group. HTTP Status Code: 400 ** DBSubnetGroupDoesNotCoverEnoughAZs ** Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. HTTP Status Code: 400 ** DBSubnetGroupQuotaExceeded ** Request would result in user exceeding the allowed number of DB subnet groups. HTTP Status Code: 400 ** DBSubnetQuotaExceededFault ** Request would result in user exceeding the allowed number of subnets in a DB subnet groups. HTTP Status Code: 400 ** InvalidSubnet ** The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateDBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateDBSubnetGroup) # CreateEventSubscription Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** Enabled ** A Boolean value; set to **true** to activate the subscription, set to **false** to create the subscription but not active it. Type: Boolean Required: No **EventCategories.EventCategory.N** A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the **DescribeEventCategories** action. Type: Array of strings Required: No ** SnsTopicArn ** The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. Type: String Required: Yes **SourceIds.SourceId.N** The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. Constraints: + If SourceIds are supplied, SourceType must also be provided. + If the source type is a DB instance, then a `DBInstanceIdentifier` must be supplied. + If the source type is a DB security group, a `DBSecurityGroupName` must be supplied. + If the source type is a DB parameter group, a `DBParameterGroupName` must be supplied. + If the source type is a DB snapshot, a `DBSnapshotIdentifier` must be supplied. Type: Array of strings Required: No ** SourceType ** The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: `db-instance` \$1 `db-cluster` \$1 `db-parameter-group` \$1 `db-security-group` \$1 `db-snapshot` \$1 `db-cluster-snapshot` Type: String Required: No ** SubscriptionName ** The name of the subscription. Constraints: The name must be less than 255 characters. Type: String Required: Yes **Tags.Tag.N** The tags to be applied to the new event subscription. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Elements The following element is returned by the service. ** EventSubscription ** Contains the results of a successful invocation of the [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) action. Type: [EventSubscription](API_EventSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** EventSubscriptionQuotaExceeded ** You have exceeded the number of events you can subscribe to. HTTP Status Code: 400 ** SNSInvalidTopic ** The SNS topic is invalid. HTTP Status Code: 400 ** SNSNoAuthorization ** There is no SNS authorization. HTTP Status Code: 400 ** SNSTopicArnNotFound ** The ARN of the SNS topic could not be found. HTTP Status Code: 404 ** SourceNotFound ** The source could not be found. HTTP Status Code: 404 ** SubscriptionAlreadyExist ** This subscription already exists. HTTP Status Code: 400 ** SubscriptionCategoryNotFound ** The designated subscription category could not be found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateEventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateEventSubscription) # CreateGlobalCluster Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DeletionProtection ** The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled. Type: Boolean Required: No ** Engine ** The name of the database engine to be used in the global database. Valid values: `neptune` Type: String Required: No ** EngineVersion ** The Neptune engine version to be used by the global database. Valid values: `1.2.0.0` or above. Type: String Required: No ** GlobalClusterIdentifier ** The cluster identifier of the new global database cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: Yes ** SourceDBClusterIdentifier ** (*Optional*) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database. Type: String Required: No ** StorageEncrypted ** The storage encryption setting for the new global database cluster. Type: Boolean Required: No ## Response Elements The following element is returned by the service. ** GlobalCluster ** Contains the details of an Amazon Neptune global database. This data type is used as a response element for the [CreateGlobalCluster](#API_CreateGlobalCluster), [DescribeGlobalClusters](API_DescribeGlobalClusters.md), [ModifyGlobalCluster](API_ModifyGlobalCluster.md), [DeleteGlobalCluster](API_DeleteGlobalCluster.md), [FailoverGlobalCluster](API_FailoverGlobalCluster.md), and [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) actions. Type: [GlobalCluster](API_GlobalCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** GlobalClusterAlreadyExistsFault ** The `GlobalClusterIdentifier` already exists. Choose a new global database identifier (unique name) to create a new global database cluster. HTTP Status Code: 400 ** GlobalClusterQuotaExceededFault ** The number of global database clusters for this account is already at the maximum allowed. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/CreateGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CreateGlobalCluster) # DeleteDBCluster The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its `DeletionProtection` field to `False`. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: + Must match an existing DBClusterIdentifier. Type: String Required: Yes ** FinalDBSnapshotIdentifier ** The DB cluster snapshot identifier of the new DB cluster snapshot created when `SkipFinalSnapshot` is set to `false`. Specifying this parameter and also setting the `SkipFinalShapshot` parameter to true results in an error. Constraints: + Must be 1 to 255 letters, numbers, or hyphens. + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens Type: String Required: No ** SkipFinalSnapshot ** Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If `true` is specified, no DB cluster snapshot is created. If `false` is specified, a DB cluster snapshot is created before the DB cluster is deleted. You must specify a `FinalDBSnapshotIdentifier` parameter if `SkipFinalSnapshot` is `false`. Default: `false` Type: Boolean Required: No ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBClusterSnapshotAlreadyExistsFault ** User already has a DB cluster snapshot with the given identifier. HTTP Status Code: 400 ** InvalidDBClusterSnapshotStateFault ** The supplied value is not a valid DB cluster snapshot state. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** SnapshotQuotaExceeded ** Request would result in user exceeding the allowed number of DB snapshots. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteDBCluster) # DeleteDBClusterEndpoint Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterEndpointIdentifier ** The identifier associated with the custom endpoint. This parameter is stored as a lowercase string. Type: String Required: Yes ## Response Elements The following elements are returned by the service. ** CustomEndpointType ** The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`. Type: String ** DBClusterEndpointArn ** The Amazon Resource Name (ARN) for the endpoint. Type: String ** DBClusterEndpointIdentifier ** The identifier associated with the endpoint. This parameter is stored as a lowercase string. Type: String ** DBClusterEndpointResourceIdentifier ** A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint. Type: String ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. Type: String ** Endpoint ** The DNS address of the endpoint. Type: String ** EndpointType ** The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`. Type: String **ExcludedMembers.member.N** List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Type: Array of strings **StaticMembers.member.N** List of DB instance identifiers that are part of the custom endpoint group. Type: Array of strings ** Status ** The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that cannot be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterEndpointNotFoundFault ** The specified custom endpoint doesn't exist. HTTP Status Code: 400 ** InvalidDBClusterEndpointStateFault ** The requested operation cannot be performed on the endpoint while the endpoint is in this state. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteDBClusterEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteDBClusterEndpoint) # DeleteDBClusterParameterGroup Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterParameterGroupName ** The name of the DB cluster parameter group. Constraints: + Must be the name of an existing DB cluster parameter group. + You can't delete a default DB cluster parameter group. + Cannot be associated with any DB clusters. Type: String Required: Yes ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** InvalidDBParameterGroupState ** The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteDBClusterParameterGroup) # DeleteDBClusterSnapshot Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated. **Note** The DB cluster snapshot must be in the `available` state to be deleted. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterSnapshotIdentifier ** The identifier of the DB cluster snapshot to delete. Constraints: Must be the name of an existing DB cluster snapshot in the `available` state. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBClusterSnapshot ** Contains the details for an Amazon Neptune DB cluster snapshot This data type is used as a response element in the [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) action. Type: [DBClusterSnapshot](API_DBClusterSnapshot.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterSnapshotNotFoundFault ** *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot. HTTP Status Code: 404 ** InvalidDBClusterSnapshotStateFault ** The supplied value is not a valid DB cluster snapshot state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteDBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteDBClusterSnapshot) # DeleteDBInstance The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by `DeleteDBInstance` are not deleted. If you request a final DB snapshot the status of the Amazon Neptune DB instance is `deleting` until the DB snapshot is created. The API action `DescribeDBInstance` is used to monitor the status of this operation. The action can't be canceled or reverted once submitted. Note that when a DB instance is in a failure state and has a status of `failed`, `incompatible-restore`, or `incompatible-network`, you can only delete it when the `SkipFinalSnapshot` parameter is set to `true`. You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBInstanceIdentifier ** The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive. Constraints: + Must match the name of an existing DB instance. Type: String Required: Yes ** FinalDBSnapshotIdentifier ** The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to `false`. Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error. Constraints: + Must be 1 to 255 letters or numbers. + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens + Cannot be specified when deleting a Read Replica. Type: String Required: No ** SkipFinalSnapshot ** Determines whether a final DB snapshot is created before the DB instance is deleted. If `true` is specified, no DBSnapshot is created. If `false` is specified, a DB snapshot is created before the DB instance is deleted. Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true". Specify `true` when deleting a Read Replica. The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is `false`. Default: `false` Type: Boolean Required: No ## Response Elements The following element is returned by the service. ** DBInstance ** Contains the details of an Amazon Neptune DB instance. This data type is used as a response element in the [DescribeDBInstances](API_DescribeDBInstances.md) action. Type: [DBInstance](API_DBInstance.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** DBSnapshotAlreadyExists ** *DBSnapshotIdentifier* is already used by an existing snapshot. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ** SnapshotQuotaExceeded ** Request would result in user exceeding the allowed number of DB snapshots. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteDBInstance) # DeleteDBParameterGroup Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupName ** The name of the DB parameter group. Constraints: + Must be the name of an existing DB parameter group + You can't delete a default DB parameter group + Cannot be associated with any DB instances Type: String Required: Yes ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** InvalidDBParameterGroupState ** The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteDBParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteDBParameterGroup) # DeleteDBSubnetGroup Deletes a DB subnet group. **Note** The specified database subnet group must not be associated with any DB instances. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBSubnetGroupName ** The name of the database subnet group to delete. You can't delete the default subnet group. Constraints: Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: `mySubnetgroup` Type: String Required: Yes ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** InvalidDBSubnetGroupStateFault ** The DB subnet group cannot be deleted because it is in use. HTTP Status Code: 400 ** InvalidDBSubnetStateFault ** The DB subnet is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteDBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteDBSubnetGroup) # DeleteEventSubscription Deletes an event notification subscription. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** SubscriptionName ** The name of the event notification subscription you want to delete. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** EventSubscription ** Contains the results of a successful invocation of the [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) action. Type: [EventSubscription](API_EventSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidEventSubscriptionState ** The event subscription is in an invalid state. HTTP Status Code: 400 ** SubscriptionNotFound ** The designated subscription could not be found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteEventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteEventSubscription) # DeleteGlobalCluster Deletes a global database. The primary and all secondary clusters must already be detached or deleted first. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** GlobalClusterIdentifier ** The cluster identifier of the global database cluster being deleted. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: Yes ## Response Elements The following element is returned by the service. ** GlobalCluster ** Contains the details of an Amazon Neptune global database. This data type is used as a response element for the [CreateGlobalCluster](API_CreateGlobalCluster.md), [DescribeGlobalClusters](API_DescribeGlobalClusters.md), [ModifyGlobalCluster](API_ModifyGlobalCluster.md), [DeleteGlobalCluster](#API_DeleteGlobalCluster), [FailoverGlobalCluster](API_FailoverGlobalCluster.md), and [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) actions. Type: [GlobalCluster](API_GlobalCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** GlobalClusterNotFoundFault ** The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster. HTTP Status Code: 404 ** InvalidGlobalClusterStateFault ** The global cluster is in an invalid state and can't perform the requested operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DeleteGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DeleteGlobalCluster) # DescribeDBClusterEndpoints Returns information about endpoints for an Amazon Neptune DB cluster. **Note** This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterEndpointIdentifier ** The identifier of the endpoint to describe. This parameter is stored as a lowercase string. Type: String Required: No ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. Type: String Required: No **Filters.Filter.N** A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format `Name=endpoint_type,Values=endpoint_type1,endpoint_type2,...`. `Name` can be one of: `db-cluster-endpoint-type`, `db-cluster-endpoint-custom-type`, `db-cluster-endpoint-id`, `db-cluster-endpoint-status`. `Values` for the ` db-cluster-endpoint-type` filter can be one or more of: `reader`, `writer`, `custom`. `Values` for the `db-cluster-endpoint-custom-type` filter can be one or more of: `reader`, `any`. `Values` for the `db-cluster-endpoint-status` filter can be one or more of: `available`, `creating`, `deleting`, `inactive`, `modifying`. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeDBClusterEndpoints` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **DBClusterEndpoints.DBClusterEndpointList.N** Contains the details of the endpoints associated with the cluster and matching any filter conditions. Type: Array of [DBClusterEndpoint](API_DBClusterEndpoint.md) objects ** Marker ** n optional pagination token provided by a previous `DescribeDBClusterEndpoints` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBClusterEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBClusterEndpoints) # DescribeDBClusterParameterGroups Returns a list of `DBClusterParameterGroup` descriptions. If a `DBClusterParameterGroupName` parameter is specified, the list will contain only the description of the specified DB cluster parameter group. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterParameterGroupName ** The name of a specific DB cluster parameter group to return details for. Constraints: + If supplied, must match the name of an existing DBClusterParameterGroup. Type: String Required: No **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeDBClusterParameterGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **DBClusterParameterGroups.DBClusterParameterGroup.N** A list of DB cluster parameter groups. Type: Array of [DBClusterParameterGroup](API_DBClusterParameterGroup.md) objects ** Marker ** An optional pagination token provided by a previous `DescribeDBClusterParameterGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBClusterParameterGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBClusterParameterGroups) # DescribeDBClusterParameters Returns the detailed parameter list for a particular DB cluster parameter group. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterParameterGroupName ** The name of a specific DB cluster parameter group to return parameter details for. Constraints: + If supplied, must match the name of an existing DBClusterParameterGroup. Type: String Required: Yes **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeDBClusterParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ** Source ** A value that indicates to return only parameters for a specific source. Parameter sources can be `engine`, `service`, or `customer`. Type: String Required: No ## Response Elements The following elements are returned by the service. ** Marker ** An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` . Type: String **Parameters.Parameter.N** Provides a list of parameters for the DB cluster parameter group. Type: Array of [Parameter](API_Parameter.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBClusterParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBClusterParameters) # DescribeDBClusters Returns information about provisioned DB clusters, and supports pagination. **Note** This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: + If supplied, must match an existing DBClusterIdentifier. Type: String Required: No **Filters.Filter.N** A filter that specifies one or more DB clusters to describe. Supported filters: + `db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. + `engine` - Accepts an engine name (such as `neptune`), and restricts the results list to DB clusters created by that engine. For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command: Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous [DescribeDBClusters](#API_DescribeDBClusters) request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **DBClusters.DBCluster.N** Contains a list of DB clusters for the user. Type: Array of [DBCluster](API_DBCluster.md) objects ** Marker ** A pagination token that can be used in a subsequent DescribeDBClusters request. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBClusters) # DescribeDBClusterSnapshotAttributes Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon accounts, `DescribeDBClusterSnapshotAttributes` returns the `restore` attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If `all` is included in the list of values for the `restore` attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon accounts. To add or remove access for an Amazon account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterSnapshotIdentifier ** The identifier for the DB cluster snapshot to describe the attributes for. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBClusterSnapshotAttributesResult ** Contains the results of a successful call to the [DescribeDBClusterSnapshotAttributes](#API_DescribeDBClusterSnapshotAttributes) API action. Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action. Type: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterSnapshotNotFoundFault ** *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBClusterSnapshotAttributes) # DescribeDBClusterSnapshots Returns information about DB cluster snapshots. This API action supports pagination. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the `DBClusterSnapshotIdentifier` parameter. This parameter is not case-sensitive. Constraints: + If supplied, must match the identifier of an existing DBCluster. Type: String Required: No ** DBClusterSnapshotIdentifier ** A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the `DBClusterIdentifier` parameter. This value is stored as a lowercase string. Constraints: + If supplied, must match the identifier of an existing DBClusterSnapshot. + If this identifier is for an automated snapshot, the `SnapshotType` parameter must also be specified. Type: String Required: No **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** IncludePublic ** True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is `false`. The default is false. You can share a manual DB cluster snapshot as public by using the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action. Type: Boolean Required: No ** IncludeShared ** True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is `false`. You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action. Type: Boolean Required: No ** Marker ** An optional pagination token provided by a previous `DescribeDBClusterSnapshots` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ** SnapshotType ** The type of DB cluster snapshots to be returned. You can specify one of the following values: + `automated` - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account. + `manual` - Return all DB cluster snapshots that have been taken by my Amazon account. + `shared` - Return all manual DB cluster snapshots that have been shared to my Amazon account. + `public` - Return all DB cluster snapshots that have been marked as public. If you don't specify a `SnapshotType` value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the `IncludeShared` parameter to `true`. You can include public DB cluster snapshots with these results by setting the `IncludePublic` parameter to `true`. The `IncludeShared` and `IncludePublic` parameters don't apply for `SnapshotType` values of `manual` or `automated`. The `IncludePublic` parameter doesn't apply when `SnapshotType` is set to `shared`. The `IncludeShared` parameter doesn't apply when `SnapshotType` is set to `public`. Type: String Required: No ## Response Elements The following elements are returned by the service. **DBClusterSnapshots.DBClusterSnapshot.N** Provides a list of DB cluster snapshots for the user. Type: Array of [DBClusterSnapshot](API_DBClusterSnapshot.md) objects ** Marker ** An optional pagination token provided by a previous [DescribeDBClusterSnapshots](#API_DescribeDBClusterSnapshots) request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterSnapshotNotFoundFault ** *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBClusterSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBClusterSnapshots) # DescribeDBEngineVersions Returns a list of the available DB engines. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupFamily ** The name of a specific DB parameter group family to return details for. Constraints: + If supplied, must match an existing DBParameterGroupFamily. Type: String Required: No ** DefaultOnly ** Indicates that only the default version of the specified engine or engine and major version combination is returned. Type: Boolean Required: No ** Engine ** The database engine to return. Type: String Required: No ** EngineVersion ** The database engine version to return. Example: `5.1.49` Type: String Required: No **Filters.Filter.N** Not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** ListSupportedCharacterSets ** 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. Type: Boolean Required: No ** ListSupportedTimezones ** 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. Type: Boolean Required: No ** Marker ** 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`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **DBEngineVersions.DBEngineVersion.N** A list of `DBEngineVersion` elements. Type: Array of [DBEngineVersion](API_DBEngineVersion.md) objects ** Marker ** 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`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBEngineVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBEngineVersions) # DescribeDBInstances Returns information about provisioned instances, and supports pagination. **Note** This operation can also return information for Amazon RDS instances and Amazon DocDB instances. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBInstanceIdentifier ** The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: + If supplied, must match the identifier of an existing DBInstance. Type: String Required: No **Filters.Filter.N** A filter that specifies one or more DB instances to describe. Supported filters: + `db-cluster-id` - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs. + `engine` - Accepts an engine name (such as `neptune`), and restricts the results list to DB instances created by that engine. For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB instances are returned, you could use the following command: Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeDBInstances` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **DBInstances.DBInstance.N** A list of [DBInstance](API_DBInstance.md) instances. Type: Array of [DBInstance](API_DBInstance.md) objects ** Marker ** 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` . Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBInstances) # DescribeDBParameterGroups Returns a list of `DBParameterGroup` descriptions. If a `DBParameterGroupName` is specified, the list will contain only the description of the specified DB parameter group. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupName ** The name of a specific DB parameter group to return details for. Constraints: + If supplied, must match the name of an existing DBClusterParameterGroup. Type: String Required: No **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeDBParameterGroups` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **DBParameterGroups.DBParameterGroup.N** A list of [DBParameterGroup](API_DBParameterGroup.md) instances. Type: Array of [DBParameterGroup](API_DBParameterGroup.md) objects ** Marker ** 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`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBParameterGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBParameterGroups) # DescribeDBParameters Returns the detailed parameter list for a particular DB parameter group. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupName ** The name of a specific DB parameter group to return details for. Constraints: + If supplied, must match the name of an existing DBParameterGroup. Type: String Required: Yes **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeDBParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ** Source ** The parameter types to return. Default: All parameter types returned Valid Values: `user | system | engine-default` Type: String Required: No ## Response Elements The following elements are returned by the service. ** Marker ** 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`. Type: String **Parameters.Parameter.N** A list of [Parameter](API_Parameter.md) values. Type: Array of [Parameter](API_Parameter.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBParameters) # DescribeDBSubnetGroups Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBSubnetGroupName ** The name of the DB subnet group to return details for. Type: String Required: No **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **DBSubnetGroups.DBSubnetGroup.N** A list of [DBSubnetGroup](API_DBSubnetGroup.md) instances. Type: Array of [DBSubnetGroup](API_DBSubnetGroup.md) objects ** Marker ** 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`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeDBSubnetGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeDBSubnetGroups) # DescribeEngineDefaultClusterParameters Returns the default engine and system parameter information for the cluster database engine. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupFamily ** The name of the DB cluster parameter group family to return engine parameter information for. Type: String Required: Yes **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeEngineDefaultClusterParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following element is returned by the service. ** EngineDefaults ** Contains the result of a successful invocation of the [DescribeEngineDefaultParameters](API_DescribeEngineDefaultParameters.md) action. Type: [EngineDefaults](API_EngineDefaults.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeEngineDefaultClusterParameters) # DescribeEngineDefaultParameters Returns the default engine and system parameter information for the specified database engine. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupFamily ** The name of the DB parameter group family. Type: String Required: Yes **Filters.Filter.N** Not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous `DescribeEngineDefaultParameters` request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ## Response Elements The following element is returned by the service. ** EngineDefaults ** Contains the result of a successful invocation of the [DescribeEngineDefaultParameters](#API_DescribeEngineDefaultParameters) action. Type: [EngineDefaults](API_EngineDefaults.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeEngineDefaultParameters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeEngineDefaultParameters) # DescribeEventCategories Displays a list of categories for all event source types, or, if specified, for a specified source type. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** SourceType ** The type of source that is generating the events. Valid values: db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot Type: String Required: No ## Response Elements The following element is returned by the service. **EventCategoriesMapList.EventCategoriesMap.N** A list of EventCategoriesMap data types. Type: Array of [EventCategoriesMap](API_EventCategoriesMap.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeEventCategories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeEventCategories) # DescribeEvents Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** Duration ** The number of minutes to retrieve events for. Default: 60 Type: Integer Required: No ** EndTime ** The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.](http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z Type: Timestamp Required: No **EventCategories.EventCategory.N** A list of event categories that trigger notifications for a event notification subscription. Type: Array of strings Required: No **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ** SourceIdentifier ** The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: + If SourceIdentifier is supplied, SourceType must also be provided. + If the source type is `DBInstance`, then a `DBInstanceIdentifier` must be supplied. + If the source type is `DBSecurityGroup`, a `DBSecurityGroupName` must be supplied. + If the source type is `DBParameterGroup`, a `DBParameterGroupName` must be supplied. + If the source type is `DBSnapshot`, a `DBSnapshotIdentifier` must be supplied. + Cannot end with a hyphen or contain two consecutive hyphens. Type: String Required: No ** SourceType ** The event source to retrieve events for. If no value is specified, all events are returned. Type: String Valid Values: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot` Required: No ** StartTime ** The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the [ISO8601 Wikipedia page.](http://en.wikipedia.org/wiki/ISO_8601) Example: 2009-07-08T18:00Z Type: Timestamp Required: No ## Response Elements The following elements are returned by the service. **Events.Event.N** A list of [Event](API_Event.md) instances. Type: Array of [Event](API_Event.md) objects ** Marker ** An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` . Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeEvents) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeEvents) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeEvents) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeEvents) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeEvents) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeEvents) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeEvents) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeEvents) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeEvents) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeEvents) # DescribeEventSubscriptions Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status. If you specify a SubscriptionName, lists the description for that subscription. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` . Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ** SubscriptionName ** The name of the event notification subscription you want to describe. Type: String Required: No ## Response Elements The following elements are returned by the service. **EventSubscriptionsList.EventSubscription.N** A list of EventSubscriptions data types. Type: Array of [EventSubscription](API_EventSubscription.md) objects ** Marker ** An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** SubscriptionNotFound ** The designated subscription could not be found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeEventSubscriptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeEventSubscriptions) # DescribeGlobalClusters Returns information about Neptune global database clusters. This API supports pagination. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** GlobalClusterIdentifier ** The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive. Constraints: If supplied, must match an existing DB cluster identifier. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ** Marker ** (*Optional*) A pagination token returned by a previous call to `DescribeGlobalClusters`. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by `MaxRecords`. Type: String Required: No ** MaxRecords ** The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a pagination marker token is included in the response that you can use to retrieve the remaining results. Default: `100` Constraints: Minimum 20, maximum 100. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **GlobalClusters.GlobalClusterMember.N** The list of global clusters and instances returned by this request. Type: Array of [GlobalCluster](API_GlobalCluster.md) objects ** Marker ** A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to `DescribeGlobalClusters`. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** GlobalClusterNotFoundFault ** The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeGlobalClusters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeGlobalClusters) # DescribeOrderableDBInstanceOptions Returns a list of orderable DB instance options for the specified engine. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBInstanceClass ** The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. Type: String Required: No ** Engine ** The name of the engine to retrieve DB instance options for. Type: String Required: Yes ** EngineVersion ** The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. Type: String Required: No **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** LicenseModel ** The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. Type: String Required: No ** Marker ** An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` . Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ** Vpc ** The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. ** Marker ** An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` . Type: String **OrderableDBInstanceOptions.OrderableDBInstanceOption.N** An [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) structure containing information about orderable options for the DB instance. Type: Array of [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeOrderableDBInstanceOptions) # DescribePendingMaintenanceActions Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). **Filters.Filter.N** 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. Type: Array of [Filter](API_Filter.md) objects Required: No ** Marker ** 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`. Type: String Required: No ** MaxRecords ** 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. Type: Integer Required: No ** ResourceIdentifier ** The ARN of a resource to return pending maintenance actions for. Type: String Required: No ## Response Elements The following elements are returned by the service. ** Marker ** 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`. Type: String **PendingMaintenanceActions.ResourcePendingMaintenanceActions.N** A list of the pending maintenance actions for the resource. Type: Array of [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundFault ** The specified resource ID was not found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribePendingMaintenanceActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribePendingMaintenanceActions) # DescribeValidDBInstanceModifications You can call [DescribeValidDBInstanceModifications](#API_DescribeValidDBInstanceModifications) to learn what modifications you can make to your DB instance. You can use this information when you call [ModifyDBInstance](API_ModifyDBInstance.md). ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBInstanceIdentifier ** The customer identifier or the ARN of your DB instance. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** ValidDBInstanceModificationsMessage ** Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the [DescribeValidDBInstanceModifications](#API_DescribeValidDBInstanceModifications) action. You can use this information when you call [ModifyDBInstance](API_ModifyDBInstance.md). Type: [ValidDBInstanceModificationsMessage](API_ValidDBInstanceModificationsMessage.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/DescribeValidDBInstanceModifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DescribeValidDBInstanceModifications) # FailoverDBCluster Forces a failover for a DB cluster. A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer). Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** A DB cluster identifier to force a failover for. This parameter is not case-sensitive. Constraints: + Must match the identifier of an existing DBCluster. Type: String Required: No ** TargetDBInstanceIdentifier ** The name of the instance to promote to the primary instance. You must specify the instance identifier for an Read Replica in the DB cluster. For example, `mydbcluster-replica1`. Type: String Required: No ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/FailoverDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/FailoverDBCluster) # FailoverGlobalCluster Initiates the failover process for a Neptune global database. A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database. **Note** This action applies **only** to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** AllowDataLoss ** Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation. If you don't specify `AllowDataLoss`, the global database cluster operation defaults to a switchover. Constraints:Can't be specified together with the `Switchover` parameter. Type: Boolean Required: No ** GlobalClusterIdentifier ** Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over. Constraints: Must match the identifier of an existing Neptune global database. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: Yes ** Switchover ** Specifies whether to switch over this global database cluster. Constraints:Can't be specified together with the `AllowDataLoss` parameter. Type: Boolean Required: No ** TargetDbClusterIdentifier ** The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** GlobalCluster ** Contains the details of an Amazon Neptune global database. This data type is used as a response element for the [CreateGlobalCluster](API_CreateGlobalCluster.md), [DescribeGlobalClusters](API_DescribeGlobalClusters.md), [ModifyGlobalCluster](API_ModifyGlobalCluster.md), [DeleteGlobalCluster](API_DeleteGlobalCluster.md), [FailoverGlobalCluster](#API_FailoverGlobalCluster), and [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) actions. Type: [GlobalCluster](API_GlobalCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** GlobalClusterNotFoundFault ** The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidGlobalClusterStateFault ** The global cluster is in an invalid state and can't perform the requested operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/FailoverGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/FailoverGlobalCluster) # ListTagsForResource Lists all tags on an Amazon Neptune resource. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). **Filters.Filter.N** This parameter is not currently supported. Type: Array of [Filter](API_Filter.md) objects Required: No ** ResourceName ** 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)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). Type: String Required: Yes ## Response Elements The following element is returned by the service. **TagList.Tag.N** List of tags returned by the ListTagsForResource operation. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** DBSnapshotNotFound ** *DBSnapshotIdentifier* does not refer to an existing DB snapshot. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ListTagsForResource) # ModifyDBCluster Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** AllowMajorVersionUpgrade ** A value that indicates whether upgrades between different major versions are allowed. Constraints: You must set the allow-major-version-upgrade flag when providing an `EngineVersion` parameter that uses a different major version than the DB cluster's current version. Type: Boolean Required: No ** ApplyImmediately ** A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the DB cluster. If this parameter is set to `false`, changes to the DB cluster are applied during the next maintenance window. The `ApplyImmediately` parameter only affects `NewDBClusterIdentifier` values. If you set the `ApplyImmediately` parameter value to false, then changes to `NewDBClusterIdentifier` values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the `ApplyImmediately` parameter. Default: `false` Type: Boolean Required: No ** BackupRetentionPeriod ** The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: + Must be a value from 1 to 35 Type: Integer Required: No ** CloudwatchLogsExportConfiguration ** The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See [Using the CLI to publish Neptune audit logs to CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli). Type: [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) object Required: No ** CopyTagsToSnapshot ** *If set to `true`, tags are copied to any snapshot of the DB cluster that is created.* Type: Boolean Required: No ** DBClusterIdentifier ** The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: + Must match the identifier of an existing DBCluster. Type: String Required: Yes ** DBClusterParameterGroupName ** The name of the DB cluster parameter group to use for the DB cluster. Type: String Required: No ** DBInstanceParameterGroupName ** The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using `DBInstanceParameterGroupName`, parameter changes aren't applied during the next maintenance window but instead are applied immediately. Default: The existing name setting Constraints: + The DB parameter group must be in the same DB parameter group family as the target DB cluster version. + The `DBInstanceParameterGroupName` parameter is only valid in combination with the `AllowMajorVersionUpgrade` parameter. Type: String Required: No ** DeletionProtection ** A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. Type: Boolean Required: No ** EnableIAMDatabaseAuthentication ** True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: `false` Type: Boolean Required: No ** EngineVersion ** The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the `ApplyImmediately` parameter is set to true. For a list of valid engine versions, see [Engine Releases for Amazon Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html), or call [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md). Type: String Required: No ** MasterUserPassword ** Not supported by Neptune. Type: String Required: No ** NewDBClusterIdentifier ** The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens + The first character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens Example: `my-cluster2` Type: String Required: No ** OptionGroupName ** *Not supported by Neptune.* Type: String Required: No ** Port ** The port number on which the DB cluster accepts connections. Constraints: Value must be `1150-65535` Default: The same port as the original DB cluster. Type: Integer Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. Constraints: + Must be in the format `hh24:mi-hh24:mi`. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. Type: String Required: No ** PreferredMaintenanceWindow ** The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: `ddd:hh24:mi-ddd:hh24:mi` The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. Type: String Required: No ** ServerlessV2ScalingConfiguration ** Contains the scaling configuration of a Neptune Serverless DB cluster. For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*. Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object Required: No ** StorageType ** The storage type to associate with the DB cluster. Valid Values: + ** `standard` **   –   ( *the default* ) Configures cost-effective database storage for applications with moderate to small I/O usage. + ** `iopt1` **   –   Enables [I/O-Optimized storage](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0. Type: String Required: No **VpcSecurityGroupIds.VpcSecurityGroupId.N** A list of VPC security groups that the DB cluster will belong to. Type: Array of strings Required: No ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterAlreadyExistsFault ** User already has a DB cluster with the given identifier. HTTP Status Code: 400 ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBClusterParameterGroupNotFound ** *DBClusterParameterGroupName* does not refer to an existing DB Cluster parameter group. HTTP Status Code: 404 ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ** InvalidDBSecurityGroupState ** The state of the DB security group does not allow deletion. HTTP Status Code: 400 ** InvalidDBSubnetGroupStateFault ** The DB subnet group cannot be deleted because it is in use. HTTP Status Code: 400 ** InvalidSubnet ** The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** DB subnet group does not cover all Availability Zones after it is created because users' change. HTTP Status Code: 400 ** StorageQuotaExceeded ** Request would result in user exceeding the allowed amount of storage available across all DB instances. HTTP Status Code: 400 ** StorageTypeNotSupported ** *StorageType* specified cannot be associated with the DB Instance. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyDBCluster) # ModifyDBClusterEndpoint Modifies the properties of an endpoint in an Amazon Neptune DB cluster. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterEndpointIdentifier ** The identifier of the endpoint to modify. This parameter is stored as a lowercase string. Type: String Required: Yes ** EndpointType ** The type of the endpoint. One of: `READER`, `WRITER`, `ANY`. Type: String Required: No **ExcludedMembers.member.N** List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Type: Array of strings Required: No **StaticMembers.member.N** List of DB instance identifiers that are part of the custom endpoint group. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. ** CustomEndpointType ** The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`. Type: String ** DBClusterEndpointArn ** The Amazon Resource Name (ARN) for the endpoint. Type: String ** DBClusterEndpointIdentifier ** The identifier associated with the endpoint. This parameter is stored as a lowercase string. Type: String ** DBClusterEndpointResourceIdentifier ** A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint. Type: String ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. Type: String ** Endpoint ** The DNS address of the endpoint. Type: String ** EndpointType ** The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`. Type: String **ExcludedMembers.member.N** List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Type: Array of strings **StaticMembers.member.N** List of DB instance identifiers that are part of the custom endpoint group. Type: Array of strings ** Status ** The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that cannot be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterEndpointNotFoundFault ** The specified custom endpoint doesn't exist. HTTP Status Code: 400 ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** InvalidDBClusterEndpointStateFault ** The requested operation cannot be performed on the endpoint while the endpoint is in this state. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyDBClusterEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyDBClusterEndpoint) # ModifyDBClusterParameterGroup Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: `ParameterName`, `ParameterValue`, and `ApplyMethod`. A maximum of 20 parameters can be modified in a single request. **Note** Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect. **Important** After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the `character_set_database` parameter. You can use the *Parameter Groups* option of the Amazon Neptune console or the [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md) command to verify that your DB cluster parameter group has been created or modified. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterParameterGroupName ** The name of the DB cluster parameter group to modify. Type: String Required: Yes **Parameters.Parameter.N** A list of parameters in the DB cluster parameter group to modify. Type: Array of [Parameter](API_Parameter.md) objects Required: Yes ## Response Elements The following element is returned by the service. ** DBClusterParameterGroupName ** The name of the DB cluster parameter group. Constraints: + Must be 1 to 255 letters or numbers. + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** InvalidDBParameterGroupState ** The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyDBClusterParameterGroup) # ModifyDBClusterSnapshotAttribute Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon accounts, specify `restore` as the `AttributeName` and use the `ValuesToAdd` parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the value `all` to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add the `all` value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for the `ValuesToAdd` parameter. You can't use `all` as a value for that parameter in this case. To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) API action. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** AttributeName ** The name of the DB cluster snapshot attribute to modify. To manage authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this value to `restore`. Type: String Required: Yes ** DBClusterSnapshotIdentifier ** The identifier for the DB cluster snapshot to modify the attributes for. Type: String Required: Yes **ValuesToAdd.AttributeValue.N** A list of DB cluster snapshot attributes to add to the attribute specified by `AttributeName`. To authorize other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account IDs, or `all` to make the manual DB cluster snapshot restorable by any Amazon account. Do not add the `all` value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts. Type: Array of strings Required: No **ValuesToRemove.AttributeValue.N** A list of DB cluster snapshot attributes to remove from the attribute specified by `AttributeName`. To remove authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account identifiers, or `all` to remove authorization for any Amazon account to copy or restore the DB cluster snapshot. If you specify `all`, an Amazon account whose account ID is explicitly added to the `restore` attribute can still copy or restore a manual DB cluster snapshot. Type: Array of strings Required: No ## Response Elements The following element is returned by the service. ** DBClusterSnapshotAttributesResult ** Contains the results of a successful call to the [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) API action. Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the [ModifyDBClusterSnapshotAttribute](#API_ModifyDBClusterSnapshotAttribute) API action. Type: [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterSnapshotNotFoundFault ** *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot. HTTP Status Code: 404 ** InvalidDBClusterSnapshotStateFault ** The supplied value is not a valid DB cluster snapshot state. HTTP Status Code: 400 ** SharedSnapshotQuotaExceeded ** You have exceeded the maximum number of accounts that you can share a manual DB snapshot with. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyDBClusterSnapshotAttribute) # ModifyDBInstance Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call [DescribeValidDBInstanceModifications](API_DescribeValidDBInstanceModifications.md) before you call [ModifyDBInstance](#API_ModifyDBInstance). ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** AllocatedStorage ** Not supported by Neptune. Type: Integer Required: No ** AllowMajorVersionUpgrade ** Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Type: Boolean Required: No ** ApplyImmediately ** Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the DB instance. If this parameter is set to `false`, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to [RebootDBInstance](API_RebootDBInstance.md), or the next failure reboot. Default: `false` Type: Boolean Required: No ** AutoMinorVersionUpgrade ** Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to `true` during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version. Type: Boolean Required: No ** BackupRetentionPeriod ** Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see [ModifyDBCluster](API_ModifyDBCluster.md). Default: Uses existing setting Type: Integer Required: No ** CACertificateIdentifier ** Indicates the certificate that needs to be associated with the instance. Type: String Required: No ** CloudwatchLogsExportConfiguration ** The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster. Type: [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) object Required: No ** CopyTagsToSnapshot ** True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false. Type: Boolean Required: No ** DBInstanceClass ** The new compute and memory capacity of the DB instance, for example, `db.m4.large`. Not all DB instance classes are available in all Amazon Regions. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless `ApplyImmediately` is specified as `true` for this request. Default: Uses existing setting Type: String Required: No ** DBInstanceIdentifier ** The DB instance identifier. This value is stored as a lowercase string. Constraints: + Must match the identifier of an existing DBInstance. Type: String Required: Yes ** DBParameterGroupName ** The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance. Type: String Required: No ** DBPortNumber ** The port number on which the database accepts connections. The value of the `DBPortNumber` parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the `DBPortNumber` value regardless of the value of the `ApplyImmediately` parameter. Default: `8182` Type: Integer Required: No **DBSecurityGroups.DBSecurityGroupName.N** A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: + If supplied, must match existing DBSecurityGroups. Type: Array of strings Required: No ** DBSubnetGroupName ** The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify `true` for the `ApplyImmediately` parameter. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: `mySubnetGroup` Type: String Required: No ** DeletionProtection ** A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See [Deleting a DB Instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). Type: Boolean Required: No ** Domain ** Not supported. Type: String Required: No ** DomainIAMRoleName ** Not supported Type: String Required: No ** EnableIAMDatabaseAuthentication ** True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false. You can enable IAM database authentication for the following database engines Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see [ModifyDBCluster](API_ModifyDBCluster.md). Default: `false` Type: Boolean Required: No ** EnablePerformanceInsights ** *(Not supported by Neptune)* Type: Boolean Required: No ** EngineVersion ** The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) API. Type: String Required: No ** Iops ** The new Provisioned IOPS (I/O operations per second) value for the instance. Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the `ApplyImmediately` parameter is set to `true` for this request. Default: Uses existing setting Type: Integer Required: No ** LicenseModel ** Not supported by Neptune. Type: String Required: No ** MasterUserPassword ** Not supported by Neptune. Type: String Required: No ** MonitoringInterval ** The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If `MonitoringRoleArn` is specified, then you must also set `MonitoringInterval` to a value other than 0. Valid Values: `0, 1, 5, 10, 15, 30, 60` Type: Integer Required: No ** MonitoringRoleArn ** The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. If `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value. Type: String Required: No ** MultiAZ ** Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the `ApplyImmediately` parameter is set to `true` for this request. Type: Boolean Required: No ** NewDBInstanceIdentifier ** The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set `Apply Immediately` to true, or will occur during the next maintenance window if `Apply Immediately` to false. This value is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + The first character must be a letter. + Cannot end with a hyphen or contain two consecutive hyphens. Example: `mydbinstance` Type: String Required: No ** OptionGroupName ** *(Not supported by Neptune)* Type: String Required: No ** PerformanceInsightsKMSKeyId ** *(Not supported by Neptune)* Type: String Required: No ** PreferredBackupWindow ** The daily time range during which automated backups are created if automated backups are enabled. Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see [ModifyDBCluster](API_ModifyDBCluster.md). Constraints: + Must be in the format hh24:mi-hh24:mi + Must be in Universal Time Coordinated (UTC) + Must not conflict with the preferred maintenance window + Must be at least 30 minutes Type: String Required: No ** PreferredMaintenanceWindow ** The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon \$1 Tue \$1 Wed \$1 Thu \$1 Fri \$1 Sat \$1 Sun Constraints: Must be at least 30 minutes Type: String Required: No ** PromotionTier ** A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid Values: 0 - 15 Type: Integer Required: No ** PubliclyAccessible ** Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. Type: Boolean Required: No ** StorageType ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: String Required: No ** TdeCredentialArn ** The ARN from the key store with which to associate the instance for TDE encryption. Type: String Required: No ** TdeCredentialPassword ** The password for the given ARN from the key store in order to access the device. Type: String Required: No **VpcSecurityGroupIds.VpcSecurityGroupId.N** A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see [ModifyDBCluster](API_ModifyDBCluster.md). Constraints: + If supplied, must match existing VpcSecurityGroupIds. Type: Array of strings Required: No ## Response Elements The following element is returned by the service. ** DBInstance ** Contains the details of an Amazon Neptune DB instance. This data type is used as a response element in the [DescribeDBInstances](API_DescribeDBInstances.md) action. Type: [DBInstance](API_DBInstance.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AuthorizationNotFound ** Specified CIDRIP or EC2 security group is not authorized for the specified DB security group. Neptune may not also be authorized via IAM to perform necessary actions on your behalf. HTTP Status Code: 404 ** CertificateNotFound ** *CertificateIdentifier* does not refer to an existing certificate. HTTP Status Code: 404 ** DBInstanceAlreadyExists ** User already has a DB instance with the given identifier. HTTP Status Code: 400 ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** DBSecurityGroupNotFound ** *DBSecurityGroupName* does not refer to an existing DB security group. HTTP Status Code: 404 ** DBUpgradeDependencyFailure ** The DB upgrade failed because a resource the DB depends on could not be modified. HTTP Status Code: 400 ** DomainNotFoundFault ** *Domain* does not refer to an existing Active Directory Domain. HTTP Status Code: 404 ** InsufficientDBInstanceCapacity ** Specified DB instance class is not available in the specified Availability Zone. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ** InvalidDBSecurityGroupState ** The state of the DB security group does not allow deletion. HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** DB subnet group does not cover all Availability Zones after it is created because users' change. HTTP Status Code: 400 ** OptionGroupNotFoundFault ** The designated option group could not be found. HTTP Status Code: 404 ** ProvisionedIopsNotAvailableInAZFault ** Provisioned IOPS not available in the specified Availability Zone. HTTP Status Code: 400 ** StorageQuotaExceeded ** Request would result in user exceeding the allowed amount of storage available across all DB instances. HTTP Status Code: 400 ** StorageTypeNotSupported ** *StorageType* specified cannot be associated with the DB Instance. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyDBInstance) # ModifyDBParameterGroup Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: `ParameterName`, `ParameterValue`, and `ApplyMethod`. A maximum of 20 parameters can be modified in a single request. **Note** Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect. **Important** After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the `character_set_database` parameter. You can use the *Parameter Groups* option of the Amazon Neptune console or the *DescribeDBParameters* command to verify that your DB parameter group has been created or modified. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupName ** The name of the DB parameter group. Constraints: + If supplied, must match the name of an existing DBParameterGroup. Type: String Required: Yes **Parameters.Parameter.N** An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): `immediate | pending-reboot` You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. Type: Array of [Parameter](API_Parameter.md) objects Required: Yes ## Response Elements The following element is returned by the service. ** DBParameterGroupName ** Provides the name of the DB parameter group. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** InvalidDBParameterGroupState ** The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyDBParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyDBParameterGroup) # ModifyDBSubnetGroup Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBSubnetGroupDescription ** The description for the DB subnet group. Type: String Required: No ** DBSubnetGroupName ** The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: `mySubnetgroup` Type: String Required: Yes **SubnetIds.SubnetIdentifier.N** The EC2 subnet IDs for the DB subnet group. Type: Array of strings Required: Yes ## Response Elements The following element is returned by the service. ** DBSubnetGroup ** Contains the details of an Amazon Neptune DB subnet group. This data type is used as a response element in the [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) action. Type: [DBSubnetGroup](API_DBSubnetGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBSubnetGroupDoesNotCoverEnoughAZs ** Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. HTTP Status Code: 400 ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** DBSubnetQuotaExceededFault ** Request would result in user exceeding the allowed number of subnets in a DB subnet groups. HTTP Status Code: 400 ** InvalidSubnet ** The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. HTTP Status Code: 400 ** SubnetAlreadyInUse ** The DB subnet is already in use in the Availability Zone. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyDBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyDBSubnetGroup) # ModifyEventSubscription Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md) and [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md) calls. You can see a list of the event categories for a given SourceType by using the **DescribeEventCategories** action. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** Enabled ** A Boolean value; set to **true** to activate the subscription. Type: Boolean Required: No **EventCategories.EventCategory.N** A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the **DescribeEventCategories** action. Type: Array of strings Required: No ** SnsTopicArn ** The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. Type: String Required: No ** SourceType ** The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. Valid values: db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot Type: String Required: No ** SubscriptionName ** The name of the event notification subscription. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** EventSubscription ** Contains the results of a successful invocation of the [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) action. Type: [EventSubscription](API_EventSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** EventSubscriptionQuotaExceeded ** You have exceeded the number of events you can subscribe to. HTTP Status Code: 400 ** SNSInvalidTopic ** The SNS topic is invalid. HTTP Status Code: 400 ** SNSNoAuthorization ** There is no SNS authorization. HTTP Status Code: 400 ** SNSTopicArnNotFound ** The ARN of the SNS topic could not be found. HTTP Status Code: 404 ** SubscriptionCategoryNotFound ** The designated subscription category could not be found. HTTP Status Code: 404 ** SubscriptionNotFound ** The designated subscription could not be found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyEventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyEventSubscription) # ModifyGlobalCluster Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** AllowMajorVersionUpgrade ** A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades if you specify a value for the `EngineVersion` parameter that is a different major version than the DB cluster's current version. If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade. Type: Boolean Required: No ** DeletionProtection ** Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled. Type: Boolean Required: No ** EngineVersion ** The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless `ApplyImmediately` is enabled. To list all of the available Neptune engine versions, use the following command: Type: String Required: No ** GlobalClusterIdentifier ** The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing global database cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: Yes ** NewGlobalClusterIdentifier ** A new cluster identifier to assign to the global database. This value is stored as a lowercase string. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens. + The first character must be a letter. + Can't end with a hyphen or contain two consecutive hyphens Example: `my-cluster2` Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ## Response Elements The following element is returned by the service. ** GlobalCluster ** Contains the details of an Amazon Neptune global database. This data type is used as a response element for the [CreateGlobalCluster](API_CreateGlobalCluster.md), [DescribeGlobalClusters](API_DescribeGlobalClusters.md), [ModifyGlobalCluster](#API_ModifyGlobalCluster), [DeleteGlobalCluster](API_DeleteGlobalCluster.md), [FailoverGlobalCluster](API_FailoverGlobalCluster.md), and [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) actions. Type: [GlobalCluster](API_GlobalCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** GlobalClusterNotFoundFault ** The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster. HTTP Status Code: 404 ** InvalidGlobalClusterStateFault ** The global cluster is in an invalid state and can't perform the requested operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ModifyGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ModifyGlobalCluster) # PromoteReadReplicaDBCluster Not supported. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** Not supported. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/PromoteReadReplicaDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/PromoteReadReplicaDBCluster) # RebootDBInstance You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBInstanceIdentifier ** The DB instance identifier. This parameter is stored as a lowercase string. Constraints: + Must match the identifier of an existing DBInstance. Type: String Required: Yes ** ForceFailover ** When `true`, the reboot is conducted through a MultiAZ failover. Constraint: You can't specify `true` if the instance is not configured for MultiAZ. Type: Boolean Required: No ## Response Elements The following element is returned by the service. ** DBInstance ** Contains the details of an Amazon Neptune DB instance. This data type is used as a response element in the [DescribeDBInstances](API_DescribeDBInstances.md) action. Type: [DBInstance](API_DBInstance.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RebootDBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RebootDBInstance) # RemoveFromGlobalCluster Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DbClusterIdentifier ** The Amazon Resource Name (ARN) identifying the cluster to be detached from the Neptune global database cluster. Type: String Required: Yes ** GlobalClusterIdentifier ** The identifier of the Neptune global database from which to detach the specified Neptune DB cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: Yes ## Response Elements The following element is returned by the service. ** GlobalCluster ** Contains the details of an Amazon Neptune global database. This data type is used as a response element for the [CreateGlobalCluster](API_CreateGlobalCluster.md), [DescribeGlobalClusters](API_DescribeGlobalClusters.md), [ModifyGlobalCluster](API_ModifyGlobalCluster.md), [DeleteGlobalCluster](API_DeleteGlobalCluster.md), [FailoverGlobalCluster](API_FailoverGlobalCluster.md), and [RemoveFromGlobalCluster](#API_RemoveFromGlobalCluster) actions. Type: [GlobalCluster](API_GlobalCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** GlobalClusterNotFoundFault ** The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster. HTTP Status Code: 404 ** InvalidGlobalClusterStateFault ** The global cluster is in an invalid state and can't perform the requested operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RemoveFromGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RemoveFromGlobalCluster) # RemoveRoleFromDBCluster Disassociates an Identity and Access Management (IAM) role from a DB cluster. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The name of the DB cluster to disassociate the IAM role from. Type: String Required: Yes ** FeatureName ** The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md). Type: String Required: No ** RoleArn ** The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example `arn:aws:iam::123456789012:role/NeptuneAccessRole`. Type: String Required: Yes ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBClusterRoleNotFound ** The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RemoveRoleFromDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RemoveRoleFromDBCluster) # RemoveSourceIdentifierFromSubscription Removes a source identifier from an existing event notification subscription. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** SourceIdentifier ** The source identifier to be removed from the subscription, such as the **DB instance identifier** for a DB instance or the name of a security group. Type: String Required: Yes ** SubscriptionName ** The name of the event notification subscription you want to remove a source identifier from. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** EventSubscription ** Contains the results of a successful invocation of the [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) action. Type: [EventSubscription](API_EventSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** SourceNotFound ** The source could not be found. HTTP Status Code: 404 ** SubscriptionNotFound ** The designated subscription could not be found. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RemoveSourceIdentifierFromSubscription) # RemoveTagsFromResource Removes metadata tags from an Amazon Neptune resource. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** ResourceName ** 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)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). Type: String Required: Yes **TagKeys.member.N** The tag key (name) of the tag to be removed. Type: Array of strings Required: Yes ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBInstanceNotFound ** *DBInstanceIdentifier* does not refer to an existing DB instance. HTTP Status Code: 404 ** DBSnapshotNotFound ** *DBSnapshotIdentifier* does not refer to an existing DB snapshot. HTTP Status Code: 404 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RemoveTagsFromResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RemoveTagsFromResource) # ResetDBClusterParameterGroup Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: `ParameterName` and `ApplyMethod`. To reset the entire DB cluster parameter group, specify the `DBClusterParameterGroupName` and `ResetAllParameters` parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to `pending-reboot` to take effect on the next DB instance restart or [RebootDBInstance](API_RebootDBInstance.md) request. You must call [RebootDBInstance](API_RebootDBInstance.md) for every DB instance in your DB cluster that you want the updated static parameter to apply to. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterParameterGroupName ** The name of the DB cluster parameter group to reset. Type: String Required: Yes **Parameters.Parameter.N** A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the `ResetAllParameters` parameter is set to `true`. Type: Array of [Parameter](API_Parameter.md) objects Required: No ** ResetAllParameters ** A value that is set to `true` to reset all parameters in the DB cluster parameter group to their default values, and `false` otherwise. You can't use this parameter if there is a list of parameter names specified for the `Parameters` parameter. Type: Boolean Required: No ## Response Elements The following element is returned by the service. ** DBClusterParameterGroupName ** The name of the DB cluster parameter group. Constraints: + Must be 1 to 255 letters or numbers. + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens This value is stored as a lowercase string. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** InvalidDBParameterGroupState ** The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ResetDBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ResetDBClusterParameterGroup) # ResetDBParameterGroup Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: `ParameterName` and `ApplyMethod`. To reset the entire DB parameter group, specify the `DBParameterGroup` name and `ResetAllParameters` parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to `pending-reboot` to take effect on the next DB instance restart or `RebootDBInstance` request. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBParameterGroupName ** The name of the DB parameter group. Constraints: + Must match the name of an existing DBParameterGroup. Type: String Required: Yes **Parameters.Parameter.N** To reset the entire DB parameter group, specify the `DBParameterGroup` name and `ResetAllParameters` parameters. To reset specific parameters, provide a list of the following: `ParameterName` and `ApplyMethod`. A maximum of 20 parameters can be modified in a single request. Valid Values (for Apply method): `pending-reboot` Type: Array of [Parameter](API_Parameter.md) objects Required: No ** ResetAllParameters ** Specifies whether (`true`) or not (`false`) to reset all parameters in the DB parameter group to default values. Default: `true` Type: Boolean Required: No ## Response Elements The following element is returned by the service. ** DBParameterGroupName ** Provides the name of the DB parameter group. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBParameterGroupNotFound ** *DBParameterGroupName* does not refer to an existing DB parameter group. HTTP Status Code: 404 ** InvalidDBParameterGroupState ** The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/ResetDBParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ResetDBParameterGroup) # RestoreDBClusterFromSnapshot Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). **AvailabilityZones.AvailabilityZone.N** Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in. Type: Array of strings Required: No ** CopyTagsToSnapshot ** *If set to `true`, tags are copied to any snapshot of the restored DB cluster that is created.* Type: Boolean Required: No ** DatabaseName ** Not supported. Type: String Required: No ** DBClusterIdentifier ** The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens Example: `my-snapshot-id` Type: String Required: Yes ** DBClusterParameterGroupName ** The name of the DB cluster parameter group to associate with the new DB cluster. Constraints: + If supplied, must match the name of an existing DBClusterParameterGroup. Type: String Required: No ** DBSubnetGroupName ** The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: `mySubnetgroup` Type: String Required: No ** DeletionProtection ** A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. Type: Boolean Required: No **EnableCloudwatchLogsExports.member.N** The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. Type: Array of strings Required: No ** EnableIAMDatabaseAuthentication ** True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: `false` Type: Boolean Required: No ** Engine ** The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source Type: String Required: Yes ** EngineVersion ** The version of the database engine to use for the new DB cluster. Type: String Required: No ** KmsKeyId ** The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. If you do not specify a value for the `KmsKeyId` parameter, then the following will occur: + If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. + If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is not encrypted, then the restored DB cluster is not encrypted. Type: String Required: No ** OptionGroupName ** *(Not supported by Neptune)* Type: String Required: No ** Port ** The port number on which the new DB cluster accepts connections. Constraints: Value must be `1150-65535` Default: The same port as the original DB cluster. Type: Integer Required: No ** ServerlessV2ScalingConfiguration ** Contains the scaling configuration of a Neptune Serverless DB cluster. For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*. Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object Required: No ** SnapshotIdentifier ** The identifier for the DB snapshot or DB cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot. Constraints: + Must match the identifier of an existing Snapshot. Type: String Required: Yes ** StorageType ** Specifies the storage type to be associated with the DB cluster. Valid values: `standard`, `iopt1` Default: `standard` Type: String Required: No **Tags.Tag.N** The tags to be assigned to the restored DB cluster. Type: Array of [Tag](API_Tag.md) objects Required: No **VpcSecurityGroupIds.VpcSecurityGroupId.N** A list of VPC security groups that the new DB cluster will belong to. Type: Array of strings Required: No ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterAlreadyExistsFault ** User already has a DB cluster with the given identifier. HTTP Status Code: 400 ** DBClusterParameterGroupNotFound ** *DBClusterParameterGroupName* does not refer to an existing DB Cluster parameter group. HTTP Status Code: 404 ** DBClusterQuotaExceededFault ** User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. HTTP Status Code: 403 ** DBClusterSnapshotNotFoundFault ** *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot. HTTP Status Code: 404 ** DBSnapshotNotFound ** *DBSnapshotIdentifier* does not refer to an existing DB snapshot. HTTP Status Code: 404 ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** InsufficientDBClusterCapacityFault ** The DB cluster does not have enough capacity for the current operation. HTTP Status Code: 403 ** InsufficientStorageClusterCapacity ** There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. HTTP Status Code: 400 ** InvalidDBClusterSnapshotStateFault ** The supplied value is not a valid DB cluster snapshot state. HTTP Status Code: 400 ** InvalidDBSnapshotState ** The state of the DB snapshot does not allow deletion. HTTP Status Code: 400 ** InvalidRestoreFault ** Cannot restore from vpc backup to non-vpc DB instance. HTTP Status Code: 400 ** InvalidSubnet ** The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** DB subnet group does not cover all Availability Zones after it is created because users' change. HTTP Status Code: 400 ** KMSKeyNotAccessibleFault ** Error accessing KMS key. HTTP Status Code: 400 ** OptionGroupNotFoundFault ** The designated option group could not be found. HTTP Status Code: 404 ** StorageQuotaExceeded ** Request would result in user exceeding the allowed amount of storage available across all DB instances. HTTP Status Code: 400 ** StorageQuotaExceeded ** Request would result in user exceeding the allowed amount of storage available across all DB instances. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RestoreDBClusterFromSnapshot) # RestoreDBClusterToPointInTime Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before `LatestRestorableTime` for up to `BackupRetentionPeriod` days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. **Note** This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the [CreateDBInstance](API_CreateDBInstance.md) action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in `DBClusterIdentifier`. You can create DB instances only after the `RestoreDBClusterToPointInTime` action has completed and the DB cluster is available. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The name of the new DB cluster to be created. Constraints: + Must contain from 1 to 63 letters, numbers, or hyphens + First character must be a letter + Cannot end with a hyphen or contain two consecutive hyphens Type: String Required: Yes ** DBClusterParameterGroupName ** The name of the DB cluster parameter group to associate with the new DB cluster. Constraints: + If supplied, must match the name of an existing DBClusterParameterGroup. Type: String Required: No ** DBSubnetGroupName ** The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: `mySubnetgroup` Type: String Required: No ** DeletionProtection ** A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. Type: Boolean Required: No **EnableCloudwatchLogsExports.member.N** The list of logs that the restored DB cluster is to export to CloudWatch Logs. Type: Array of strings Required: No ** EnableIAMDatabaseAuthentication ** True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: `false` Type: Boolean Required: No ** KmsKeyId ** The Amazon KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the `KmsKeyId` parameter. If you do not specify a value for the `KmsKeyId` parameter, then the following will occur: + If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. + If the DB cluster is not encrypted, then the restored DB cluster is not encrypted. If `DBClusterIdentifier` refers to a DB cluster that is not encrypted, then the restore request is rejected. Type: String Required: No ** OptionGroupName ** *(Not supported by Neptune)* Type: String Required: No ** Port ** The port number on which the new DB cluster accepts connections. Constraints: Value must be `1150-65535` Default: The same port as the original DB cluster. Type: Integer Required: No ** RestoreToTime ** The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: + Must be before the latest restorable time for the DB instance + Must be specified if `UseLatestRestorableTime` parameter is not provided + Cannot be specified if `UseLatestRestorableTime` parameter is true + Cannot be specified if `RestoreType` parameter is `copy-on-write` Example: `2015-03-07T23:45:00Z` Type: Timestamp Required: No ** RestoreType ** The type of restore to be performed. You can specify one of the following values: + `full-copy` - The new DB cluster is restored as a full copy of the source DB cluster. + `copy-on-write` - The new DB cluster is restored as a clone of the source DB cluster. If you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster. Type: String Required: No ** ServerlessV2ScalingConfiguration ** Contains the scaling configuration of a Neptune Serverless DB cluster. For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*. Type: [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) object Required: No ** SourceDBClusterIdentifier ** The identifier of the source DB cluster from which to restore. Constraints: + Must match the identifier of an existing DBCluster. Type: String Required: Yes ** StorageType ** Specifies the storage type to be associated with the DB cluster. Valid values: `standard`, `iopt1` Default: `standard` Type: String Required: No **Tags.Tag.N** The tags to be applied to the restored DB cluster. Type: Array of [Tag](API_Tag.md) objects Required: No ** UseLatestRestorableTime ** A value that is set to `true` to restore the DB cluster to the latest restorable backup time, and `false` otherwise. Default: `false` Constraints: Cannot be specified if `RestoreToTime` parameter is provided. Type: Boolean Required: No **VpcSecurityGroupIds.VpcSecurityGroupId.N** A list of VPC security groups that the new DB cluster belongs to. Type: Array of strings Required: No ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterAlreadyExistsFault ** User already has a DB cluster with the given identifier. HTTP Status Code: 400 ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** DBClusterParameterGroupNotFound ** *DBClusterParameterGroupName* does not refer to an existing DB Cluster parameter group. HTTP Status Code: 404 ** DBClusterQuotaExceededFault ** User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota. HTTP Status Code: 403 ** DBClusterSnapshotNotFoundFault ** *DBClusterSnapshotIdentifier* does not refer to an existing DB cluster snapshot. HTTP Status Code: 404 ** DBSubnetGroupNotFoundFault ** *DBSubnetGroupName* does not refer to an existing DB subnet group. HTTP Status Code: 404 ** InsufficientDBClusterCapacityFault ** The DB cluster does not have enough capacity for the current operation. HTTP Status Code: 403 ** InsufficientStorageClusterCapacity ** There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available. HTTP Status Code: 400 ** InvalidDBClusterSnapshotStateFault ** The supplied value is not a valid DB cluster snapshot state. HTTP Status Code: 400 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBSnapshotState ** The state of the DB snapshot does not allow deletion. HTTP Status Code: 400 ** InvalidRestoreFault ** Cannot restore from vpc backup to non-vpc DB instance. HTTP Status Code: 400 ** InvalidSubnet ** The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. HTTP Status Code: 400 ** InvalidVPCNetworkStateFault ** DB subnet group does not cover all Availability Zones after it is created because users' change. HTTP Status Code: 400 ** KMSKeyNotAccessibleFault ** Error accessing KMS key. HTTP Status Code: 400 ** OptionGroupNotFoundFault ** The designated option group could not be found. HTTP Status Code: 404 ** StorageQuotaExceeded ** Request would result in user exceeding the allowed amount of storage available across all DB instances. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/RestoreDBClusterToPointInTime) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/RestoreDBClusterToPointInTime) # StartDBCluster Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/StartDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/StartDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/StartDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/StartDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/StartDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/StartDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/StartDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/StartDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/StartDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/StartDBCluster) # StopDBCluster Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups. Neptune also retains the transaction logs so you can do a point-in-time restore if necessary. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** DBClusterIdentifier ** The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** DBCluster ** Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). Type: [DBCluster](API_DBCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidDBInstanceState ** The specified DB instance is not in the *available* state. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/StopDBCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/StopDBCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/StopDBCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/StopDBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/StopDBCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/StopDBCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/StopDBCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/StopDBCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/StopDBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/StopDBCluster) # SwitchoverGlobalCluster Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers." Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles. **Note** This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover. ## Request Parameters For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md). ** GlobalClusterIdentifier ** The identifier of the global database cluster to switch over. This parameter isn't case-sensitive. Constraints: Must match the identifier of an existing global database cluster. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: Yes ** TargetDbClusterIdentifier ** The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database. Type: String Required: Yes ## Response Elements The following element is returned by the service. ** GlobalCluster ** Contains the details of an Amazon Neptune global database. This data type is used as a response element for the [CreateGlobalCluster](API_CreateGlobalCluster.md), [DescribeGlobalClusters](API_DescribeGlobalClusters.md), [ModifyGlobalCluster](API_ModifyGlobalCluster.md), [DeleteGlobalCluster](API_DeleteGlobalCluster.md), [FailoverGlobalCluster](API_FailoverGlobalCluster.md), and [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) actions. Type: [GlobalCluster](API_GlobalCluster.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** DBClusterNotFoundFault ** *DBClusterIdentifier* does not refer to an existing DB cluster. HTTP Status Code: 404 ** GlobalClusterNotFoundFault ** The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster. HTTP Status Code: 404 ** InvalidDBClusterStateFault ** The DB cluster is not in a valid state. HTTP Status Code: 400 ** InvalidGlobalClusterStateFault ** The global cluster is in an invalid state and can't perform the requested operation. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/neptune-2014-10-31/SwitchoverGlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/SwitchoverGlobalCluster)