{ "version":"2.0", "metadata":{ "apiVersion":"2014-10-31", "endpointPrefix":"rds", "protocol":"query", "serviceAbbreviation":"Amazon Neptune", "serviceFullName":"Amazon Neptune", "serviceId":"Neptune", "signatureVersion":"v4", "signingName":"rds", "uid":"neptune-2014-10-31", "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/" }, "operations":{ "AddRoleToDBCluster":{ "name":"AddRoleToDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddRoleToDBClusterMessage"}, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"DBClusterRoleAlreadyExistsFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterRoleQuotaExceededFault"} ], "documentation":"

Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.

" }, "AddSourceIdentifierToSubscription":{ "name":"AddSourceIdentifierToSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, "output":{ "shape":"AddSourceIdentifierToSubscriptionResult", "resultWrapper":"AddSourceIdentifierToSubscriptionResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"SourceNotFoundFault"} ], "documentation":"

Adds a source identifier to an existing event notification subscription.

" }, "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceMessage"}, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

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.

" }, "ApplyPendingMaintenanceAction":{ "name":"ApplyPendingMaintenanceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ApplyPendingMaintenanceActionMessage"}, "output":{ "shape":"ApplyPendingMaintenanceActionResult", "resultWrapper":"ApplyPendingMaintenanceActionResult" }, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

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

" }, "CopyDBClusterParameterGroup":{ "name":"CopyDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyDBClusterParameterGroupMessage"}, "output":{ "shape":"CopyDBClusterParameterGroupResult", "resultWrapper":"CopyDBClusterParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], "documentation":"

Copies the specified DB cluster parameter group.

" }, "CopyDBClusterSnapshot":{ "name":"CopyDBClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyDBClusterSnapshotMessage"}, "output":{ "shape":"CopyDBClusterSnapshotResult", "resultWrapper":"CopyDBClusterSnapshotResult" }, "errors":[ {"shape":"DBClusterSnapshotAlreadyExistsFault"}, {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

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.

" }, "CopyDBParameterGroup":{ "name":"CopyDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyDBParameterGroupMessage"}, "output":{ "shape":"CopyDBParameterGroupResult", "resultWrapper":"CopyDBParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"}, {"shape":"DBParameterGroupQuotaExceededFault"} ], "documentation":"

Copies the specified DB parameter group.

" }, "CreateDBCluster":{ "name":"CreateDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBClusterMessage"}, "output":{ "shape":"CreateDBClusterResult", "resultWrapper":"CreateDBClusterResult" }, "errors":[ {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"InsufficientStorageClusterCapacityFault"}, {"shape":"DBClusterQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBSubnetGroupStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBClusterParameterGroupNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"GlobalClusterNotFoundFault"}, {"shape":"InvalidGlobalClusterStateFault"} ], "documentation":"

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`.

" }, "CreateDBClusterEndpoint":{ "name":"CreateDBClusterEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBClusterEndpointMessage"}, "output":{ "shape":"CreateDBClusterEndpointOutput", "resultWrapper":"CreateDBClusterEndpointResult" }, "errors":[ {"shape":"DBClusterEndpointQuotaExceededFault"}, {"shape":"DBClusterEndpointAlreadyExistsFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

" }, "CreateDBClusterParameterGroup":{ "name":"CreateDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBClusterParameterGroupMessage"}, "output":{ "shape":"CreateDBClusterParameterGroupResult", "resultWrapper":"CreateDBClusterParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], "documentation":"

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. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. 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.

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 or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

" }, "CreateDBClusterSnapshot":{ "name":"CreateDBClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBClusterSnapshotMessage"}, "output":{ "shape":"CreateDBClusterSnapshotResult", "resultWrapper":"CreateDBClusterSnapshotResult" }, "errors":[ {"shape":"DBClusterSnapshotAlreadyExistsFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"} ], "documentation":"

Creates a snapshot of a DB cluster.

" }, "CreateDBInstance":{ "name":"CreateDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBInstanceMessage"}, "output":{ "shape":"CreateDBInstanceResult", "resultWrapper":"CreateDBInstanceResult" }, "errors":[ {"shape":"DBInstanceAlreadyExistsFault"}, {"shape":"InsufficientDBInstanceCapacityFault"}, {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"InstanceQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"ProvisionedIopsNotAvailableInAZFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"StorageTypeNotSupportedFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DomainNotFoundFault"} ], "documentation":"

Creates a new DB instance.

" }, "CreateDBParameterGroup":{ "name":"CreateDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBParameterGroupMessage"}, "output":{ "shape":"CreateDBParameterGroupResult", "resultWrapper":"CreateDBParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], "documentation":"

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.

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.

" }, "CreateDBSubnetGroup":{ "name":"CreateDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBSubnetGroupMessage"}, "output":{ "shape":"CreateDBSubnetGroupResult", "resultWrapper":"CreateDBSubnetGroupResult" }, "errors":[ {"shape":"DBSubnetGroupAlreadyExistsFault"}, {"shape":"DBSubnetGroupQuotaExceededFault"}, {"shape":"DBSubnetQuotaExceededFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"} ], "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

" }, "CreateEventSubscription":{ "name":"CreateEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEventSubscriptionMessage"}, "output":{ "shape":"CreateEventSubscriptionResult", "resultWrapper":"CreateEventSubscriptionResult" }, "errors":[ {"shape":"EventSubscriptionQuotaExceededFault"}, {"shape":"SubscriptionAlreadyExistFault"}, {"shape":"SNSInvalidTopicFault"}, {"shape":"SNSNoAuthorizationFault"}, {"shape":"SNSTopicArnNotFoundFault"}, {"shape":"SubscriptionCategoryNotFoundFault"}, {"shape":"SourceNotFoundFault"} ], "documentation":"

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.

" }, "CreateGlobalCluster":{ "name":"CreateGlobalCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGlobalClusterMessage"}, "output":{ "shape":"CreateGlobalClusterResult", "resultWrapper":"CreateGlobalClusterResult" }, "errors":[ {"shape":"GlobalClusterAlreadyExistsFault"}, {"shape":"GlobalClusterQuotaExceededFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

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.

" }, "DeleteDBCluster":{ "name":"DeleteDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBClusterMessage"}, "output":{ "shape":"DeleteDBClusterResult", "resultWrapper":"DeleteDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterSnapshotAlreadyExistsFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"} ], "documentation":"

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`.

" }, "DeleteDBClusterEndpoint":{ "name":"DeleteDBClusterEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBClusterEndpointMessage"}, "output":{ "shape":"DeleteDBClusterEndpointOutput", "resultWrapper":"DeleteDBClusterEndpointResult" }, "errors":[ {"shape":"InvalidDBClusterEndpointStateFault"}, {"shape":"DBClusterEndpointNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

" }, "DeleteDBClusterParameterGroup":{ "name":"DeleteDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBClusterParameterGroupMessage"}, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

" }, "DeleteDBClusterSnapshot":{ "name":"DeleteDBClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBClusterSnapshotMessage"}, "output":{ "shape":"DeleteDBClusterSnapshotResult", "resultWrapper":"DeleteDBClusterSnapshotResult" }, "errors":[ {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"DBClusterSnapshotNotFoundFault"} ], "documentation":"

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the `available` state to be deleted.

" }, "DeleteDBInstance":{ "name":"DeleteDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBInstanceMessage"}, "output":{ "shape":"DeleteDBInstanceResult", "resultWrapper":"DeleteDBInstanceResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBSnapshotAlreadyExistsFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

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.

" }, "DeleteDBParameterGroup":{ "name":"DeleteDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBParameterGroupMessage"}, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.

" }, "DeleteDBSubnetGroup":{ "name":"DeleteDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBSubnetGroupMessage"}, "errors":[ {"shape":"InvalidDBSubnetGroupStateFault"}, {"shape":"InvalidDBSubnetStateFault"}, {"shape":"DBSubnetGroupNotFoundFault"} ], "documentation":"

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

" }, "DeleteEventSubscription":{ "name":"DeleteEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEventSubscriptionMessage"}, "output":{ "shape":"DeleteEventSubscriptionResult", "resultWrapper":"DeleteEventSubscriptionResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"InvalidEventSubscriptionStateFault"} ], "documentation":"

Deletes an event notification subscription.

" }, "DeleteGlobalCluster":{ "name":"DeleteGlobalCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteGlobalClusterMessage"}, "output":{ "shape":"DeleteGlobalClusterResult", "resultWrapper":"DeleteGlobalClusterResult" }, "errors":[ {"shape":"GlobalClusterNotFoundFault"}, {"shape":"InvalidGlobalClusterStateFault"} ], "documentation":"

Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.

" }, "DescribeDBClusterEndpoints":{ "name":"DescribeDBClusterEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterEndpointsMessage"}, "output":{ "shape":"DBClusterEndpointMessage", "resultWrapper":"DescribeDBClusterEndpointsResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Returns information about endpoints for an Amazon Neptune DB cluster.

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

" }, "DescribeDBClusterParameterGroups":{ "name":"DescribeDBClusterParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterParameterGroupsMessage"}, "output":{ "shape":"DBClusterParameterGroupsMessage", "resultWrapper":"DescribeDBClusterParameterGroupsResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

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.

" }, "DescribeDBClusterParameters":{ "name":"DescribeDBClusterParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterParametersMessage"}, "output":{ "shape":"DBClusterParameterGroupDetails", "resultWrapper":"DescribeDBClusterParametersResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Returns the detailed parameter list for a particular DB cluster parameter group.

" }, "DescribeDBClusterSnapshotAttributes":{ "name":"DescribeDBClusterSnapshotAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterSnapshotAttributesMessage"}, "output":{ "shape":"DescribeDBClusterSnapshotAttributesResult", "resultWrapper":"DescribeDBClusterSnapshotAttributesResult" }, "errors":[ {"shape":"DBClusterSnapshotNotFoundFault"} ], "documentation":"

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 action.

" }, "DescribeDBClusterSnapshots":{ "name":"DescribeDBClusterSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterSnapshotsMessage"}, "output":{ "shape":"DBClusterSnapshotMessage", "resultWrapper":"DescribeDBClusterSnapshotsResult" }, "errors":[ {"shape":"DBClusterSnapshotNotFoundFault"} ], "documentation":"

Returns information about DB cluster snapshots. This API action supports pagination.

" }, "DescribeDBClusters":{ "name":"DescribeDBClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClustersMessage"}, "output":{ "shape":"DBClusterMessage", "resultWrapper":"DescribeDBClustersResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Returns information about provisioned DB clusters, and supports pagination.

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

" }, "DescribeDBEngineVersions":{ "name":"DescribeDBEngineVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBEngineVersionsMessage"}, "output":{ "shape":"DBEngineVersionMessage", "resultWrapper":"DescribeDBEngineVersionsResult" }, "documentation":"

Returns a list of the available DB engines.

" }, "DescribeDBInstances":{ "name":"DescribeDBInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBInstancesMessage"}, "output":{ "shape":"DBInstanceMessage", "resultWrapper":"DescribeDBInstancesResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"} ], "documentation":"

Returns information about provisioned instances, and supports pagination.

This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

" }, "DescribeDBParameterGroups":{ "name":"DescribeDBParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBParameterGroupsMessage"}, "output":{ "shape":"DBParameterGroupsMessage", "resultWrapper":"DescribeDBParameterGroupsResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Returns a list of `DBParameterGroup` descriptions. If a `DBParameterGroupName` is specified, the list will contain only the description of the specified DB parameter group.

" }, "DescribeDBParameters":{ "name":"DescribeDBParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBParametersMessage"}, "output":{ "shape":"DBParameterGroupDetails", "resultWrapper":"DescribeDBParametersResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Returns the detailed parameter list for a particular DB parameter group.

" }, "DescribeDBSubnetGroups":{ "name":"DescribeDBSubnetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBSubnetGroupsMessage"}, "output":{ "shape":"DBSubnetGroupMessage", "resultWrapper":"DescribeDBSubnetGroupsResult" }, "errors":[ {"shape":"DBSubnetGroupNotFoundFault"} ], "documentation":"

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.

" }, "DescribeEngineDefaultClusterParameters":{ "name":"DescribeEngineDefaultClusterParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEngineDefaultClusterParametersMessage"}, "output":{ "shape":"DescribeEngineDefaultClusterParametersResult", "resultWrapper":"DescribeEngineDefaultClusterParametersResult" }, "documentation":"

Returns the default engine and system parameter information for the cluster database engine.

" }, "DescribeEngineDefaultParameters":{ "name":"DescribeEngineDefaultParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEngineDefaultParametersMessage"}, "output":{ "shape":"DescribeEngineDefaultParametersResult", "resultWrapper":"DescribeEngineDefaultParametersResult" }, "documentation":"

Returns the default engine and system parameter information for the specified database engine.

" }, "DescribeEventCategories":{ "name":"DescribeEventCategories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventCategoriesMessage"}, "output":{ "shape":"EventCategoriesMessage", "resultWrapper":"DescribeEventCategoriesResult" }, "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type.

" }, "DescribeEventSubscriptions":{ "name":"DescribeEventSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventSubscriptionsMessage"}, "output":{ "shape":"EventSubscriptionsMessage", "resultWrapper":"DescribeEventSubscriptionsResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"} ], "documentation":"

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.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventsMessage"}, "output":{ "shape":"EventsMessage", "resultWrapper":"DescribeEventsResult" }, "documentation":"

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.

" }, "DescribeGlobalClusters":{ "name":"DescribeGlobalClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeGlobalClustersMessage"}, "output":{ "shape":"GlobalClustersMessage", "resultWrapper":"DescribeGlobalClustersResult" }, "errors":[ {"shape":"GlobalClusterNotFoundFault"} ], "documentation":"

Returns information about Neptune global database clusters. This API supports pagination.

" }, "DescribeOrderableDBInstanceOptions":{ "name":"DescribeOrderableDBInstanceOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, "output":{ "shape":"OrderableDBInstanceOptionsMessage", "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" }, "documentation":"

Returns a list of orderable DB instance options for the specified engine.

" }, "DescribePendingMaintenanceActions":{ "name":"DescribePendingMaintenanceActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePendingMaintenanceActionsMessage"}, "output":{ "shape":"PendingMaintenanceActionsMessage", "resultWrapper":"DescribePendingMaintenanceActionsResult" }, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

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

" }, "DescribeValidDBInstanceModifications":{ "name":"DescribeValidDBInstanceModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeValidDBInstanceModificationsMessage"}, "output":{ "shape":"DescribeValidDBInstanceModificationsResult", "resultWrapper":"DescribeValidDBInstanceModificationsResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

" }, "FailoverDBCluster":{ "name":"FailoverDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"FailoverDBClusterMessage"}, "output":{ "shape":"FailoverDBClusterResult", "resultWrapper":"FailoverDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"

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.

" }, "FailoverGlobalCluster":{ "name":"FailoverGlobalCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"FailoverGlobalClusterMessage"}, "output":{ "shape":"FailoverGlobalClusterResult", "resultWrapper":"FailoverGlobalClusterResult" }, "errors":[ {"shape":"GlobalClusterNotFoundFault"}, {"shape":"InvalidGlobalClusterStateFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

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.

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.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceMessage"}, "output":{ "shape":"TagListMessage", "resultWrapper":"ListTagsForResourceResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Lists all tags on an Amazon Neptune resource.

" }, "ModifyDBCluster":{ "name":"ModifyDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBClusterMessage"}, "output":{ "shape":"ModifyDBClusterResult", "resultWrapper":"ModifyDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidDBSubnetGroupStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"DBClusterParameterGroupNotFoundFault"}, {"shape":"InvalidDBSecurityGroupStateFault"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"StorageTypeNotSupportedFault"} ], "documentation":"

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.

" }, "ModifyDBClusterEndpoint":{ "name":"ModifyDBClusterEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBClusterEndpointMessage"}, "output":{ "shape":"ModifyDBClusterEndpointOutput", "resultWrapper":"ModifyDBClusterEndpointResult" }, "errors":[ {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBClusterEndpointStateFault"}, {"shape":"DBClusterEndpointNotFoundFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"

Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

" }, "ModifyDBClusterParameterGroup":{ "name":"ModifyDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBClusterParameterGroupMessage"}, "output":{ "shape":"DBClusterParameterGroupNameMessage", "resultWrapper":"ModifyDBClusterParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"InvalidDBParameterGroupStateFault"} ], "documentation":"

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.

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.

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 command to verify that your DB cluster parameter group has been created or modified.

" }, "ModifyDBClusterSnapshotAttribute":{ "name":"ModifyDBClusterSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBClusterSnapshotAttributeMessage"}, "output":{ "shape":"ModifyDBClusterSnapshotAttributeResult", "resultWrapper":"ModifyDBClusterSnapshotAttributeResult" }, "errors":[ {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"SharedSnapshotQuotaExceededFault"} ], "documentation":"

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 action.

" }, "ModifyDBInstance":{ "name":"ModifyDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBInstanceMessage"}, "output":{ "shape":"ModifyDBInstanceResult", "resultWrapper":"ModifyDBInstanceResult" }, "errors":[ {"shape":"InvalidDBInstanceStateFault"}, {"shape":"InvalidDBSecurityGroupStateFault"}, {"shape":"DBInstanceAlreadyExistsFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"InsufficientDBInstanceCapacityFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"ProvisionedIopsNotAvailableInAZFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"DBUpgradeDependencyFailureFault"}, {"shape":"StorageTypeNotSupportedFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"CertificateNotFoundFault"}, {"shape":"DomainNotFoundFault"} ], "documentation":"

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 before you call ModifyDBInstance.

" }, "ModifyDBParameterGroup":{ "name":"ModifyDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBParameterGroupMessage"}, "output":{ "shape":"DBParameterGroupNameMessage", "resultWrapper":"ModifyDBParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"InvalidDBParameterGroupStateFault"} ], "documentation":"

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.

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.

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.

" }, "ModifyDBSubnetGroup":{ "name":"ModifyDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBSubnetGroupMessage"}, "output":{ "shape":"ModifyDBSubnetGroupResult", "resultWrapper":"ModifyDBSubnetGroupResult" }, "errors":[ {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSubnetQuotaExceededFault"}, {"shape":"SubnetAlreadyInUse"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"} ], "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.

" }, "ModifyEventSubscription":{ "name":"ModifyEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyEventSubscriptionMessage"}, "output":{ "shape":"ModifyEventSubscriptionResult", "resultWrapper":"ModifyEventSubscriptionResult" }, "errors":[ {"shape":"EventSubscriptionQuotaExceededFault"}, {"shape":"SubscriptionNotFoundFault"}, {"shape":"SNSInvalidTopicFault"}, {"shape":"SNSNoAuthorizationFault"}, {"shape":"SNSTopicArnNotFoundFault"}, {"shape":"SubscriptionCategoryNotFoundFault"} ], "documentation":"

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 and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

" }, "ModifyGlobalCluster":{ "name":"ModifyGlobalCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyGlobalClusterMessage"}, "output":{ "shape":"ModifyGlobalClusterResult", "resultWrapper":"ModifyGlobalClusterResult" }, "errors":[ {"shape":"GlobalClusterNotFoundFault"}, {"shape":"InvalidGlobalClusterStateFault"} ], "documentation":"

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.

" }, "PromoteReadReplicaDBCluster":{ "name":"PromoteReadReplicaDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PromoteReadReplicaDBClusterMessage"}, "output":{ "shape":"PromoteReadReplicaDBClusterResult", "resultWrapper":"PromoteReadReplicaDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

Not supported.

" }, "RebootDBInstance":{ "name":"RebootDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootDBInstanceMessage"}, "output":{ "shape":"RebootDBInstanceResult", "resultWrapper":"RebootDBInstanceResult" }, "errors":[ {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBInstanceNotFoundFault"} ], "documentation":"

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.

" }, "RemoveFromGlobalCluster":{ "name":"RemoveFromGlobalCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveFromGlobalClusterMessage"}, "output":{ "shape":"RemoveFromGlobalClusterResult", "resultWrapper":"RemoveFromGlobalClusterResult" }, "errors":[ {"shape":"GlobalClusterNotFoundFault"}, {"shape":"InvalidGlobalClusterStateFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

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.

" }, "RemoveRoleFromDBCluster":{ "name":"RemoveRoleFromDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveRoleFromDBClusterMessage"}, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"DBClusterRoleNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

" }, "RemoveSourceIdentifierFromSubscription":{ "name":"RemoveSourceIdentifierFromSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, "output":{ "shape":"RemoveSourceIdentifierFromSubscriptionResult", "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"SourceNotFoundFault"} ], "documentation":"

Removes a source identifier from an existing event notification subscription.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceMessage"}, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Removes metadata tags from an Amazon Neptune resource.

" }, "ResetDBClusterParameterGroup":{ "name":"ResetDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetDBClusterParameterGroupMessage"}, "output":{ "shape":"DBClusterParameterGroupNameMessage", "resultWrapper":"ResetDBClusterParameterGroupResult" }, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

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 request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

" }, "ResetDBParameterGroup":{ "name":"ResetDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetDBParameterGroupMessage"}, "output":{ "shape":"DBParameterGroupNameMessage", "resultWrapper":"ResetDBParameterGroupResult" }, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

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.

" }, "RestoreDBClusterFromSnapshot":{ "name":"RestoreDBClusterFromSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreDBClusterFromSnapshotMessage"}, "output":{ "shape":"RestoreDBClusterFromSnapshotResult", "resultWrapper":"RestoreDBClusterFromSnapshotResult" }, "errors":[ {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"DBClusterQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"InsufficientDBClusterCapacityFault"}, {"shape":"InsufficientStorageClusterCapacityFault"}, {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidRestoreFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidSubnet"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DBClusterParameterGroupNotFoundFault"} ], "documentation":"

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.

" }, "RestoreDBClusterToPointInTime":{ "name":"RestoreDBClusterToPointInTime", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreDBClusterToPointInTimeMessage"}, "output":{ "shape":"RestoreDBClusterToPointInTimeResult", "resultWrapper":"RestoreDBClusterToPointInTimeResult" }, "errors":[ {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"DBClusterQuotaExceededFault"}, {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InsufficientDBClusterCapacityFault"}, {"shape":"InsufficientStorageClusterCapacityFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"InvalidRestoreFault"}, {"shape":"InvalidSubnet"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBClusterParameterGroupNotFoundFault"} ], "documentation":"

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.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance 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.

" }, "StartDBCluster":{ "name":"StartDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartDBClusterMessage"}, "output":{ "shape":"StartDBClusterResult", "resultWrapper":"StartDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"

Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

" }, "StopDBCluster":{ "name":"StopDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopDBClusterMessage"}, "output":{ "shape":"StopDBClusterResult", "resultWrapper":"StopDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"

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.

" } }, "shapes":{ "AddRoleToDBClusterMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "RoleArn" ], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The name of the DB cluster to associate the IAM role with.

" }, "RoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example `arn:aws:iam::123456789012:role/NeptuneAccessRole`.

" }, "FeatureName":{ "shape":"String", "documentation":"

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.

" } } }, "AddSourceIdentifierToSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SourceIdentifier" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the event notification subscription you want to add a source identifier to.

" }, "SourceIdentifier":{ "shape":"String", "documentation":"

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.

" } } }, "AddSourceIdentifierToSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "AddTagsToResourceMessage":{ "type":"structure", "required":[ "ResourceName", "Tags" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

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

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the Amazon Neptune resource.

" } } }, "ApplyMethod":{ "type":"string", "enum":[ "immediate", "pending-reboot" ] }, "ApplyPendingMaintenanceActionMessage":{ "type":"structure", "required":[ "ResourceIdentifier", "ApplyAction", "OptInType" ], "members":{ "ResourceIdentifier":{ "shape":"String", "documentation":"

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).

" }, "ApplyAction":{ "shape":"String", "documentation":"

The pending maintenance action to apply to this resource.

Valid values: `system-update`, `db-upgrade`

" }, "OptInType":{ "shape":"String", "documentation":"

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.

" } } }, "ApplyPendingMaintenanceActionResult":{ "type":"structure", "members":{ "ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"} } }, "AttributeValueList":{ "type":"list", "member":{ "shape":"String", "locationName":"AttributeValue" } }, "AuthorizationNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

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.

", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "AvailabilityZone":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the availability zone.

" } }, "documentation":"

Specifies an Availability Zone.

", "wrapper":true }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"AvailabilityZone" } }, "AvailabilityZones":{ "type":"list", "member":{ "shape":"String", "locationName":"AvailabilityZone" } }, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "CertificateNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

CertificateIdentifier does not refer to an existing certificate.

", "error":{ "code":"CertificateNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "CharacterSet":{ "type":"structure", "members":{ "CharacterSetName":{ "shape":"String", "documentation":"

The name of the character set.

" }, "CharacterSetDescription":{ "shape":"String", "documentation":"

The description of the character set.

" } }, "documentation":"

Specifies a character set.

" }, "CloudwatchLogsExportConfiguration":{ "type":"structure", "members":{ "EnableLogTypes":{ "shape":"LogTypeList", "documentation":"

The list of log types to enable.

" }, "DisableLogTypes":{ "shape":"LogTypeList", "documentation":"

The list of log types to disable.

" } }, "documentation":"

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

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

Valid log types are: `audit` (to publish audit logs) and `slowquery` (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

" }, "ClusterPendingModifiedValues":{ "type":"structure", "members":{ "PendingCloudwatchLogsExports":{ "shape":"PendingCloudwatchLogsExports", "documentation":"

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

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DBClusterIdentifier value for the DB cluster.

" }, "IAMDatabaseAuthenticationEnabled":{ "shape":"BooleanOptional", "documentation":"

A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The database engine version.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days for which automatic DB snapshots are retained.

" }, "StorageType":{ "shape":"String", "documentation":"

The storage type for the DB cluster.

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The allocated storage size in gibibytes (GiB) for database engines. For Neptune, `AllocatedStorage` always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

" } }, "documentation":"

This data type is used as a response element in the `ModifyDBCluster` operation and contains changes that will be applied during the next maintenance window.

" }, "CopyDBClusterParameterGroupMessage":{ "type":"structure", "required":[ "SourceDBClusterParameterGroupIdentifier", "TargetDBClusterParameterGroupIdentifier", "TargetDBClusterParameterGroupDescription" ], "members":{ "SourceDBClusterParameterGroupIdentifier":{ "shape":"String", "documentation":"

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).

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`.

" }, "TargetDBClusterParameterGroupIdentifier":{ "shape":"String", "documentation":"

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`

" }, "TargetDBClusterParameterGroupDescription":{ "shape":"String", "documentation":"

A description for the copied DB cluster parameter group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the copied DB cluster parameter group.

" } } }, "CopyDBClusterParameterGroupResult":{ "type":"structure", "members":{ "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} } }, "CopyDBClusterSnapshotMessage":{ "type":"structure", "required":[ "SourceDBClusterSnapshotIdentifier", "TargetDBClusterSnapshotIdentifier" ], "members":{ "SourceDBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

- Must specify a valid system snapshot in the \"available\" state.

- Specify a valid DB snapshot identifier.

Example: `my-cluster-snapshot1`

" }, "TargetDBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

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`

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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.

" }, "PreSignedUrl":{ "shape":"String", "documentation":"

Not currently supported.

" }, "CopyTags":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to assign to the new DB cluster snapshot copy.

" } } }, "CopyDBClusterSnapshotResult":{ "type":"structure", "members":{ "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} } }, "CopyDBParameterGroupMessage":{ "type":"structure", "required":[ "SourceDBParameterGroupIdentifier", "TargetDBParameterGroupIdentifier", "TargetDBParameterGroupDescription" ], "members":{ "SourceDBParameterGroupIdentifier":{ "shape":"String", "documentation":"

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

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.

" }, "TargetDBParameterGroupIdentifier":{ "shape":"String", "documentation":"

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`

" }, "TargetDBParameterGroupDescription":{ "shape":"String", "documentation":"

A description for the copied DB parameter group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the copied DB parameter group.

" } } }, "CopyDBParameterGroupResult":{ "type":"structure", "members":{ "DBParameterGroup":{"shape":"DBParameterGroup"} } }, "CreateDBClusterEndpointMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "DBClusterEndpointIdentifier", "EndpointType" ], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

" }, "EndpointType":{ "shape":"String", "documentation":"

The type of the endpoint. One of: `READER`, `WRITER`, `ANY`.

" }, "StaticMembers":{ "shape":"StringList", "documentation":"

List of DB instance identifiers that are part of the custom endpoint group.

" }, "ExcludedMembers":{ "shape":"StringList", "documentation":"

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.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the Amazon Neptune resource.

" } } }, "CreateDBClusterEndpointOutput":{ "type":"structure", "members":{ "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterEndpointResourceIdentifier":{ "shape":"String", "documentation":"

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" }, "Endpoint":{ "shape":"String", "documentation":"

The DNS address of the endpoint.

" }, "Status":{ "shape":"String", "documentation":"

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.

" }, "EndpointType":{ "shape":"String", "documentation":"

The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.

" }, "CustomEndpointType":{ "shape":"String", "documentation":"

The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`.

" }, "StaticMembers":{ "shape":"StringList", "documentation":"

List of DB instance identifiers that are part of the custom endpoint group.

" }, "ExcludedMembers":{ "shape":"StringList", "documentation":"

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.

" }, "DBClusterEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the endpoint.

" } }, "documentation":"

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

- `CreateDBClusterEndpoint`

- `DescribeDBClusterEndpoints`

- `ModifyDBClusterEndpoint`

- `DeleteDBClusterEndpoint`

For the data structure that represents Amazon Neptune DB instance endpoints, see `Endpoint`.

" }, "CreateDBClusterMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "Engine" ], "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

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

" }, "CharacterSetName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

If set to `true`, tags are copied to any snapshot of the DB cluster that is created.

" }, "DatabaseName":{ "shape":"String", "documentation":"

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.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

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`

" }, "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of EC2 VPC security groups to associate with this DB cluster.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

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`

" }, "Engine":{ "shape":"String", "documentation":"

The name of the database engine to be used for this DB cluster.

Valid Values: `neptune`

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to use for the new DB cluster.

Example: `1.0.2.1`

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the instances in the DB cluster accept connections.

Default: `8182`

" }, "MasterUsername":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

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 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.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

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 in the Amazon Neptune User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

" }, "ReplicationSourceIdentifier":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to assign to the new DB cluster.

" }, "StorageEncrypted":{ "shape":"BooleanOptional", "documentation":"

Specifies whether the DB cluster is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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.

" }, "PreSignedUrl":{ "shape":"String", "documentation":"

This parameter is not currently supported.

" }, "EnableIAMDatabaseAuthentication":{ "shape":"BooleanOptional", "documentation":"

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`.

" }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", "documentation":"

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.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

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.

" }, "ServerlessV2ScalingConfiguration":{ "shape":"ServerlessV2ScalingConfiguration", "documentation":"

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

" }, "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

The ID of the Neptune global database to which this new DB cluster should be added.

" }, "StorageType":{ "shape":"String", "documentation":"

The storage type to associate with the DB cluster.

Valid Values:

- `standard | iopt1`

Default:

- `standard`

When you create a Neptune cluster with the storage type set to `iopt1`, the storage type is returned in the response. The storage type isn't returned when you set it to `standard`.

" } } }, "CreateDBClusterParameterGroupMessage":{ "type":"structure", "required":[ "DBClusterParameterGroupName", "DBParameterGroupFamily", "Description" ], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

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.

" }, "Description":{ "shape":"String", "documentation":"

The description for the DB cluster parameter group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the new DB cluster parameter group.

" } } }, "CreateDBClusterParameterGroupResult":{ "type":"structure", "members":{ "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} } }, "CreateDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "CreateDBClusterSnapshotMessage":{ "type":"structure", "required":[ "DBClusterSnapshotIdentifier", "DBClusterIdentifier" ], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

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`

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

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`

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the DB cluster snapshot.

" } } }, "CreateDBClusterSnapshotResult":{ "type":"structure", "members":{ "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} } }, "CreateDBInstanceMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "DBInstanceClass", "Engine", "DBClusterIdentifier" ], "members":{ "DBName":{ "shape":"String", "documentation":"

Not supported.

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

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`

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

Not supported by Neptune.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

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.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the database engine to be used for this instance.

Valid Values: `neptune`

" }, "MasterUsername":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupNameList", "documentation":"

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

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.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

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.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

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.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

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.

" }, "DBParameterGroupName":{ "shape":"String", "documentation":"

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

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

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.

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

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

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.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.

Default: `8182`

Type: Integer

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

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.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to use. Currently, setting this parameter has no effect.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: `true`

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for this DB instance.

Valid values: `license-included` | `bring-your-own-license` | `general-public-license`

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "CharacterSetName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

This flag should no longer be used.

", "deprecated":true }, "Tags":{ "shape":"TagList", "documentation":"

The tags to assign to the new instance.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster that the instance will belong to.

For information on creating a DB cluster, see CreateDBCluster.

Type: String

" }, "StorageType":{ "shape":"String", "documentation":"

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

Not applicable. Storage is managed by the DB Cluster.

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the key store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"SensitiveString", "documentation":"

The password for the given ARN from the key store in order to access the device.

" }, "StorageEncrypted":{ "shape":"BooleanOptional", "documentation":"

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.

Default: false

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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.

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.

" }, "Domain":{ "shape":"String", "documentation":"

Specify the Active Directory Domain to create the instance in.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

" }, "MonitoringInterval":{ "shape":"IntegerOptional", "documentation":"

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`

" }, "MonitoringRoleArn":{ "shape":"String", "documentation":"

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.

" }, "DomainIAMRoleName":{ "shape":"String", "documentation":"

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

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

" }, "Timezone":{ "shape":"String", "documentation":"

The time zone of the DB instance.

" }, "EnableIAMDatabaseAuthentication":{ "shape":"BooleanOptional", "documentation":"

Not supported by Neptune (ignored).

" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", "documentation":"

(Not supported by Neptune)

" }, "PerformanceInsightsKMSKeyId":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", "documentation":"

The list of log types that need to be enabled for exporting to CloudWatch Logs.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

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.

DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.

" } } }, "CreateDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "CreateDBParameterGroupMessage":{ "type":"structure", "required":[ "DBParameterGroupName", "DBParameterGroupFamily", "Description" ], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

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.

" }, "Description":{ "shape":"String", "documentation":"

The description for the DB parameter group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the new DB parameter group.

" } } }, "CreateDBParameterGroupResult":{ "type":"structure", "members":{ "DBParameterGroup":{"shape":"DBParameterGroup"} } }, "CreateDBSubnetGroupMessage":{ "type":"structure", "required":[ "DBSubnetGroupName", "DBSubnetGroupDescription", "SubnetIds" ], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

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`

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

The description for the DB subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 Subnet IDs for the DB subnet group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the new DB subnet group.

" } } }, "CreateDBSubnetGroupResult":{ "type":"structure", "members":{ "DBSubnetGroup":{"shape":"DBSubnetGroup"} } }, "CreateEventSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SnsTopicArn" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the subscription.

Constraints: The name must be less than 255 characters.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

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.

" }, "SourceType":{ "shape":"String", "documentation":"

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` | `db-cluster` | `db-parameter-group` | `db-security-group` | `db-snapshot` | `db-cluster-snapshot`

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

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.

" }, "SourceIds":{ "shape":"SourceIdsList", "documentation":"

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.

" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be applied to the new event subscription.

" } } }, "CreateEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "CreateGlobalClusterMessage":{ "type":"structure", "required":["GlobalClusterIdentifier"], "members":{ "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

The cluster identifier of the new global database cluster.

" }, "SourceDBClusterIdentifier":{ "shape":"String", "documentation":"

(Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the database engine to be used in the global database.

Valid values: `neptune`

" }, "EngineVersion":{ "shape":"String", "documentation":"

The Neptune engine version to be used by the global database.

Valid values: `1.2.0.0` or above.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

" }, "StorageEncrypted":{ "shape":"BooleanOptional", "documentation":"

The storage encryption setting for the new global database cluster.

" } } }, "CreateGlobalClusterResult":{ "type":"structure", "members":{ "GlobalCluster":{"shape":"GlobalCluster"} } }, "DBCluster":{ "type":"structure", "members":{ "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

`AllocatedStorage` always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" }, "CharacterSetName":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "DatabaseName":{ "shape":"String", "documentation":"

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" }, "DBClusterParameterGroup":{ "shape":"String", "documentation":"

Specifies the name of the DB cluster parameter group for the DB cluster.

" }, "DBSubnetGroup":{ "shape":"String", "documentation":"

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" }, "Status":{ "shape":"String", "documentation":"

Specifies the current state of this DB cluster.

" }, "PercentProgress":{ "shape":"String", "documentation":"

Specifies the progress of the operation as a percentage.

" }, "EarliestRestorableTime":{ "shape":"TStamp", "documentation":"

Specifies the earliest time to which a database can be restored with point-in-time restore.

" }, "Endpoint":{ "shape":"String", "documentation":"

Specifies the connection endpoint for the primary instance of the DB cluster.

" }, "ReaderEndpoint":{ "shape":"String", "documentation":"

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Specifies whether the DB cluster has instances in multiple Availability Zones.

" }, "Engine":{ "shape":"String", "documentation":"

Provides the name of the database engine to be used for this DB cluster.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "LatestRestorableTime":{ "shape":"TStamp", "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

Specifies the port that the database engine is listening on.

" }, "MasterUsername":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "DBClusterOptionGroupMemberships":{ "shape":"DBClusterOptionGroupMemberships", "documentation":"

Not supported by Neptune.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" }, "ReplicationSourceIdentifier":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "ReadReplicaIdentifiers":{ "shape":"ReadReplicaIdentifierList", "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

" }, "DBClusterMembers":{ "shape":"DBClusterMemberList", "documentation":"

Provides the list of instances that make up the DB cluster.

" }, "VpcSecurityGroups":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

Provides a list of VPC security groups that the DB cluster belongs to.

" }, "HostedZoneId":{ "shape":"String", "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" }, "StorageEncrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the DB cluster is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster.

" }, "DbClusterResourceId":{ "shape":"String", "documentation":"

The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.

" }, "DBClusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB cluster.

" }, "AssociatedRoles":{ "shape":"DBClusterRoles", "documentation":"

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

" }, "IAMDatabaseAuthenticationEnabled":{ "shape":"Boolean", "documentation":"

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" }, "CloneGroupId":{ "shape":"String", "documentation":"

Identifies the clone group to which the DB cluster is associated.

" }, "ClusterCreateTime":{ "shape":"TStamp", "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

If set to `true`, tags are copied to any snapshot of the DB cluster that is created.

" }, "EnabledCloudwatchLogsExports":{ "shape":"LogTypeList", "documentation":"

A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: `audit` (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

" }, "PendingModifiedValues":{ "shape":"ClusterPendingModifiedValues", "documentation":"

This data type is used as a response element in the `ModifyDBCluster` operation and contains changes that will be applied during the next maintenance window.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

" }, "CrossAccountClone":{ "shape":"BooleanOptional", "documentation":"

If set to `true`, the DB cluster can be cloned across accounts.

" }, "AutomaticRestartTime":{ "shape":"TStamp", "documentation":"

Time at which the DB cluster will be automatically restarted.

" }, "ServerlessV2ScalingConfiguration":{ "shape":"ServerlessV2ScalingConfigurationInfo", "documentation":"

Shows the scaling configuration for a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

" }, "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

" }, "IOOptimizedNextAllowedModificationTime":{ "shape":"TStamp", "documentation":"

The next time you can modify the DB cluster to use the `iopt1` storage type.

" }, "StorageType":{ "shape":"String", "documentation":"

The storage type associated with the DB cluster.

" } }, "documentation":"

Contains the details of an Amazon Neptune DB cluster.

This data type is used as a response element in the DescribeDBClusters.

", "wrapper":true }, "DBClusterAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a DB cluster with the given identifier.

", "error":{ "code":"DBClusterAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterEndpoint":{ "type":"structure", "members":{ "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterEndpointResourceIdentifier":{ "shape":"String", "documentation":"

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" }, "Endpoint":{ "shape":"String", "documentation":"

The DNS address of the endpoint.

" }, "Status":{ "shape":"String", "documentation":"

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.

" }, "EndpointType":{ "shape":"String", "documentation":"

The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.

" }, "CustomEndpointType":{ "shape":"String", "documentation":"

The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`.

" }, "StaticMembers":{ "shape":"StringList", "documentation":"

List of DB instance identifiers that are part of the custom endpoint group.

" }, "ExcludedMembers":{ "shape":"StringList", "documentation":"

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.

" }, "DBClusterEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the endpoint.

" } }, "documentation":"

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

- `CreateDBClusterEndpoint`

- `DescribeDBClusterEndpoints`

- `ModifyDBClusterEndpoint`

- `DeleteDBClusterEndpoint`

For the data structure that represents Amazon Neptune DB instance endpoints, see `Endpoint`.

" }, "DBClusterEndpointAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The specified custom endpoint cannot be created because it already exists.

", "error":{ "code":"DBClusterEndpointAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterEndpointList":{ "type":"list", "member":{ "shape":"DBClusterEndpoint", "locationName":"DBClusterEndpointList" } }, "DBClusterEndpointMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "DBClusterEndpoints":{ "shape":"DBClusterEndpointList", "documentation":"

Contains the details of the endpoints associated with the cluster and matching any filter conditions.

" } } }, "DBClusterEndpointNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified custom endpoint doesn't exist.

", "error":{ "code":"DBClusterEndpointNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterEndpointQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster already has the maximum number of custom endpoints.

", "error":{ "code":"DBClusterEndpointQuotaExceededFault", "httpStatusCode":403, "senderFault":true }, "exception":true }, "DBClusterList":{ "type":"list", "member":{ "shape":"DBCluster", "locationName":"DBCluster" } }, "DBClusterMember":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Specifies the instance identifier for this member of the DB cluster.

" }, "IsClusterWriter":{ "shape":"Boolean", "documentation":"

Value that is `true` if the cluster member is the primary instance for the DB cluster and `false` otherwise.

" }, "DBClusterParameterGroupStatus":{ "shape":"String", "documentation":"

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

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.

" } }, "documentation":"

Contains information about an instance that is part of a DB cluster.

", "wrapper":true }, "DBClusterMemberList":{ "type":"list", "member":{ "shape":"DBClusterMember", "locationName":"DBClusterMember" } }, "DBClusterMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A pagination token that can be used in a subsequent DescribeDBClusters request.

" }, "DBClusters":{ "shape":"DBClusterList", "documentation":"

Contains a list of DB clusters for the user.

" } } }, "DBClusterNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBClusterIdentifier does not refer to an existing DB cluster.

", "error":{ "code":"DBClusterNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBClusterOptionGroupMemberships":{ "type":"list", "member":{ "shape":"DBClusterOptionGroupStatus", "locationName":"DBClusterOptionGroup" } }, "DBClusterOptionGroupStatus":{ "type":"structure", "members":{ "DBClusterOptionGroupName":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "Status":{ "shape":"String", "documentation":"

Not supported by Neptune.

" } }, "documentation":"

Not supported by Neptune.

" }, "DBClusterParameterGroup":{ "type":"structure", "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

Provides the name of the DB cluster parameter group.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

" }, "Description":{ "shape":"String", "documentation":"

Provides the customer-specified description for this DB cluster parameter group.

" }, "DBClusterParameterGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" } }, "documentation":"

Contains the details of an Amazon Neptune DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

", "wrapper":true }, "DBClusterParameterGroupDetails":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParametersList", "documentation":"

Provides a list of parameters for the DB cluster parameter group.

" }, "Marker":{ "shape":"String", "documentation":"

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` .

" } } }, "DBClusterParameterGroupList":{ "type":"list", "member":{ "shape":"DBClusterParameterGroup", "locationName":"DBClusterParameterGroup" } }, "DBClusterParameterGroupNameMessage":{ "type":"structure", "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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.

" } } }, "DBClusterParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

", "error":{ "code":"DBClusterParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBClusterParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "DBClusterParameterGroups":{ "shape":"DBClusterParameterGroupList", "documentation":"

A list of DB cluster parameter groups.

" } } }, "DBClusterQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

", "error":{ "code":"DBClusterQuotaExceededFault", "httpStatusCode":403, "senderFault":true }, "exception":true }, "DBClusterRole":{ "type":"structure", "members":{ "RoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" }, "Status":{ "shape":"String", "documentation":"

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

- `ACTIVE` - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

- `PENDING` - the IAM role ARN is being associated with the DB cluster.

- `INVALID` - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

" }, "FeatureName":{ "shape":"String", "documentation":"

The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

" } }, "documentation":"

Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.

" }, "DBClusterRoleAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", "error":{ "code":"DBClusterRoleAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterRoleNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.

", "error":{ "code":"DBClusterRoleNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBClusterRoleQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", "error":{ "code":"DBClusterRoleQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterRoles":{ "type":"list", "member":{ "shape":"DBClusterRole", "locationName":"DBClusterRole" } }, "DBClusterSnapshot":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

" }, "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

After you restore a DB cluster using a `DBClusterSnapshotIdentifier`, you must specify the same `DBClusterSnapshotIdentifier` for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

However, if you don't specify the `DBClusterSnapshotIdentifier`, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the `DBClusterSnapshotIdentifier`, and the original DB cluster is deleted.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" }, "SnapshotCreateTime":{ "shape":"TStamp", "documentation":"

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" }, "Engine":{ "shape":"String", "documentation":"

Specifies the name of the database engine.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

Specifies the allocated storage size in gibibytes (GiB).

" }, "Status":{ "shape":"String", "documentation":"

Specifies the status of this DB cluster snapshot.

" }, "Port":{ "shape":"Integer", "documentation":"

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VPC ID associated with the DB cluster snapshot.

" }, "ClusterCreateTime":{ "shape":"TStamp", "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" }, "MasterUsername":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Provides the version of the database engine for this DB cluster snapshot.

" }, "LicenseModel":{ "shape":"String", "documentation":"

Provides the license model information for this DB cluster snapshot.

" }, "SnapshotType":{ "shape":"String", "documentation":"

Provides the type of the DB cluster snapshot.

" }, "PercentProgress":{ "shape":"Integer", "documentation":"

Specifies the percentage of the estimated data that has been transferred.

" }, "StorageEncrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the DB cluster snapshot is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.

" }, "DBClusterSnapshotArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" }, "SourceDBClusterSnapshotArn":{ "shape":"String", "documentation":"

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" }, "IAMDatabaseAuthenticationEnabled":{ "shape":"Boolean", "documentation":"

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" }, "StorageType":{ "shape":"String", "documentation":"

The storage type associated with the DB cluster snapshot.

" } }, "documentation":"

Contains the details for an Amazon Neptune DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

", "wrapper":true }, "DBClusterSnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a DB cluster snapshot with the given identifier.

", "error":{ "code":"DBClusterSnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterSnapshotAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the manual DB cluster snapshot attribute.

The attribute named `restore` refers to the list of Amazon accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

" }, "AttributeValues":{ "shape":"AttributeValueList", "documentation":"

The value(s) for the manual DB cluster snapshot attribute.

If the `AttributeName` field is set to `restore`, then this element returns a list of IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of `all` is in the list, then the manual DB cluster snapshot is public and available for any Amazon account to copy or restore.

" } }, "documentation":"

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

" }, "DBClusterSnapshotAttributeList":{ "type":"list", "member":{ "shape":"DBClusterSnapshotAttribute", "locationName":"DBClusterSnapshotAttribute" } }, "DBClusterSnapshotAttributesResult":{ "type":"structure", "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the manual DB cluster snapshot that the attributes apply to.

" }, "DBClusterSnapshotAttributes":{ "shape":"DBClusterSnapshotAttributeList", "documentation":"

The list of attributes and values for the manual DB cluster snapshot.

" } }, "documentation":"

Contains the results of a successful call to the 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 action.

", "wrapper":true }, "DBClusterSnapshotList":{ "type":"list", "member":{ "shape":"DBClusterSnapshot", "locationName":"DBClusterSnapshot" } }, "DBClusterSnapshotMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "DBClusterSnapshots":{ "shape":"DBClusterSnapshotList", "documentation":"

Provides a list of DB cluster snapshots for the user.

" } } }, "DBClusterSnapshotNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

", "error":{ "code":"DBClusterSnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBEngineVersion":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the database engine.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

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

" }, "DBEngineDescription":{ "shape":"String", "documentation":"

The description of the database engine.

" }, "DBEngineVersionDescription":{ "shape":"String", "documentation":"

The description of the database engine version.

" }, "DefaultCharacterSet":{ "shape":"CharacterSet", "documentation":"

(Not supported by Neptune)

" }, "SupportedCharacterSets":{ "shape":"SupportedCharacterSetsList", "documentation":"

(Not supported by Neptune)

" }, "ValidUpgradeTarget":{ "shape":"ValidUpgradeTargetList", "documentation":"

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

" }, "SupportedTimezones":{ "shape":"SupportedTimezonesList", "documentation":"

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

" }, "ExportableLogTypes":{ "shape":"LogTypeList", "documentation":"

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

" }, "SupportsLogExportsToCloudwatchLogs":{ "shape":"Boolean", "documentation":"

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

" }, "SupportsReadReplica":{ "shape":"Boolean", "documentation":"

Indicates whether the database engine version supports read replicas.

" }, "SupportsGlobalDatabases":{ "shape":"Boolean", "documentation":"

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

" } }, "documentation":"

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

" }, "DBEngineVersionList":{ "type":"list", "member":{ "shape":"DBEngineVersion", "locationName":"DBEngineVersion" } }, "DBEngineVersionMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "DBEngineVersions":{ "shape":"DBEngineVersionList", "documentation":"

A list of `DBEngineVersion` elements.

" } } }, "DBInstance":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

Contains the name of the compute and memory capacity class of the DB instance.

" }, "Engine":{ "shape":"String", "documentation":"

Provides the name of the database engine to be used for this DB instance.

" }, "DBInstanceStatus":{ "shape":"String", "documentation":"

Specifies the current state of this database.

" }, "MasterUsername":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "DBName":{ "shape":"String", "documentation":"

The database name.

" }, "Endpoint":{ "shape":"Endpoint", "documentation":"

Specifies the connection endpoint.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

Not supported by Neptune.

" }, "InstanceCreateTime":{ "shape":"TStamp", "documentation":"

Provides the date and time the DB instance was created.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.

" }, "BackupRetentionPeriod":{ "shape":"Integer", "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupMembershipList", "documentation":"

Provides List of DB security group elements containing only `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements.

" }, "VpcSecurityGroups":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

Provides a list of VPC security group elements that the DB instance belongs to.

" }, "DBParameterGroups":{ "shape":"DBParameterGroupStatusList", "documentation":"

Provides the list of DB parameter groups applied to this DB instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Specifies the name of the Availability Zone the DB instance is located in.

" }, "DBSubnetGroup":{ "shape":"DBSubnetGroup", "documentation":"

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" }, "PendingModifiedValues":{ "shape":"PendingModifiedValues", "documentation":"

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" }, "LatestRestorableTime":{ "shape":"TStamp", "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

Indicates that minor version patches are applied automatically.

" }, "ReadReplicaSourceDBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

" }, "ReadReplicaDBInstanceIdentifiers":{ "shape":"ReadReplicaDBInstanceIdentifierList", "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB instance.

" }, "ReadReplicaDBClusterIdentifiers":{ "shape":"ReadReplicaDBClusterIdentifierList", "documentation":"

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for this DB instance.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value.

" }, "OptionGroupMemberships":{ "shape":"OptionGroupMembershipList", "documentation":"

(Not supported by Neptune)

" }, "CharacterSetName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "SecondaryAvailabilityZone":{ "shape":"String", "documentation":"

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" }, "PubliclyAccessible":{ "shape":"Boolean", "documentation":"

This flag should no longer be used.

", "deprecated":true }, "StatusInfos":{ "shape":"DBInstanceStatusInfoList", "documentation":"

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type associated with DB instance.

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the key store with which the instance is associated for TDE encryption.

" }, "DbInstancePort":{ "shape":"Integer", "documentation":"

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

" }, "StorageEncrypted":{ "shape":"Boolean", "documentation":"

Not supported: The encryption for DB instances is managed by the DB cluster.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

Not supported: The encryption for DB instances is managed by the DB cluster.

" }, "DbiResourceId":{ "shape":"String", "documentation":"

The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed.

" }, "CACertificateIdentifier":{ "shape":"String", "documentation":"

The identifier of the CA certificate for this DB instance.

" }, "DomainMemberships":{ "shape":"DomainMembershipList", "documentation":"

Not supported

" }, "CopyTagsToSnapshot":{ "shape":"Boolean", "documentation":"

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

" }, "MonitoringInterval":{ "shape":"IntegerOptional", "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" }, "EnhancedMonitoringResourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" }, "MonitoringRoleArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "DBInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB instance.

" }, "Timezone":{ "shape":"String", "documentation":"

Not supported.

" }, "IAMDatabaseAuthenticationEnabled":{ "shape":"Boolean", "documentation":"

True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

" }, "PerformanceInsightsEnabled":{ "shape":"BooleanOptional", "documentation":"

(Not supported by Neptune)

" }, "PerformanceInsightsKMSKeyId":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "EnabledCloudwatchLogsExports":{ "shape":"LogTypeList", "documentation":"

A list of log types that this DB instance is configured to export to CloudWatch Logs.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

" } }, "documentation":"

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances action.

", "wrapper":true }, "DBInstanceAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a DB instance with the given identifier.

", "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBInstanceList":{ "type":"list", "member":{ "shape":"DBInstance", "locationName":"DBInstance" } }, "DBInstanceMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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` .

" }, "DBInstances":{ "shape":"DBInstanceList", "documentation":"

A list of DBInstance instances.

" } } }, "DBInstanceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBInstanceStatusInfo":{ "type":"structure", "members":{ "StatusType":{ "shape":"String", "documentation":"

This value is currently \"read replication.\"

" }, "Normal":{ "shape":"Boolean", "documentation":"

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" }, "Status":{ "shape":"String", "documentation":"

Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

" }, "Message":{ "shape":"String", "documentation":"

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

" } }, "documentation":"

Provides a list of status information for a DB instance.

" }, "DBInstanceStatusInfoList":{ "type":"list", "member":{ "shape":"DBInstanceStatusInfo", "locationName":"DBInstanceStatusInfo" } }, "DBParameterGroup":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

" }, "Description":{ "shape":"String", "documentation":"

Provides the customer-specified description for this DB parameter group.

" }, "DBParameterGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB parameter group.

" } }, "documentation":"

Contains the details of an Amazon Neptune DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

", "wrapper":true }, "DBParameterGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A DB parameter group with the same name exists.

", "error":{ "code":"DBParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBParameterGroupDetails":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParametersList", "documentation":"

A list of Parameter values.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DBParameterGroupList":{ "type":"list", "member":{ "shape":"DBParameterGroup", "locationName":"DBParameterGroup" } }, "DBParameterGroupNameMessage":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group.

" } } }, "DBParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBParameterGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

", "error":{ "code":"DBParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBParameterGroupStatus":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DP parameter group.

" }, "ParameterApplyStatus":{ "shape":"String", "documentation":"

The status of parameter updates.

" } }, "documentation":"

The status of the DB parameter group.

This data type is used as a response element in the following actions:

- CreateDBInstance

- DeleteDBInstance

- ModifyDBInstance

- RebootDBInstance

" }, "DBParameterGroupStatusList":{ "type":"list", "member":{ "shape":"DBParameterGroupStatus", "locationName":"DBParameterGroup" } }, "DBParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "DBParameterGroups":{ "shape":"DBParameterGroupList", "documentation":"

A list of DBParameterGroup instances.

" } } }, "DBSecurityGroupMembership":{ "type":"structure", "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the DB security group.

" } }, "documentation":"

Specifies membership in a designated DB security group.

" }, "DBSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"DBSecurityGroupMembership", "locationName":"DBSecurityGroup" } }, "DBSecurityGroupNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"DBSecurityGroupName" } }, "DBSecurityGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBSnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

", "error":{ "code":"DBSnapshotAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSnapshotNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBSubnetGroup":{ "type":"structure", "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the DB subnet group.

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

Provides the description of the DB subnet group.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VpcId of the DB subnet group.

" }, "SubnetGroupStatus":{ "shape":"String", "documentation":"

Provides the status of the DB subnet group.

" }, "Subnets":{ "shape":"SubnetList", "documentation":"

Contains a list of Subnet elements.

" }, "DBSubnetGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB subnet group.

" } }, "documentation":"

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

", "wrapper":true }, "DBSubnetGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

", "error":{ "code":"DBSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSubnetGroupDoesNotCoverEnoughAZs":{ "type":"structure", "members":{ }, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSubnetGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "DBSubnetGroups":{ "shape":"DBSubnetGroups", "documentation":"

A list of DBSubnetGroup instances.

" } } }, "DBSubnetGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBSubnetGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

", "error":{ "code":"DBSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSubnetGroups":{ "type":"list", "member":{ "shape":"DBSubnetGroup", "locationName":"DBSubnetGroup" } }, "DBSubnetQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

", "error":{ "code":"DBSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBUpgradeDependencyFailureFault":{ "type":"structure", "members":{ }, "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

", "error":{ "code":"DBUpgradeDependencyFailure", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DeleteDBClusterEndpointMessage":{ "type":"structure", "required":["DBClusterEndpointIdentifier"], "members":{ "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

" } } }, "DeleteDBClusterEndpointOutput":{ "type":"structure", "members":{ "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterEndpointResourceIdentifier":{ "shape":"String", "documentation":"

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" }, "Endpoint":{ "shape":"String", "documentation":"

The DNS address of the endpoint.

" }, "Status":{ "shape":"String", "documentation":"

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.

" }, "EndpointType":{ "shape":"String", "documentation":"

The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.

" }, "CustomEndpointType":{ "shape":"String", "documentation":"

The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`.

" }, "StaticMembers":{ "shape":"StringList", "documentation":"

List of DB instance identifiers that are part of the custom endpoint group.

" }, "ExcludedMembers":{ "shape":"StringList", "documentation":"

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.

" }, "DBClusterEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the endpoint.

" } }, "documentation":"

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

- `CreateDBClusterEndpoint`

- `DescribeDBClusterEndpoints`

- `ModifyDBClusterEndpoint`

- `DeleteDBClusterEndpoint`

For the data structure that represents Amazon RDS DB instance endpoints, see `Endpoint`.

" }, "DeleteDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

- Must match an existing DBClusterIdentifier.

" }, "SkipFinalSnapshot":{ "shape":"Boolean", "documentation":"

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`

" }, "FinalDBSnapshotIdentifier":{ "shape":"String", "documentation":"

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

" } } }, "DeleteDBClusterParameterGroupMessage":{ "type":"structure", "required":["DBClusterParameterGroupName"], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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.

" } } }, "DeleteDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "DeleteDBClusterSnapshotMessage":{ "type":"structure", "required":["DBClusterSnapshotIdentifier"], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the `available` state.

" } } }, "DeleteDBClusterSnapshotResult":{ "type":"structure", "members":{ "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} } }, "DeleteDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

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.

" }, "SkipFinalSnapshot":{ "shape":"Boolean", "documentation":"

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`

" }, "FinalDBSnapshotIdentifier":{ "shape":"String", "documentation":"

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.

" } } }, "DeleteDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "DeleteDBParameterGroupMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

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

" } } }, "DeleteDBSubnetGroupMessage":{ "type":"structure", "required":["DBSubnetGroupName"], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

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`

" } } }, "DeleteEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the event notification subscription you want to delete.

" } } }, "DeleteEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "DeleteGlobalClusterMessage":{ "type":"structure", "required":["GlobalClusterIdentifier"], "members":{ "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

The cluster identifier of the global database cluster being deleted.

" } } }, "DeleteGlobalClusterResult":{ "type":"structure", "members":{ "GlobalCluster":{"shape":"GlobalCluster"} } }, "DescribeDBClusterEndpointsMessage":{ "type":"structure", "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

" }, "Filters":{ "shape":"FilterList", "documentation":"

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`.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeDBClusterParameterGroupsMessage":{ "type":"structure", "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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

Constraints:

- If supplied, must match the name of an existing DBClusterParameterGroup.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeDBClusterParametersMessage":{ "type":"structure", "required":["DBClusterParameterGroupName"], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "Source":{ "shape":"String", "documentation":"

A value that indicates to return only parameters for a specific source. Parameter sources can be `engine`, `service`, or `customer`.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeDBClusterSnapshotAttributesMessage":{ "type":"structure", "required":["DBClusterSnapshotIdentifier"], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB cluster snapshot to describe the attributes for.

" } } }, "DescribeDBClusterSnapshotAttributesResult":{ "type":"structure", "members":{ "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} } }, "DescribeDBClusterSnapshotsMessage":{ "type":"structure", "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

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.

" }, "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

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.

" }, "SnapshotType":{ "shape":"String", "documentation":"

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`.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" }, "IncludeShared":{ "shape":"Boolean", "documentation":"

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 action.

" }, "IncludePublic":{ "shape":"Boolean", "documentation":"

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 action.

" } } }, "DescribeDBClustersMessage":{ "type":"structure", "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

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.

" }, "Filters":{ "shape":"FilterList", "documentation":"

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:

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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

" } } }, "DescribeDBEngineVersionsMessage":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The database engine to return.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The database engine version to return.

Example: `5.1.49`

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

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

Constraints:

- If supplied, must match an existing DBParameterGroupFamily.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" }, "DefaultOnly":{ "shape":"Boolean", "documentation":"

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

" }, "ListSupportedCharacterSets":{ "shape":"BooleanOptional", "documentation":"

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

" }, "ListSupportedTimezones":{ "shape":"BooleanOptional", "documentation":"

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.

" } } }, "DescribeDBInstancesMessage":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

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.

" }, "Filters":{ "shape":"FilterList", "documentation":"

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:

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeDBParameterGroupsMessage":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

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

Constraints:

- If supplied, must match the name of an existing DBClusterParameterGroup.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeDBParametersMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

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

Constraints:

- If supplied, must match the name of an existing DBParameterGroup.

" }, "Source":{ "shape":"String", "documentation":"

The parameter types to return.

Default: All parameter types returned

Valid Values: `user | system | engine-default`

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeDBSubnetGroupsMessage":{ "type":"structure", "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the DB subnet group to return details for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeEngineDefaultClusterParametersMessage":{ "type":"structure", "required":["DBParameterGroupFamily"], "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group family to return engine parameter information for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeEngineDefaultClusterParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, "DescribeEngineDefaultParametersMessage":{ "type":"structure", "required":["DBParameterGroupFamily"], "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the DB parameter group family.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeEngineDefaultParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, "DescribeEventCategoriesMessage":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The type of source that is generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" } } }, "DescribeEventSubscriptionsMessage":{ "type":"structure", "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the event notification subscription you want to describe.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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` .

" } } }, "DescribeEventsMessage":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

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.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

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.

Example: 2009-07-08T18:00Z

" }, "EndTime":{ "shape":"TStamp", "documentation":"

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.

Example: 2009-07-08T18:00Z

" }, "Duration":{ "shape":"IntegerOptional", "documentation":"

The number of minutes to retrieve events for.

Default: 60

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

A list of event categories that trigger notifications for a event notification subscription.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "DescribeGlobalClustersMessage":{ "type":"structure", "members":{ "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

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.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

(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`.

" } } }, "DescribeOrderableDBInstanceOptionsMessage":{ "type":"structure", "required":["Engine"], "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the engine to retrieve DB instance options for.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

" }, "Vpc":{ "shape":"BooleanOptional", "documentation":"

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "Marker":{ "shape":"String", "documentation":"

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` .

" } } }, "DescribePendingMaintenanceActionsMessage":{ "type":"structure", "members":{ "ResourceIdentifier":{ "shape":"String", "documentation":"

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

" }, "Filters":{ "shape":"FilterList", "documentation":"

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

Supported filters:

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

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

" }, "Marker":{ "shape":"String", "documentation":"

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

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

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.

" } } }, "DescribeValidDBInstanceModificationsMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The customer identifier or the ARN of your DB instance.

" } } }, "DescribeValidDBInstanceModificationsResult":{ "type":"structure", "members":{ "ValidDBInstanceModificationsMessage":{"shape":"ValidDBInstanceModificationsMessage"} } }, "DomainMembership":{ "type":"structure", "members":{ "Domain":{ "shape":"String", "documentation":"

The identifier of the Active Directory Domain.

" }, "Status":{ "shape":"String", "documentation":"

The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

" }, "FQDN":{ "shape":"String", "documentation":"

The fully qualified domain name of the Active Directory Domain.

" }, "IAMRoleName":{ "shape":"String", "documentation":"

The name of the IAM role to be used when making API calls to the Directory Service.

" } }, "documentation":"

An Active Directory Domain membership record associated with a DB instance.

" }, "DomainMembershipList":{ "type":"list", "member":{ "shape":"DomainMembership", "locationName":"DomainMembership" } }, "DomainNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

Domain does not refer to an existing Active Directory Domain.

", "error":{ "code":"DomainNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "Double":{"type":"double"}, "DoubleOptional":{"type":"double"}, "DoubleRange":{ "type":"structure", "members":{ "From":{ "shape":"Double", "documentation":"

The minimum value in the range.

" }, "To":{ "shape":"Double", "documentation":"

The maximum value in the range.

" } }, "documentation":"

A range of double values.

" }, "DoubleRangeList":{ "type":"list", "member":{ "shape":"DoubleRange", "locationName":"DoubleRange" } }, "Endpoint":{ "type":"structure", "members":{ "Address":{ "shape":"String", "documentation":"

Specifies the DNS address of the DB instance.

" }, "Port":{ "shape":"Integer", "documentation":"

Specifies the port that the database engine is listening on.

" }, "HostedZoneId":{ "shape":"String", "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" } }, "documentation":"

Specifies a connection endpoint.

For the data structure that represents Amazon Neptune DB cluster endpoints, see `DBClusterEndpoint`.

" }, "EngineDefaults":{ "type":"structure", "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

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

" }, "Marker":{ "shape":"String", "documentation":"

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

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

Contains a list of engine default parameters.

" } }, "documentation":"

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

", "wrapper":true }, "Event":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

Provides the identifier for the source of the event.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

Specifies the source type for this event.

" }, "Message":{ "shape":"String", "documentation":"

Provides the text of this event.

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

Specifies the category for the event.

" }, "Date":{ "shape":"TStamp", "documentation":"

Specifies the date and time of the event.

" }, "SourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the event.

" } }, "documentation":"

This data type is used as a response element in the DescribeEvents action.

" }, "EventCategoriesList":{ "type":"list", "member":{ "shape":"String", "locationName":"EventCategory" } }, "EventCategoriesMap":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The source type that the returned categories belong to

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

The event categories for the specified source type

" } }, "documentation":"

Contains the results of a successful invocation of the DescribeEventCategories action.

", "wrapper":true }, "EventCategoriesMapList":{ "type":"list", "member":{ "shape":"EventCategoriesMap", "locationName":"EventCategoriesMap" } }, "EventCategoriesMessage":{ "type":"structure", "members":{ "EventCategoriesMapList":{ "shape":"EventCategoriesMapList", "documentation":"

A list of EventCategoriesMap data types.

" } } }, "EventList":{ "type":"list", "member":{ "shape":"Event", "locationName":"Event" } }, "EventSubscription":{ "type":"structure", "members":{ "CustomerAwsId":{ "shape":"String", "documentation":"

The Amazon customer account associated with the event notification subscription.

" }, "CustSubscriptionId":{ "shape":"String", "documentation":"

The event notification subscription Id.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The topic ARN of the event notification subscription.

" }, "Status":{ "shape":"String", "documentation":"

The status of the event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that Neptune no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" }, "SubscriptionCreationTime":{ "shape":"String", "documentation":"

The time the event notification subscription was created.

" }, "SourceType":{ "shape":"String", "documentation":"

The source type for the event notification subscription.

" }, "SourceIdsList":{ "shape":"SourceIdsList", "documentation":"

A list of source IDs for the event notification subscription.

" }, "EventCategoriesList":{ "shape":"EventCategoriesList", "documentation":"

A list of event categories for the event notification subscription.

" }, "Enabled":{ "shape":"Boolean", "documentation":"

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" }, "EventSubscriptionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the event subscription.

" } }, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", "wrapper":true }, "EventSubscriptionQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

You have exceeded the number of events you can subscribe to.

", "error":{ "code":"EventSubscriptionQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "EventSubscriptionsList":{ "type":"list", "member":{ "shape":"EventSubscription", "locationName":"EventSubscription" } }, "EventSubscriptionsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "EventSubscriptionsList":{ "shape":"EventSubscriptionsList", "documentation":"

A list of EventSubscriptions data types.

" } } }, "EventsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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` .

" }, "Events":{ "shape":"EventList", "documentation":"

A list of Event instances.

" } } }, "FailoverDBClusterMessage":{ "type":"structure", "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

- Must match the identifier of an existing DBCluster.

" }, "TargetDBInstanceIdentifier":{ "shape":"String", "documentation":"

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`.

" } } }, "FailoverDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "FailoverGlobalClusterMessage":{ "type":"structure", "required":[ "GlobalClusterIdentifier", "TargetDbClusterIdentifier" ], "members":{ "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

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.

" }, "TargetDbClusterIdentifier":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.

" } } }, "FailoverGlobalClusterResult":{ "type":"structure", "members":{ "GlobalCluster":{"shape":"GlobalCluster"} } }, "Filter":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"String", "documentation":"

This parameter is not currently supported.

" }, "Values":{ "shape":"FilterValueList", "documentation":"

This parameter is not currently supported.

" } }, "documentation":"

This type is not currently supported.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FilterValueList":{ "type":"list", "member":{ "shape":"String", "locationName":"Value" } }, "GlobalCluster":{ "type":"structure", "members":{ "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.

" }, "GlobalClusterResourceId":{ "shape":"String", "documentation":"

An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

" }, "GlobalClusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the global database.

" }, "Status":{ "shape":"String", "documentation":"

Specifies the current state of this global database.

" }, "Engine":{ "shape":"String", "documentation":"

The Neptune database engine used by the global database (`\"neptune\"`).

" }, "EngineVersion":{ "shape":"String", "documentation":"

The Neptune engine version used by the global database.

" }, "StorageEncrypted":{ "shape":"BooleanOptional", "documentation":"

The storage encryption setting for the global database.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

The deletion protection setting for the global database.

" }, "GlobalClusterMembers":{ "shape":"GlobalClusterMemberList", "documentation":"

A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

" } }, "documentation":"

Contains the details of an Amazon Neptune global database.

This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

", "wrapper":true }, "GlobalClusterAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The `GlobalClusterIdentifier` already exists. Choose a new global database identifier (unique name) to create a new global database cluster.

", "error":{ "code":"GlobalClusterAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "GlobalClusterIdentifier":{ "type":"string", "max":255, "min":1, "pattern":"[A-Za-z][0-9A-Za-z-:._]*" }, "GlobalClusterList":{ "type":"list", "member":{ "shape":"GlobalCluster", "locationName":"GlobalClusterMember" } }, "GlobalClusterMember":{ "type":"structure", "members":{ "DBClusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for each Neptune cluster.

" }, "Readers":{ "shape":"ReadersArnList", "documentation":"

The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.

" }, "IsWriter":{ "shape":"Boolean", "documentation":"

Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.

" } }, "documentation":"

A data structure with information about any primary and secondary clusters associated with an Neptune global database.

", "wrapper":true }, "GlobalClusterMemberList":{ "type":"list", "member":{ "shape":"GlobalClusterMember", "locationName":"GlobalClusterMember" } }, "GlobalClusterNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The `GlobalClusterIdentifier` doesn't refer to an existing global database cluster.

", "error":{ "code":"GlobalClusterNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "GlobalClusterQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The number of global database clusters for this account is already at the maximum allowed.

", "error":{ "code":"GlobalClusterQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "GlobalClustersMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

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`.

" }, "GlobalClusters":{ "shape":"GlobalClusterList", "documentation":"

The list of global clusters and instances returned by this request.

" } } }, "InstanceQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB instances.

", "error":{ "code":"InstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InsufficientDBClusterCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

The DB cluster does not have enough capacity for the current operation.

", "error":{ "code":"InsufficientDBClusterCapacityFault", "httpStatusCode":403, "senderFault":true }, "exception":true }, "InsufficientDBInstanceCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

", "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InsufficientStorageClusterCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

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.

", "error":{ "code":"InsufficientStorageClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, "InvalidDBClusterEndpointStateFault":{ "type":"structure", "members":{ }, "documentation":"

The requested operation cannot be performed on the endpoint while the endpoint is in this state.

", "error":{ "code":"InvalidDBClusterEndpointStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBClusterSnapshotStateFault":{ "type":"structure", "members":{ }, "documentation":"

The supplied value is not a valid DB cluster snapshot state.

", "error":{ "code":"InvalidDBClusterSnapshotStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBClusterStateFault":{ "type":"structure", "members":{ }, "documentation":"

The DB cluster is not in a valid state.

", "error":{ "code":"InvalidDBClusterStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBInstanceStateFault":{ "type":"structure", "members":{ }, "documentation":"

The specified DB instance is not in the available state.

", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBParameterGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

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.

", "error":{ "code":"InvalidDBParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSecurityGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The state of the DB security group does not allow deletion.

", "error":{ "code":"InvalidDBSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSnapshotStateFault":{ "type":"structure", "members":{ }, "documentation":"

The state of the DB snapshot does not allow deletion.

", "error":{ "code":"InvalidDBSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSubnetGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The DB subnet group cannot be deleted because it is in use.

", "error":{ "code":"InvalidDBSubnetGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSubnetStateFault":{ "type":"structure", "members":{ }, "documentation":"

The DB subnet is not in the available state.

", "error":{ "code":"InvalidDBSubnetStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidEventSubscriptionStateFault":{ "type":"structure", "members":{ }, "documentation":"

The event subscription is in an invalid state.

", "error":{ "code":"InvalidEventSubscriptionState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidGlobalClusterStateFault":{ "type":"structure", "members":{ }, "documentation":"

The global cluster is in an invalid state and can't perform the requested operation.

", "error":{ "code":"InvalidGlobalClusterStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidRestoreFault":{ "type":"structure", "members":{ }, "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

", "error":{ "code":"InvalidRestoreFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSubnet":{ "type":"structure", "members":{ }, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidVPCNetworkStateFault":{ "type":"structure", "members":{ }, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KMSKeyNotAccessibleFault":{ "type":"structure", "members":{ }, "documentation":"

Error accessing KMS key.

", "error":{ "code":"KMSKeyNotAccessibleFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KeyList":{ "type":"list", "member":{"shape":"String"} }, "ListTagsForResourceMessage":{ "type":"structure", "required":["ResourceName"], "members":{ "ResourceName":{ "shape":"String", "documentation":"

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).

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" } } }, "LogTypeList":{ "type":"list", "member":{"shape":"String"} }, "ModifyDBClusterEndpointMessage":{ "type":"structure", "required":["DBClusterEndpointIdentifier"], "members":{ "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

" }, "EndpointType":{ "shape":"String", "documentation":"

The type of the endpoint. One of: `READER`, `WRITER`, `ANY`.

" }, "StaticMembers":{ "shape":"StringList", "documentation":"

List of DB instance identifiers that are part of the custom endpoint group.

" }, "ExcludedMembers":{ "shape":"StringList", "documentation":"

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.

" } } }, "ModifyDBClusterEndpointOutput":{ "type":"structure", "members":{ "DBClusterEndpointIdentifier":{ "shape":"String", "documentation":"

The identifier associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

" }, "DBClusterEndpointResourceIdentifier":{ "shape":"String", "documentation":"

A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

" }, "Endpoint":{ "shape":"String", "documentation":"

The DNS address of the endpoint.

" }, "Status":{ "shape":"String", "documentation":"

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.

" }, "EndpointType":{ "shape":"String", "documentation":"

The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`.

" }, "CustomEndpointType":{ "shape":"String", "documentation":"

The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`.

" }, "StaticMembers":{ "shape":"StringList", "documentation":"

List of DB instance identifiers that are part of the custom endpoint group.

" }, "ExcludedMembers":{ "shape":"StringList", "documentation":"

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.

" }, "DBClusterEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the endpoint.

" } }, "documentation":"

This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions:

- `CreateDBClusterEndpoint`

- `DescribeDBClusterEndpoints`

- `ModifyDBClusterEndpoint`

- `DeleteDBClusterEndpoint`

For the data structure that represents Amazon RDS DB instance endpoints, see `Endpoint`.

" }, "ModifyDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

- Must match the identifier of an existing DBCluster.

" }, "NewDBClusterIdentifier":{ "shape":"String", "documentation":"

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`

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

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`

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

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

" }, "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to use for the DB cluster.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of VPC security groups that the DB cluster will belong to.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

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.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

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.

" }, "EnableIAMDatabaseAuthentication":{ "shape":"BooleanOptional", "documentation":"

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: `false`

" }, "CloudwatchLogsExportConfiguration":{ "shape":"CloudwatchLogsExportConfiguration", "documentation":"

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.

" }, "EngineVersion":{ "shape":"String", "documentation":"

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, or call DescribeDBEngineVersions.

" }, "AllowMajorVersionUpgrade":{ "shape":"Boolean", "documentation":"

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.

" }, "DBInstanceParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

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.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

If set to `true`, tags are copied to any snapshot of the DB cluster that is created.

" }, "ServerlessV2ScalingConfiguration":{ "shape":"ServerlessV2ScalingConfiguration", "documentation":"

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

" }, "StorageType":{ "shape":"String", "documentation":"

The storage type to associate with the DB cluster.

Valid Values:

- `standard | iopt1`

Default:

- `standard`

" } } }, "ModifyDBClusterParameterGroupMessage":{ "type":"structure", "required":[ "DBClusterParameterGroupName", "Parameters" ], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to modify.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

A list of parameters in the DB cluster parameter group to modify.

" } } }, "ModifyDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "ModifyDBClusterSnapshotAttributeMessage":{ "type":"structure", "required":[ "DBClusterSnapshotIdentifier", "AttributeName" ], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB cluster snapshot to modify the attributes for.

" }, "AttributeName":{ "shape":"String", "documentation":"

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`.

" }, "ValuesToAdd":{ "shape":"AttributeValueList", "documentation":"

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.

" }, "ValuesToRemove":{ "shape":"AttributeValueList", "documentation":"

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.

" } } }, "ModifyDBClusterSnapshotAttributeResult":{ "type":"structure", "members":{ "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} } }, "ModifyDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

- Must match the identifier of an existing DBInstance.

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

Not supported by Neptune.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

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

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

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`

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupNameList", "documentation":"

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.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

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.

Constraints:

- If supplied, must match existing VpcSecurityGroupIds.

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

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, or the next failure reboot.

Default: `false`

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "DBParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

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.

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

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

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 | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

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.

" }, "EngineVersion":{ "shape":"String", "documentation":"

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.

" }, "AllowMajorVersionUpgrade":{ "shape":"Boolean", "documentation":"

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.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

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.

" }, "LicenseModel":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

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

" }, "OptionGroupName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "NewDBInstanceIdentifier":{ "shape":"String", "documentation":"

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`

" }, "StorageType":{ "shape":"String", "documentation":"

Not supported.

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the key store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"SensitiveString", "documentation":"

The password for the given ARN from the key store in order to access the device.

" }, "CACertificateIdentifier":{ "shape":"String", "documentation":"

Indicates the certificate that needs to be associated with the instance.

" }, "Domain":{ "shape":"String", "documentation":"

Not supported.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

" }, "MonitoringInterval":{ "shape":"IntegerOptional", "documentation":"

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`

" }, "DBPortNumber":{ "shape":"IntegerOptional", "documentation":"

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`

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

This flag should no longer be used.

", "deprecated":true }, "MonitoringRoleArn":{ "shape":"String", "documentation":"

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.

" }, "DomainIAMRoleName":{ "shape":"String", "documentation":"

Not supported

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

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

" }, "EnableIAMDatabaseAuthentication":{ "shape":"BooleanOptional", "documentation":"

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.

Default: `false`

" }, "EnablePerformanceInsights":{ "shape":"BooleanOptional", "documentation":"

(Not supported by Neptune)

" }, "PerformanceInsightsKMSKeyId":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "CloudwatchLogsExportConfiguration":{ "shape":"CloudwatchLogsExportConfiguration", "documentation":"

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

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

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.

" } } }, "ModifyDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "ModifyDBParameterGroupMessage":{ "type":"structure", "required":[ "DBParameterGroupName", "Parameters" ], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

- If supplied, must match the name of an existing DBParameterGroup.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

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.

" } } }, "ModifyDBSubnetGroupMessage":{ "type":"structure", "required":[ "DBSubnetGroupName", "SubnetIds" ], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

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`

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

The description for the DB subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 subnet IDs for the DB subnet group.

" } } }, "ModifyDBSubnetGroupResult":{ "type":"structure", "members":{ "DBSubnetGroup":{"shape":"DBSubnetGroup"} } }, "ModifyEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the event notification subscription.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

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.

" }, "SourceType":{ "shape":"String", "documentation":"

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 | db-parameter-group | db-security-group | db-snapshot

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

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.

" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value; set to true to activate the subscription.

" } } }, "ModifyEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "ModifyGlobalClusterMessage":{ "type":"structure", "required":["GlobalClusterIdentifier"], "members":{ "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

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.

" }, "NewGlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

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`

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.

" }, "EngineVersion":{ "shape":"String", "documentation":"

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:

" }, "AllowMajorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

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.

" } } }, "ModifyGlobalClusterResult":{ "type":"structure", "members":{ "GlobalCluster":{"shape":"GlobalCluster"} } }, "OptionGroupMembership":{ "type":"structure", "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "Status":{ "shape":"String", "documentation":"

Not supported by Neptune.

" } }, "documentation":"

Not supported by Neptune.

" }, "OptionGroupMembershipList":{ "type":"list", "member":{ "shape":"OptionGroupMembership", "locationName":"OptionGroupMembership" } }, "OptionGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The designated option group could not be found.

", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "OrderableDBInstanceOption":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The engine type of a DB instance.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version of a DB instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class for a DB instance.

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model for a DB instance.

" }, "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

A list of Availability Zones for a DB instance.

" }, "MultiAZCapable":{ "shape":"Boolean", "documentation":"

Indicates whether a DB instance is Multi-AZ capable.

" }, "ReadReplicaCapable":{ "shape":"Boolean", "documentation":"

Indicates whether a DB instance can have a Read Replica.

" }, "Vpc":{ "shape":"Boolean", "documentation":"

Indicates whether a DB instance is in a VPC.

" }, "SupportsStorageEncryption":{ "shape":"Boolean", "documentation":"

Indicates whether a DB instance supports encrypted storage.

" }, "StorageType":{ "shape":"String", "documentation":"

Indicates the storage type for a DB instance.

" }, "SupportsIops":{ "shape":"Boolean", "documentation":"

Indicates whether a DB instance supports provisioned IOPS.

" }, "SupportsEnhancedMonitoring":{ "shape":"Boolean", "documentation":"

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

" }, "SupportsIAMDatabaseAuthentication":{ "shape":"Boolean", "documentation":"

Indicates whether a DB instance supports IAM database authentication.

" }, "SupportsPerformanceInsights":{ "shape":"Boolean", "documentation":"

(Not supported by Neptune)

" }, "MinStorageSize":{ "shape":"IntegerOptional", "documentation":"

Minimum storage size for a DB instance.

" }, "MaxStorageSize":{ "shape":"IntegerOptional", "documentation":"

Maximum storage size for a DB instance.

" }, "MinIopsPerDbInstance":{ "shape":"IntegerOptional", "documentation":"

Minimum total provisioned IOPS for a DB instance.

" }, "MaxIopsPerDbInstance":{ "shape":"IntegerOptional", "documentation":"

Maximum total provisioned IOPS for a DB instance.

" }, "MinIopsPerGib":{ "shape":"DoubleOptional", "documentation":"

Minimum provisioned IOPS per GiB for a DB instance.

" }, "MaxIopsPerGib":{ "shape":"DoubleOptional", "documentation":"

Maximum provisioned IOPS per GiB for a DB instance.

" }, "SupportsGlobalDatabases":{ "shape":"Boolean", "documentation":"

A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes.

" } }, "documentation":"

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

", "wrapper":true }, "OrderableDBInstanceOptionsList":{ "type":"list", "member":{ "shape":"OrderableDBInstanceOption", "locationName":"OrderableDBInstanceOption" } }, "OrderableDBInstanceOptionsMessage":{ "type":"structure", "members":{ "OrderableDBInstanceOptions":{ "shape":"OrderableDBInstanceOptionsList", "documentation":"

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" }, "Marker":{ "shape":"String", "documentation":"

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` .

" } } }, "Parameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

Specifies the name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

Specifies the value of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

Provides a description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

Indicates the source of the parameter value.

" }, "ApplyType":{ "shape":"String", "documentation":"

Specifies the engine specific parameters type.

" }, "DataType":{ "shape":"String", "documentation":"

Specifies the valid data type for the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

Specifies the valid range of values for the parameter.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Indicates whether (`true`) or not (`false`) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest engine version to which the parameter can apply.

" }, "ApplyMethod":{ "shape":"ApplyMethod", "documentation":"

Indicates when to apply parameter updates.

" } }, "documentation":"

Specifies a parameter.

" }, "ParametersList":{ "type":"list", "member":{ "shape":"Parameter", "locationName":"Parameter" } }, "PendingCloudwatchLogsExports":{ "type":"structure", "members":{ "LogTypesToEnable":{ "shape":"LogTypeList", "documentation":"

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

" }, "LogTypesToDisable":{ "shape":"LogTypeList", "documentation":"

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

" } }, "documentation":"

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

Valid log types are: `audit` (to publish audit logs) and `slowquery` (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

" }, "PendingMaintenanceAction":{ "type":"structure", "members":{ "Action":{ "shape":"String", "documentation":"

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

" }, "AutoAppliedAfterDate":{ "shape":"TStamp", "documentation":"

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

" }, "ForcedApplyDate":{ "shape":"TStamp", "documentation":"

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

" }, "OptInStatus":{ "shape":"String", "documentation":"

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

" }, "CurrentApplyDate":{ "shape":"TStamp", "documentation":"

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

" }, "Description":{ "shape":"String", "documentation":"

A description providing more detail about the maintenance action.

" } }, "documentation":"

Provides information about a pending maintenance action for a resource.

" }, "PendingMaintenanceActionDetails":{ "type":"list", "member":{ "shape":"PendingMaintenanceAction", "locationName":"PendingMaintenanceAction" } }, "PendingMaintenanceActions":{ "type":"list", "member":{ "shape":"ResourcePendingMaintenanceActions", "locationName":"ResourcePendingMaintenanceActions" } }, "PendingMaintenanceActionsMessage":{ "type":"structure", "members":{ "PendingMaintenanceActions":{ "shape":"PendingMaintenanceActions", "documentation":"

A list of the pending maintenance actions for the resource.

" }, "Marker":{ "shape":"String", "documentation":"

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`.

" } } }, "PendingModifiedValues":{ "type":"structure", "members":{ "DBInstanceClass":{ "shape":"String", "documentation":"

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

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

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

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

Specifies the pending port for the DB instance.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

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

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

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

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "LicenseModel":{ "shape":"String", "documentation":"

Not supported by Neptune.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

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

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

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

" }, "StorageType":{ "shape":"String", "documentation":"

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

" }, "CACertificateIdentifier":{ "shape":"String", "documentation":"

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

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The new DB subnet group for the DB instance.

" }, "PendingCloudwatchLogsExports":{ "shape":"PendingCloudwatchLogsExports", "documentation":"

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

" } }, "documentation":"

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

" }, "PromoteReadReplicaDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

Not supported.

" } } }, "PromoteReadReplicaDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "ProvisionedIopsNotAvailableInAZFault":{ "type":"structure", "members":{ }, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Range":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The minimum value in the range.

" }, "To":{ "shape":"Integer", "documentation":"

The maximum value in the range.

" }, "Step":{ "shape":"IntegerOptional", "documentation":"

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

" } }, "documentation":"

A range of integer values.

" }, "RangeList":{ "type":"list", "member":{ "shape":"Range", "locationName":"Range" } }, "ReadReplicaDBClusterIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReadReplicaDBClusterIdentifier" } }, "ReadReplicaDBInstanceIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReadReplicaDBInstanceIdentifier" } }, "ReadReplicaIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReadReplicaIdentifier" } }, "ReadersArnList":{ "type":"list", "member":{"shape":"String"} }, "RebootDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

- Must match the identifier of an existing DBInstance.

" }, "ForceFailover":{ "shape":"BooleanOptional", "documentation":"

When `true`, the reboot is conducted through a MultiAZ failover.

Constraint: You can't specify `true` if the instance is not configured for MultiAZ.

" } } }, "RebootDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "RemoveFromGlobalClusterMessage":{ "type":"structure", "required":[ "GlobalClusterIdentifier", "DbClusterIdentifier" ], "members":{ "GlobalClusterIdentifier":{ "shape":"GlobalClusterIdentifier", "documentation":"

The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.

" }, "DbClusterIdentifier":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) identifying the cluster to be detached from the Neptune global database cluster.

" } } }, "RemoveFromGlobalClusterResult":{ "type":"structure", "members":{ "GlobalCluster":{"shape":"GlobalCluster"} } }, "RemoveRoleFromDBClusterMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "RoleArn" ], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The name of the DB cluster to disassociate the IAM role from.

" }, "RoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example `arn:aws:iam::123456789012:role/NeptuneAccessRole`.

" }, "FeatureName":{ "shape":"String", "documentation":"

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.

" } } }, "RemoveSourceIdentifierFromSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SourceIdentifier" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the event notification subscription you want to remove a source identifier from.

" }, "SourceIdentifier":{ "shape":"String", "documentation":"

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.

" } } }, "RemoveSourceIdentifierFromSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "RemoveTagsFromResourceMessage":{ "type":"structure", "required":[ "ResourceName", "TagKeys" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

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

" }, "TagKeys":{ "shape":"KeyList", "documentation":"

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

" } } }, "ResetDBClusterParameterGroupMessage":{ "type":"structure", "required":["DBClusterParameterGroupName"], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to reset.

" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

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.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

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`.

" } } }, "ResetDBParameterGroupMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

- Must match the name of an existing DBParameterGroup.

" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

Specifies whether (`true`) or not (`false`) to reset all parameters in the DB parameter group to default values.

Default: `true`

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

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`

" } } }, "ResourceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified resource ID was not found.

", "error":{ "code":"ResourceNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourcePendingMaintenanceActions":{ "type":"structure", "members":{ "ResourceIdentifier":{ "shape":"String", "documentation":"

The ARN of the resource that has pending maintenance actions.

" }, "PendingMaintenanceActionDetails":{ "shape":"PendingMaintenanceActionDetails", "documentation":"

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

" } }, "documentation":"

Describes the pending maintenance actions for a resource.

", "wrapper":true }, "RestoreDBClusterFromSnapshotMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "SnapshotIdentifier", "Engine" ], "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

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`

" }, "SnapshotIdentifier":{ "shape":"String", "documentation":"

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.

" }, "Engine":{ "shape":"String", "documentation":"

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

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version of the database engine to use for the new DB cluster.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

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`

" }, "DatabaseName":{ "shape":"String", "documentation":"

Not supported.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of VPC security groups that the new DB cluster will belong to.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the restored DB cluster.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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.

" }, "EnableIAMDatabaseAuthentication":{ "shape":"BooleanOptional", "documentation":"

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: `false`

" }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", "documentation":"

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

" }, "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

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.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

If set to `true`, tags are copied to any snapshot of the restored DB cluster that is created.

" }, "ServerlessV2ScalingConfiguration":{ "shape":"ServerlessV2ScalingConfiguration", "documentation":"

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

" }, "StorageType":{ "shape":"String", "documentation":"

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

Valid values: `standard`, `iopt1`

Default: `standard`

" } } }, "RestoreDBClusterFromSnapshotResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "RestoreDBClusterToPointInTimeMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "SourceDBClusterIdentifier" ], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

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

" }, "RestoreType":{ "shape":"String", "documentation":"

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.

" }, "SourceDBClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the source DB cluster from which to restore.

Constraints:

- Must match the identifier of an existing DBCluster.

" }, "RestoreToTime":{ "shape":"TStamp", "documentation":"

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`

" }, "UseLatestRestorableTime":{ "shape":"Boolean", "documentation":"

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.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

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.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

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`

" }, "OptionGroupName":{ "shape":"String", "documentation":"

(Not supported by Neptune)

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of VPC security groups that the new DB cluster belongs to.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be applied to the restored DB cluster.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

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.

" }, "EnableIAMDatabaseAuthentication":{ "shape":"BooleanOptional", "documentation":"

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: `false`

" }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", "documentation":"

The list of logs that the restored DB cluster is to export to CloudWatch Logs.

" }, "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

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.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

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.

" }, "ServerlessV2ScalingConfiguration":{ "shape":"ServerlessV2ScalingConfiguration", "documentation":"

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

" }, "StorageType":{ "shape":"String", "documentation":"

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

Valid values: `standard`, `iopt1`

Default: `standard`

" } } }, "RestoreDBClusterToPointInTimeResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "SNSInvalidTopicFault":{ "type":"structure", "members":{ }, "documentation":"

The SNS topic is invalid.

", "error":{ "code":"SNSInvalidTopic", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SNSNoAuthorizationFault":{ "type":"structure", "members":{ }, "documentation":"

There is no SNS authorization.

", "error":{ "code":"SNSNoAuthorization", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SNSTopicArnNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The ARN of the SNS topic could not be found.

", "error":{ "code":"SNSTopicArnNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SensitiveString":{ "type":"string", "sensitive":true }, "ServerlessV2ScalingConfiguration":{ "type":"structure", "members":{ "MinCapacity":{ "shape":"DoubleOptional", "documentation":"

The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

" }, "MaxCapacity":{ "shape":"DoubleOptional", "documentation":"

The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

" } }, "documentation":"

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

" }, "ServerlessV2ScalingConfigurationInfo":{ "type":"structure", "members":{ "MinCapacity":{ "shape":"DoubleOptional", "documentation":"

The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

" }, "MaxCapacity":{ "shape":"DoubleOptional", "documentation":"

The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

" } }, "documentation":"

Shows the scaling configuration for a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

" }, "SharedSnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", "error":{ "code":"SharedSnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

", "error":{ "code":"SnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SourceIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SourceId" } }, "SourceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The source could not be found.

", "error":{ "code":"SourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SourceType":{ "type":"string", "enum":[ "db-instance", "db-parameter-group", "db-security-group", "db-snapshot", "db-cluster", "db-cluster-snapshot" ] }, "StartDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string.

" } } }, "StartDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "StopDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string.

" } } }, "StopDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "StorageQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

", "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "StorageTypeNotSupportedFault":{ "type":"structure", "members":{ }, "documentation":"

StorageType specified cannot be associated with the DB Instance.

", "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Subnet":{ "type":"structure", "members":{ "SubnetIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier of the subnet.

" }, "SubnetAvailabilityZone":{ "shape":"AvailabilityZone", "documentation":"

Specifies the EC2 Availability Zone that the subnet is in.

" }, "SubnetStatus":{ "shape":"String", "documentation":"

Specifies the status of the subnet.

" } }, "documentation":"

Specifies a subnet.

This data type is used as a response element in the DescribeDBSubnetGroups action.

" }, "SubnetAlreadyInUse":{ "type":"structure", "members":{ }, "documentation":"

The DB subnet is already in use in the Availability Zone.

", "error":{ "code":"SubnetAlreadyInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SubnetIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetIdentifier" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"Subnet" } }, "SubscriptionAlreadyExistFault":{ "type":"structure", "members":{ }, "documentation":"

This subscription already exists.

", "error":{ "code":"SubscriptionAlreadyExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SubscriptionCategoryNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The designated subscription category could not be found.

", "error":{ "code":"SubscriptionCategoryNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SubscriptionNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The designated subscription could not be found.

", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SupportedCharacterSetsList":{ "type":"list", "member":{ "shape":"CharacterSet", "locationName":"CharacterSet" } }, "SupportedTimezonesList":{ "type":"list", "member":{ "shape":"Timezone", "locationName":"Timezone" } }, "TStamp":{"type":"timestamp"}, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

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

" }, "Value":{ "shape":"String", "documentation":"

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

" } }, "documentation":"

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

" }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagListMessage":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

List of tags returned by the ListTagsForResource operation.

" } } }, "Timezone":{ "type":"structure", "members":{ "TimezoneName":{ "shape":"String", "documentation":"

The name of the time zone.

" } }, "documentation":"

A time zone associated with a DBInstance.

" }, "UpgradeTarget":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the upgrade target database engine.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the upgrade target database engine.

" }, "Description":{ "shape":"String", "documentation":"

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

" }, "AutoUpgrade":{ "shape":"Boolean", "documentation":"

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

" }, "IsMajorVersionUpgrade":{ "shape":"Boolean", "documentation":"

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

" }, "SupportsGlobalDatabases":{ "shape":"BooleanOptional", "documentation":"

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

" } }, "documentation":"

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

" }, "ValidDBInstanceModificationsMessage":{ "type":"structure", "members":{ "Storage":{ "shape":"ValidStorageOptionsList", "documentation":"

Valid storage options for your DB instance.

" } }, "documentation":"

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

", "wrapper":true }, "ValidStorageOptions":{ "type":"structure", "members":{ "StorageType":{ "shape":"String", "documentation":"

The valid storage types for your DB instance. For example, gp2, io1.

" }, "StorageSize":{ "shape":"RangeList", "documentation":"

The valid range of storage in gibibytes. For example, 100 to 16384.

" }, "ProvisionedIops":{ "shape":"RangeList", "documentation":"

The valid range of provisioned IOPS. For example, 1000-20000.

" }, "IopsToStorageRatio":{ "shape":"DoubleRangeList", "documentation":"

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

" } }, "documentation":"

Information about valid modifications that you can make to your DB instance.

Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

" }, "ValidStorageOptionsList":{ "type":"list", "member":{ "shape":"ValidStorageOptions", "locationName":"ValidStorageOptions" } }, "ValidUpgradeTargetList":{ "type":"list", "member":{ "shape":"UpgradeTarget", "locationName":"UpgradeTarget" } }, "VpcSecurityGroupIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcSecurityGroupId" } }, "VpcSecurityGroupMembership":{ "type":"structure", "members":{ "VpcSecurityGroupId":{ "shape":"String", "documentation":"

The name of the VPC security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the VPC security group.

" } }, "documentation":"

This data type is used as a response element for queries on VPC security group membership.

" }, "VpcSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"VpcSecurityGroupMembership", "locationName":"VpcSecurityGroupMembership" } } }, "documentation":"Amazon Neptune

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.

This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

" }