@datafire/amazonaws_neptune v5.0.0
@datafire/amazonaws_neptune
Client library for Amazon Neptune
Installation and Usage
npm install --save @datafire/amazonaws_neptune
let amazonaws_neptune = require('@datafire/amazonaws_neptune').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_neptune.AddRoleToDBCluster({
"DBClusterIdentifier": "",
"RoleArn": ""
}).then(data => {
console.log(data);
});
Description
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. Amazon Neptune API Reference
Actions
AddRoleToDBCluster
amazonaws_neptune.AddRoleToDBCluster({
"DBClusterIdentifier": "",
"RoleArn": ""
}, context)
Input
Output
Output schema unknown
AddSourceIdentifierToSubscription
amazonaws_neptune.AddSourceIdentifierToSubscription({
"SubscriptionName": "",
"SourceIdentifier": ""
}, context)
Input
Output
AddTagsToResource
amazonaws_neptune.AddTagsToResource({
"ResourceName": "",
"Tags": []
}, context)
Input
Output
Output schema unknown
ApplyPendingMaintenanceAction
amazonaws_neptune.ApplyPendingMaintenanceAction({
"ResourceIdentifier": "",
"ApplyAction": "",
"OptInType": ""
}, context)
Input
Output
CopyDBClusterParameterGroup
amazonaws_neptune.CopyDBClusterParameterGroup({
"SourceDBClusterParameterGroupIdentifier": "",
"TargetDBClusterParameterGroupIdentifier": "",
"TargetDBClusterParameterGroupDescription": ""
}, context)
Input
- input
object
Output
CopyDBClusterSnapshot
amazonaws_neptune.CopyDBClusterSnapshot({
"SourceDBClusterSnapshotIdentifier": "",
"TargetDBClusterSnapshotIdentifier": ""
}, context)
Input
- input
object
Output
- output CopyDBClusterSnapshotResult
CopyDBParameterGroup
amazonaws_neptune.CopyDBParameterGroup({
"SourceDBParameterGroupIdentifier": "",
"TargetDBParameterGroupIdentifier": "",
"TargetDBParameterGroupDescription": ""
}, context)
Input
- input
object
Output
- output CopyDBParameterGroupResult
CreateDBCluster
amazonaws_neptune.CreateDBCluster({
"DBClusterIdentifier": "",
"Engine": ""
}, context)
Input
- input
object
- AvailabilityZones AvailabilityZones
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- DBClusterIdentifier required String
- DBClusterParameterGroupName String
- DBSubnetGroupName String
- DatabaseName String
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine required String
- EngineVersion String
- KmsKeyId String
- MasterUserPassword String
- MasterUsername String
- OptionGroupName String
- Port IntegerOptional
- PreSignedUrl String
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- ReplicationSourceIdentifier String
- StorageEncrypted BooleanOptional
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output CreateDBClusterResult
CreateDBClusterParameterGroup
amazonaws_neptune.CreateDBClusterParameterGroup({
"DBClusterParameterGroupName": "",
"DBParameterGroupFamily": "",
"Description": ""
}, context)
Input
- input
object
Output
CreateDBClusterSnapshot
amazonaws_neptune.CreateDBClusterSnapshot({
"DBClusterSnapshotIdentifier": "",
"DBClusterIdentifier": ""
}, context)
Input
- input
object
Output
CreateDBInstance
amazonaws_neptune.CreateDBInstance({
"DBInstanceIdentifier": "",
"DBInstanceClass": "",
"Engine": ""
}, context)
Input
- input
object
- AllocatedStorage IntegerOptional
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- CopyTagsToSnapshot BooleanOptional
- DBClusterIdentifier String
- DBInstanceClass required String
- DBInstanceIdentifier required String
- DBName String
- DBParameterGroupName String
- DBSecurityGroups DBSecurityGroupNameList
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- Engine required String
- EngineVersion String
- Iops IntegerOptional
- KmsKeyId String
- LicenseModel String
- MasterUserPassword String
- MasterUsername String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PromotionTier IntegerOptional
- PubliclyAccessible BooleanOptional
- StorageEncrypted BooleanOptional
- StorageType String
- Tags TagList
- TdeCredentialArn String
- TdeCredentialPassword String
- Timezone String
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output CreateDBInstanceResult
CreateDBParameterGroup
amazonaws_neptune.CreateDBParameterGroup({
"DBParameterGroupName": "",
"DBParameterGroupFamily": "",
"Description": ""
}, context)
Input
- input
object
Output
- output CreateDBParameterGroupResult
CreateDBSubnetGroup
amazonaws_neptune.CreateDBSubnetGroup({
"DBSubnetGroupName": "",
"DBSubnetGroupDescription": "",
"SubnetIds": []
}, context)
Input
- input
object
- DBSubnetGroupDescription required String
- DBSubnetGroupName required String
- SubnetIds required SubnetIdentifierList
- Tags TagList
Output
- output CreateDBSubnetGroupResult
CreateEventSubscription
amazonaws_neptune.CreateEventSubscription({
"SubscriptionName": "",
"SnsTopicArn": ""
}, context)
Input
- input
object
- Enabled BooleanOptional
- EventCategories EventCategoriesList
- SnsTopicArn required String
- SourceIds SourceIdsList
- SourceType String
- SubscriptionName required String
- Tags TagList
Output
DeleteDBCluster
amazonaws_neptune.DeleteDBCluster({
"DBClusterIdentifier": ""
}, context)
Input
- input
object
Output
- output DeleteDBClusterResult
DeleteDBClusterParameterGroup
amazonaws_neptune.DeleteDBClusterParameterGroup({
"DBClusterParameterGroupName": ""
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
Output
Output schema unknown
DeleteDBClusterSnapshot
amazonaws_neptune.DeleteDBClusterSnapshot({
"DBClusterSnapshotIdentifier": ""
}, context)
Input
- input
object
- DBClusterSnapshotIdentifier required String
Output
DeleteDBInstance
amazonaws_neptune.DeleteDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
Output
- output DeleteDBInstanceResult
DeleteDBParameterGroup
amazonaws_neptune.DeleteDBParameterGroup({
"DBParameterGroupName": ""
}, context)
Input
- input
object
- DBParameterGroupName required String
Output
Output schema unknown
DeleteDBSubnetGroup
amazonaws_neptune.DeleteDBSubnetGroup({
"DBSubnetGroupName": ""
}, context)
Input
- input
object
- DBSubnetGroupName required String
Output
Output schema unknown
DeleteEventSubscription
amazonaws_neptune.DeleteEventSubscription({
"SubscriptionName": ""
}, context)
Input
- input
object
- SubscriptionName required String
Output
DescribeDBClusterParameterGroups
amazonaws_neptune.DescribeDBClusterParameterGroups({}, context)
Input
- input
object
- DBClusterParameterGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
Output
DescribeDBClusterParameters
amazonaws_neptune.DescribeDBClusterParameters({
"DBClusterParameterGroupName": ""
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- Source String
Output
DescribeDBClusterSnapshotAttributes
amazonaws_neptune.DescribeDBClusterSnapshotAttributes({
"DBClusterSnapshotIdentifier": ""
}, context)
Input
- input
object
- DBClusterSnapshotIdentifier required String
Output
DescribeDBClusterSnapshots
amazonaws_neptune.DescribeDBClusterSnapshots({}, context)
Input
- input
object
- DBClusterIdentifier String
- DBClusterSnapshotIdentifier String
- Filters FilterList
- IncludePublic Boolean
- IncludeShared Boolean
- Marker String
- MaxRecords IntegerOptional
- SnapshotType String
Output
- output DBClusterSnapshotMessage
DescribeDBClusters
amazonaws_neptune.DescribeDBClusters({}, context)
Input
- input
object
- DBClusterIdentifier String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
Output
- output DBClusterMessage
DescribeDBEngineVersions
amazonaws_neptune.DescribeDBEngineVersions({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupFamily String
- DefaultOnly Boolean
- Engine String
- EngineVersion String
- Filters FilterList
- ListSupportedCharacterSets BooleanOptional
- ListSupportedTimezones BooleanOptional
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBEngineVersionMessage
DescribeDBInstances
amazonaws_neptune.DescribeDBInstances({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceIdentifier String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBInstanceMessage
DescribeDBParameterGroups
amazonaws_neptune.DescribeDBParameterGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBParameterGroupsMessage
DescribeDBParameters
amazonaws_neptune.DescribeDBParameters({
"DBParameterGroupName": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupName required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- Source String
- MaxRecords
Output
- output DBParameterGroupDetails
DescribeDBSubnetGroups
amazonaws_neptune.DescribeDBSubnetGroups({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBSubnetGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
- output DBSubnetGroupMessage
DescribeEngineDefaultClusterParameters
amazonaws_neptune.DescribeEngineDefaultClusterParameters({
"DBParameterGroupFamily": ""
}, context)
Input
- input
object
- DBParameterGroupFamily required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
Output
DescribeEngineDefaultParameters
amazonaws_neptune.DescribeEngineDefaultParameters({
"DBParameterGroupFamily": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBParameterGroupFamily required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- MaxRecords
Output
DescribeEventCategories
amazonaws_neptune.DescribeEventCategories({}, context)
Input
- input
object
- Filters FilterList
- SourceType String
Output
- output EventCategoriesMessage
DescribeEventSubscriptions
amazonaws_neptune.DescribeEventSubscriptions({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- SubscriptionName String
- MaxRecords
Output
- output EventSubscriptionsMessage
DescribeEvents
amazonaws_neptune.DescribeEvents({}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- Duration IntegerOptional
- EndTime TStamp
- EventCategories EventCategoriesList
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- SourceIdentifier String
- SourceType SourceType
- StartTime TStamp
- MaxRecords
Output
- output EventsMessage
DescribeOrderableDBInstanceOptions
amazonaws_neptune.DescribeOrderableDBInstanceOptions({
"Engine": ""
}, context)
Input
- input
object
- MaxRecords
string
- Marker
string
- DBInstanceClass String
- Engine required String
- EngineVersion String
- Filters FilterList
- LicenseModel String
- Marker String
- MaxRecords IntegerOptional
- Vpc BooleanOptional
- MaxRecords
Output
DescribePendingMaintenanceActions
amazonaws_neptune.DescribePendingMaintenanceActions({}, context)
Input
- input
object
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- ResourceIdentifier String
Output
DescribeValidDBInstanceModifications
amazonaws_neptune.DescribeValidDBInstanceModifications({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- DBInstanceIdentifier required String
Output
FailoverDBCluster
amazonaws_neptune.FailoverDBCluster({}, context)
Input
Output
- output FailoverDBClusterResult
ListTagsForResource
amazonaws_neptune.ListTagsForResource({
"ResourceName": ""
}, context)
Input
- input
object
- Filters FilterList
- ResourceName required String
Output
- output TagListMessage
ModifyDBCluster
amazonaws_neptune.ModifyDBCluster({
"DBClusterIdentifier": ""
}, context)
Input
- input
object
- ApplyImmediately Boolean
- BackupRetentionPeriod IntegerOptional
- DBClusterIdentifier required String
- DBClusterParameterGroupName String
- EnableIAMDatabaseAuthentication BooleanOptional
- EngineVersion String
- MasterUserPassword String
- NewDBClusterIdentifier String
- OptionGroupName String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output ModifyDBClusterResult
ModifyDBClusterParameterGroup
amazonaws_neptune.ModifyDBClusterParameterGroup({
"DBClusterParameterGroupName": "",
"Parameters": []
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
- Parameters required ParametersList
Output
ModifyDBClusterSnapshotAttribute
amazonaws_neptune.ModifyDBClusterSnapshotAttribute({
"DBClusterSnapshotIdentifier": "",
"AttributeName": ""
}, context)
Input
- input
object
- AttributeName required String
- DBClusterSnapshotIdentifier required String
- ValuesToAdd AttributeValueList
- ValuesToRemove AttributeValueList
Output
ModifyDBInstance
amazonaws_neptune.ModifyDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- AllocatedStorage IntegerOptional
- AllowMajorVersionUpgrade Boolean
- ApplyImmediately Boolean
- AutoMinorVersionUpgrade BooleanOptional
- BackupRetentionPeriod IntegerOptional
- CACertificateIdentifier String
- CloudwatchLogsExportConfiguration CloudwatchLogsExportConfiguration
- CopyTagsToSnapshot BooleanOptional
- DBInstanceClass String
- DBInstanceIdentifier required String
- DBParameterGroupName String
- DBPortNumber IntegerOptional
- DBSecurityGroups DBSecurityGroupNameList
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- EngineVersion String
- Iops IntegerOptional
- LicenseModel String
- MasterUserPassword String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- NewDBInstanceIdentifier String
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PromotionTier IntegerOptional
- PubliclyAccessible BooleanOptional
- StorageType String
- TdeCredentialArn String
- TdeCredentialPassword String
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
- output ModifyDBInstanceResult
ModifyDBParameterGroup
amazonaws_neptune.ModifyDBParameterGroup({
"DBParameterGroupName": "",
"Parameters": []
}, context)
Input
- input
object
- DBParameterGroupName required String
- Parameters required ParametersList
Output
- output DBParameterGroupNameMessage
ModifyDBSubnetGroup
amazonaws_neptune.ModifyDBSubnetGroup({
"DBSubnetGroupName": "",
"SubnetIds": []
}, context)
Input
- input
object
- DBSubnetGroupDescription String
- DBSubnetGroupName required String
- SubnetIds required SubnetIdentifierList
Output
- output ModifyDBSubnetGroupResult
ModifyEventSubscription
amazonaws_neptune.ModifyEventSubscription({
"SubscriptionName": ""
}, context)
Input
- input
object
- Enabled BooleanOptional
- EventCategories EventCategoriesList
- SnsTopicArn String
- SourceType String
- SubscriptionName required String
Output
PromoteReadReplicaDBCluster
amazonaws_neptune.PromoteReadReplicaDBCluster({
"DBClusterIdentifier": ""
}, context)
Input
- input
object
- DBClusterIdentifier required String
Output
RebootDBInstance
amazonaws_neptune.RebootDBInstance({
"DBInstanceIdentifier": ""
}, context)
Input
- input
object
- DBInstanceIdentifier required String
- ForceFailover BooleanOptional
Output
- output RebootDBInstanceResult
RemoveRoleFromDBCluster
amazonaws_neptune.RemoveRoleFromDBCluster({
"DBClusterIdentifier": "",
"RoleArn": ""
}, context)
Input
Output
Output schema unknown
RemoveSourceIdentifierFromSubscription
amazonaws_neptune.RemoveSourceIdentifierFromSubscription({
"SubscriptionName": "",
"SourceIdentifier": ""
}, context)
Input
Output
RemoveTagsFromResource
amazonaws_neptune.RemoveTagsFromResource({
"ResourceName": "",
"TagKeys": []
}, context)
Input
Output
Output schema unknown
ResetDBClusterParameterGroup
amazonaws_neptune.ResetDBClusterParameterGroup({
"DBClusterParameterGroupName": ""
}, context)
Input
- input
object
- DBClusterParameterGroupName required String
- Parameters ParametersList
- ResetAllParameters Boolean
Output
ResetDBParameterGroup
amazonaws_neptune.ResetDBParameterGroup({
"DBParameterGroupName": ""
}, context)
Input
- input
object
- DBParameterGroupName required String
- Parameters ParametersList
- ResetAllParameters Boolean
Output
- output DBParameterGroupNameMessage
RestoreDBClusterFromSnapshot
amazonaws_neptune.RestoreDBClusterFromSnapshot({
"DBClusterIdentifier": "",
"SnapshotIdentifier": "",
"Engine": ""
}, context)
Input
- input
object
- AvailabilityZones AvailabilityZones
- DBClusterIdentifier required String
- DBSubnetGroupName String
- DatabaseName String
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine required String
- EngineVersion String
- KmsKeyId String
- OptionGroupName String
- Port IntegerOptional
- SnapshotIdentifier required String
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
RestoreDBClusterToPointInTime
amazonaws_neptune.RestoreDBClusterToPointInTime({
"DBClusterIdentifier": "",
"SourceDBClusterIdentifier": ""
}, context)
Input
- input
object
- DBClusterIdentifier required String
- DBSubnetGroupName String
- EnableIAMDatabaseAuthentication BooleanOptional
- KmsKeyId String
- OptionGroupName String
- Port IntegerOptional
- RestoreToTime TStamp
- RestoreType String
- SourceDBClusterIdentifier required String
- Tags TagList
- UseLatestRestorableTime Boolean
- VpcSecurityGroupIds VpcSecurityGroupIdList
Output
Definitions
AddRoleToDBClusterMessage
AddSourceIdentifierToSubscriptionMessage
- AddSourceIdentifierToSubscriptionMessage
object
:
AddSourceIdentifierToSubscriptionResult
- AddSourceIdentifierToSubscriptionResult
object
- EventSubscription EventSubscription
AddTagsToResourceMessage
ApplyMethod
- ApplyMethod
string
(values: immediate, pending-reboot)
ApplyPendingMaintenanceActionMessage
- ApplyPendingMaintenanceActionMessage
object
:
ApplyPendingMaintenanceActionResult
- ApplyPendingMaintenanceActionResult
object
- ResourcePendingMaintenanceActions ResourcePendingMaintenanceActions
AttributeValueList
- AttributeValueList
array
- items String
AuthorizationNotFoundFault
- AuthorizationNotFoundFault
object
: 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.
AvailabilityZone
- AvailabilityZone
object
: Contains Availability Zone information. This data type is used as an element in the following data type: OrderableDBInstanceOption- Name String
AvailabilityZoneList
- AvailabilityZoneList
array
- items AvailabilityZone
AvailabilityZones
- AvailabilityZones
array
- items String
Boolean
- Boolean
boolean
BooleanOptional
- BooleanOptional
boolean
CertificateNotFoundFault
- CertificateNotFoundFault
object
: CertificateIdentifier does not refer to an existing certificate.
CharacterSet
- CharacterSet
object
: This data type is used as a response element in the action DescribeDBEngineVersions.
CloudwatchLogsExportConfiguration
- CloudwatchLogsExportConfiguration
object
: The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.- DisableLogTypes LogTypeList
- EnableLogTypes LogTypeList
CopyDBClusterParameterGroupMessage
- CopyDBClusterParameterGroupMessage
object
CopyDBClusterParameterGroupResult
- CopyDBClusterParameterGroupResult
object
- DBClusterParameterGroup DBClusterParameterGroup
CopyDBClusterSnapshotMessage
- CopyDBClusterSnapshotMessage
object
:
CopyDBClusterSnapshotResult
- CopyDBClusterSnapshotResult
object
- DBClusterSnapshot DBClusterSnapshot
CopyDBParameterGroupMessage
- CopyDBParameterGroupMessage
object
:
CopyDBParameterGroupResult
- CopyDBParameterGroupResult
object
- DBParameterGroup DBParameterGroup
CreateDBClusterMessage
- CreateDBClusterMessage
object
:- AvailabilityZones AvailabilityZones
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- DBClusterIdentifier required String
- DBClusterParameterGroupName String
- DBSubnetGroupName String
- DatabaseName String
- EnableIAMDatabaseAuthentication BooleanOptional
- Engine required String
- EngineVersion String
- KmsKeyId String
- MasterUserPassword String
- MasterUsername String
- OptionGroupName String
- Port IntegerOptional
- PreSignedUrl String
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- ReplicationSourceIdentifier String
- StorageEncrypted BooleanOptional
- Tags TagList
- VpcSecurityGroupIds VpcSecurityGroupIdList
CreateDBClusterParameterGroupMessage
- CreateDBClusterParameterGroupMessage
object
:
CreateDBClusterParameterGroupResult
- CreateDBClusterParameterGroupResult
object
- DBClusterParameterGroup DBClusterParameterGroup
CreateDBClusterResult
- CreateDBClusterResult
object
- DBCluster DBCluster
CreateDBClusterSnapshotMessage
- CreateDBClusterSnapshotMessage
object
:
CreateDBClusterSnapshotResult
- CreateDBClusterSnapshotResult
object
- DBClusterSnapshot DBClusterSnapshot
CreateDBInstanceMessage
- CreateDBInstanceMessage
object
:- AllocatedStorage IntegerOptional
- AutoMinorVersionUpgrade BooleanOptional
- AvailabilityZone String
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- CopyTagsToSnapshot BooleanOptional
- DBClusterIdentifier String
- DBInstanceClass required String
- DBInstanceIdentifier required String
- DBName String
- DBParameterGroupName String
- DBSecurityGroups DBSecurityGroupNameList
- DBSubnetGroupName String
- Domain String
- DomainIAMRoleName String
- EnableCloudwatchLogsExports LogTypeList
- EnableIAMDatabaseAuthentication BooleanOptional
- EnablePerformanceInsights BooleanOptional
- Engine required String
- EngineVersion String
- Iops IntegerOptional
- KmsKeyId String
- LicenseModel String
- MasterUserPassword String
- MasterUsername String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ BooleanOptional
- OptionGroupName String
- PerformanceInsightsKMSKeyId String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PromotionTier IntegerOptional
- PubliclyAccessible BooleanOptional
- StorageEncrypted BooleanOptional
- StorageType String
- Tags TagList
- TdeCredentialArn String
- TdeCredentialPassword String
- Timezone String
- VpcSecurityGroupIds VpcSecurityGroupIdList
CreateDBInstanceResult
- CreateDBInstanceResult
object
- DBInstance DBInstance
CreateDBParameterGroupMessage
- CreateDBParameterGroupMessage
object
:
CreateDBParameterGroupResult
- CreateDBParameterGroupResult
object
- DBParameterGroup DBParameterGroup
CreateDBSubnetGroupMessage
- CreateDBSubnetGroupMessage
object
:- DBSubnetGroupDescription required String
- DBSubnetGroupName required String
- SubnetIds required SubnetIdentifierList
- Tags TagList
CreateDBSubnetGroupResult
- CreateDBSubnetGroupResult
object
- DBSubnetGroup DBSubnetGroup
CreateEventSubscriptionMessage
- CreateEventSubscriptionMessage
object
:- Enabled BooleanOptional
- EventCategories EventCategoriesList
- SnsTopicArn required String
- SourceIds SourceIdsList
- SourceType String
- SubscriptionName required String
- Tags TagList
CreateEventSubscriptionResult
- CreateEventSubscriptionResult
object
- EventSubscription EventSubscription
DBCluster
- DBCluster
object
: Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the DescribeDBClusters action.- AllocatedStorage IntegerOptional
- AssociatedRoles DBClusterRoles
- AvailabilityZones AvailabilityZones
- BackupRetentionPeriod IntegerOptional
- CharacterSetName String
- CloneGroupId String
- ClusterCreateTime TStamp
- DBClusterArn String
- DBClusterIdentifier String
- DBClusterMembers DBClusterMemberList
- DBClusterOptionGroupMemberships DBClusterOptionGroupMemberships
- DBClusterParameterGroup String
- DBSubnetGroup String
- DatabaseName String
- DbClusterResourceId String
- EarliestRestorableTime TStamp
- Endpoint String
- Engine String
- EngineVersion String
- HostedZoneId String
- IAMDatabaseAuthenticationEnabled Boolean
- KmsKeyId String
- LatestRestorableTime TStamp
- MasterUsername String
- MultiAZ Boolean
- PercentProgress String
- Port IntegerOptional
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- ReadReplicaIdentifiers ReadReplicaIdentifierList
- ReaderEndpoint String
- ReplicationSourceIdentifier String
- Status String
- StorageEncrypted Boolean
- VpcSecurityGroups VpcSecurityGroupMembershipList
DBClusterAlreadyExistsFault
- DBClusterAlreadyExistsFault
object
: User already has a DB cluster with the given identifier.
DBClusterList
- DBClusterList
array
- items DBCluster
DBClusterMember
- DBClusterMember
object
: Contains information about an instance that is part of a DB cluster.- DBClusterParameterGroupStatus String
- DBInstanceIdentifier String
- IsClusterWriter Boolean
- PromotionTier IntegerOptional
DBClusterMemberList
- DBClusterMemberList
array
- items DBClusterMember
DBClusterMessage
- DBClusterMessage
object
: Contains the result of a successful invocation of the DescribeDBClusters action.- DBClusters DBClusterList
- Marker String
DBClusterNotFoundFault
- DBClusterNotFoundFault
object
: DBClusterIdentifier does not refer to an existing DB cluster.
DBClusterOptionGroupMemberships
- DBClusterOptionGroupMemberships
array
DBClusterOptionGroupStatus
- DBClusterOptionGroupStatus
object
: Contains status information for a DB cluster option group.
DBClusterParameterGroup
- DBClusterParameterGroup
object
: Contains the details of an Amazon Neptune DB cluster parameter group. This data type is used as a response element in the DescribeDBClusterParameterGroups action.
DBClusterParameterGroupDetails
- DBClusterParameterGroupDetails
object
: Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.- Marker String
- Parameters ParametersList
DBClusterParameterGroupList
- DBClusterParameterGroupList
array
- items DBClusterParameterGroup
DBClusterParameterGroupNameMessage
- DBClusterParameterGroupNameMessage
object
:- DBClusterParameterGroupName String
DBClusterParameterGroupNotFoundFault
- DBClusterParameterGroupNotFoundFault
object
: DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
DBClusterParameterGroupsMessage
- DBClusterParameterGroupsMessage
object
:- DBClusterParameterGroups DBClusterParameterGroupList
- Marker String
DBClusterQuotaExceededFault
- DBClusterQuotaExceededFault
object
: User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.
DBClusterRole
- DBClusterRole
object
: Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
DBClusterRoleAlreadyExistsFault
- DBClusterRoleAlreadyExistsFault
object
: The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.
DBClusterRoleNotFoundFault
- DBClusterRoleNotFoundFault
object
: The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.
DBClusterRoleQuotaExceededFault
- DBClusterRoleQuotaExceededFault
object
: You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.
DBClusterRoles
- DBClusterRoles
array
- items DBClusterRole
DBClusterSnapshot
- DBClusterSnapshot
object
: Contains the details for an Amazon Neptune DB cluster snapshot This data type is used as a response element in the DescribeDBClusterSnapshots action.- AllocatedStorage Integer
- AvailabilityZones AvailabilityZones
- ClusterCreateTime TStamp
- DBClusterIdentifier String
- DBClusterSnapshotArn String
- DBClusterSnapshotIdentifier String
- Engine String
- EngineVersion String
- IAMDatabaseAuthenticationEnabled Boolean
- KmsKeyId String
- LicenseModel String
- MasterUsername String
- PercentProgress Integer
- Port Integer
- SnapshotCreateTime TStamp
- SnapshotType String
- SourceDBClusterSnapshotArn String
- Status String
- StorageEncrypted Boolean
- VpcId String
DBClusterSnapshotAlreadyExistsFault
- DBClusterSnapshotAlreadyExistsFault
object
: User already has a DB cluster snapshot with the given identifier.
DBClusterSnapshotAttribute
- DBClusterSnapshotAttribute
object
: Contains the name and values of a manual DB cluster snapshot attribute. Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.- AttributeName String
- AttributeValues AttributeValueList
DBClusterSnapshotAttributeList
- DBClusterSnapshotAttributeList
array
DBClusterSnapshotAttributesResult
- DBClusterSnapshotAttributesResult
object
: Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.- DBClusterSnapshotAttributes DBClusterSnapshotAttributeList
- DBClusterSnapshotIdentifier String
DBClusterSnapshotList
- DBClusterSnapshotList
array
- items DBClusterSnapshot
DBClusterSnapshotMessage
- DBClusterSnapshotMessage
object
: Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.- DBClusterSnapshots DBClusterSnapshotList
- Marker String
DBClusterSnapshotNotFoundFault
- DBClusterSnapshotNotFoundFault
object
: DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
DBEngineVersion
- DBEngineVersion
object
: This data type is used as a response element in the action DescribeDBEngineVersions.- DBEngineDescription String
- DBEngineVersionDescription String
- DBParameterGroupFamily String
- DefaultCharacterSet CharacterSet
- Engine String
- EngineVersion String
- ExportableLogTypes LogTypeList
- SupportedCharacterSets SupportedCharacterSetsList
- SupportedTimezones SupportedTimezonesList
- SupportsLogExportsToCloudwatchLogs Boolean
- SupportsReadReplica Boolean
- ValidUpgradeTarget ValidUpgradeTargetList
DBEngineVersionList
- DBEngineVersionList
array
- items DBEngineVersion
DBEngineVersionMessage
- DBEngineVersionMessage
object
: Contains the result of a successful invocation of the DescribeDBEngineVersions action.- DBEngineVersions DBEngineVersionList
- Marker String
DBInstance
- DBInstance
object
: Contains the details of an Amazon Neptune DB instance. This data type is used as a response element in the DescribeDBInstances action.- AllocatedStorage Integer
- AutoMinorVersionUpgrade Boolean
- AvailabilityZone String
- BackupRetentionPeriod Integer
- CACertificateIdentifier String
- CharacterSetName String
- CopyTagsToSnapshot Boolean
- DBClusterIdentifier String
- DBInstanceArn String
- DBInstanceClass String
- DBInstanceIdentifier String
- DBInstanceStatus String
- DBName String
- DBParameterGroups DBParameterGroupStatusList
- DBSecurityGroups DBSecurityGroupMembershipList
- DBSubnetGroup DBSubnetGroup
- DbInstancePort Integer
- DbiResourceId String
- DomainMemberships DomainMembershipList
- EnabledCloudwatchLogsExports LogTypeList
- Endpoint Endpoint
- Engine String
- EngineVersion String
- EnhancedMonitoringResourceArn String
- IAMDatabaseAuthenticationEnabled Boolean
- InstanceCreateTime TStamp
- Iops IntegerOptional
- KmsKeyId String
- LatestRestorableTime TStamp
- LicenseModel String
- MasterUsername String
- MonitoringInterval IntegerOptional
- MonitoringRoleArn String
- MultiAZ Boolean
- OptionGroupMemberships OptionGroupMembershipList
- PendingModifiedValues PendingModifiedValues
- PerformanceInsightsEnabled BooleanOptional
- PerformanceInsightsKMSKeyId String
- PreferredBackupWindow String
- PreferredMaintenanceWindow String
- PromotionTier IntegerOptional
- PubliclyAccessible Boolean
- ReadReplicaDBClusterIdentifiers ReadReplicaDBClusterIdentifierList
- ReadReplicaDBInstanceIdentifiers ReadReplicaDBInstanceIdentifierList
- ReadReplicaSourceDBInstanceIdentifier String
- SecondaryAvailabilityZone String
- StatusInfos DBInstanceStatusInfoList
- StorageEncrypted Boolean
- StorageType String
- TdeCredentialArn String
- Timezone String
- VpcSecurityGroups VpcSecurityGroupMembershipList
DBInstanceAlreadyExistsFault
- DBInstanceAlreadyExistsFault
object
: User already has a DB instance with the given identifier.
DBInstanceList
- DBInstanceList
array
- items DBInstance
DBInstanceMessage
- DBInstanceMessage
object
: Contains the result of a successful invocation of the DescribeDBInstances action.- DBInstances DBInstanceList
- Marker String
DBInstanceNotFoundFault
- DBInstanceNotFoundFault
object
: DBInstanceIdentifier does not refer to an existing DB instance.
DBInstanceStatusInfo
- DBInstanceStatusInfo
object
: Provides a list of status information for a DB instance.
DBInstanceStatusInfoList
- DBInstanceStatusInfoList
array
- items DBInstanceStatusInfo
DBParameterGroup
- DBParameterGroup
object
: Contains the details of an Amazon Neptune DB parameter group. This data type is used as a response element in the DescribeDBParameterGroups action.
DBParameterGroupAlreadyExistsFault
- DBParameterGroupAlreadyExistsFault
object
: A DB parameter group with the same name exists.
DBParameterGroupDetails
- DBParameterGroupDetails
object
: Contains the result of a successful invocation of the DescribeDBParameters action.- Marker String
- Parameters ParametersList
DBParameterGroupList
- DBParameterGroupList
array
- items DBParameterGroup
DBParameterGroupNameMessage
- DBParameterGroupNameMessage
object
: Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.- DBParameterGroupName String
DBParameterGroupNotFoundFault
- DBParameterGroupNotFoundFault
object
: DBParameterGroupName does not refer to an existing DB parameter group.
DBParameterGroupQuotaExceededFault
- DBParameterGroupQuotaExceededFault
object
: Request would result in user exceeding the allowed number of DB parameter groups.
DBParameterGroupStatus
- DBParameterGroupStatus
object
: 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
- DBParameterGroupStatusList
array
- items DBParameterGroupStatus
DBParameterGroupsMessage
- DBParameterGroupsMessage
object
: Contains the result of a successful invocation of the DescribeDBParameterGroups action.- DBParameterGroups DBParameterGroupList
- Marker String
DBSecurityGroupMembership
- DBSecurityGroupMembership
object
: This data type is used as a response element in the following actions: ModifyDBInstance RebootDBInstance
DBSecurityGroupMembershipList
- DBSecurityGroupMembershipList
array
DBSecurityGroupNameList
- DBSecurityGroupNameList
array
- items String
DBSecurityGroupNotFoundFault
- DBSecurityGroupNotFoundFault
object
: DBSecurityGroupName does not refer to an existing DB security group.
DBSnapshotAlreadyExistsFault
- DBSnapshotAlreadyExistsFault
object
: DBSnapshotIdentifier is already used by an existing snapshot.
DBSnapshotNotFoundFault
- DBSnapshotNotFoundFault
object
: DBSnapshotIdentifier does not refer to an existing DB snapshot.
DBSubnetGroup
- DBSubnetGroup
object
: Contains the details of an Amazon Neptune DB subnet group. This data type is used as a response element in the DescribeDBSubnetGroups action.
DBSubnetGroupAlreadyExistsFault
- DBSubnetGroupAlreadyExistsFault
object
: DBSubnetGroupName is already used by an existing DB subnet group.
DBSubnetGroupDoesNotCoverEnoughAZs
- DBSubnetGroupDoesNotCoverEnoughAZs
object
: Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.
DBSubnetGroupMessage
- DBSubnetGroupMessage
object
: Contains the result of a successful invocation of the DescribeDBSubnetGroups action.- DBSubnetGroups DBSubnetGroups
- Marker String
DBSubnetGroupNotFoundFault
- DBSubnetGroupNotFoundFault
object
: DBSubnetGroupName does not refer to an existing DB subnet group.
DBSubnetGroupQuotaExceededFault
- DBSubnetGroupQuotaExceededFault
object
: Request would result in user exceeding the allowed number of DB subnet groups.
DBSubnetGroups
- DBSubnetGroups
array
- items DBSubnetGroup
DBSubnetQuotaExceededFault
- DBSubnetQuotaExceededFault
object
: Request would result in user exceeding the allowed number of subnets in a DB subnet groups.
DBUpgradeDependencyFailureFault
- DBUpgradeDependencyFailureFault
object
: The DB upgrade failed because a resource the DB depends on could not be modified.
DeleteDBClusterMessage
- DeleteDBClusterMessage
object
:
DeleteDBClusterParameterGroupMessage
- DeleteDBClusterParameterGroupMessage
object
:- DBClusterParameterGroupName required String
DeleteDBClusterResult
- DeleteDBClusterResult
object
- DBCluster DBCluster
DeleteDBClusterSnapshotMessage
- DeleteDBClusterSnapshotMessage
object
:- DBClusterSnapshotIdentifier required String
DeleteDBClusterSnapshotResult
- DeleteDBClusterSnapshotResult
object
- DBClusterSnapshot DBClusterSnapshot
DeleteDBInstanceMessage
- DeleteDBInstanceMessage
object
:
DeleteDBInstanceResult
- DeleteDBInstanceResult
object
- DBInstance DBInstance
DeleteDBParameterGroupMessage
- DeleteDBParameterGroupMessage
object
:- DBParameterGroupName required String
DeleteDBSubnetGroupMessage
- DeleteDBSubnetGroupMessage
object
:- DBSubnetGroupName required String
DeleteEventSubscriptionMessage
- DeleteEventSubscriptionMessage
object
:- SubscriptionName required String
DeleteEventSubscriptionResult
- DeleteEventSubscriptionResult
object
- EventSubscription EventSubscription
DescribeDBClusterParameterGroupsMessage
- DescribeDBClusterParameterGroupsMessage
object
:- DBClusterParameterGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
DescribeDBClusterParametersMessage
- DescribeDBClusterParametersMessage
object
:- DBClusterParameterGroupName required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- Source String
DescribeDBClusterSnapshotAttributesMessage
- DescribeDBClusterSnapshotAttributesMessage
object
:- DBClusterSnapshotIdentifier required String
DescribeDBClusterSnapshotAttributesResult
- DescribeDBClusterSnapshotAttributesResult
object
- DBClusterSnapshotAttributesResult DBClusterSnapshotAttributesResult
DescribeDBClusterSnapshotsMessage
- DescribeDBClusterSnapshotsMessage
object
:- DBClusterIdentifier String
- DBClusterSnapshotIdentifier String
- Filters FilterList
- IncludePublic Boolean
- IncludeShared Boolean
- Marker String
- MaxRecords IntegerOptional
- SnapshotType String
DescribeDBClustersMessage
- DescribeDBClustersMessage
object
:- DBClusterIdentifier String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
DescribeDBEngineVersionsMessage
- DescribeDBEngineVersionsMessage
object
- DBParameterGroupFamily String
- DefaultOnly Boolean
- Engine String
- EngineVersion String
- Filters FilterList
- ListSupportedCharacterSets BooleanOptional
- ListSupportedTimezones BooleanOptional
- Marker String
- MaxRecords IntegerOptional
DescribeDBInstancesMessage
- DescribeDBInstancesMessage
object
:- DBInstanceIdentifier String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
DescribeDBParameterGroupsMessage
- DescribeDBParameterGroupsMessage
object
:- DBParameterGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
DescribeDBParametersMessage
- DescribeDBParametersMessage
object
- DBParameterGroupName required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- Source String
DescribeDBSubnetGroupsMessage
- DescribeDBSubnetGroupsMessage
object
:- DBSubnetGroupName String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
DescribeEngineDefaultClusterParametersMessage
- DescribeEngineDefaultClusterParametersMessage
object
:- DBParameterGroupFamily required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
DescribeEngineDefaultClusterParametersResult
- DescribeEngineDefaultClusterParametersResult
object
- EngineDefaults EngineDefaults
DescribeEngineDefaultParametersMessage
- DescribeEngineDefaultParametersMessage
object
:- DBParameterGroupFamily required String
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
DescribeEngineDefaultParametersResult
- DescribeEngineDefaultParametersResult
object
- EngineDefaults EngineDefaults
DescribeEventCategoriesMessage
- DescribeEventCategoriesMessage
object
:- Filters FilterList
- SourceType String
DescribeEventSubscriptionsMessage
- DescribeEventSubscriptionsMessage
object
:- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- SubscriptionName String
DescribeEventsMessage
- DescribeEventsMessage
object
:- Duration IntegerOptional
- EndTime TStamp
- EventCategories EventCategoriesList
- Filters FilterList
- Marker String
- MaxRecords IntegerOptional
- SourceIdentifier String
- SourceType SourceType
- StartTime TStamp
7 years ago