Skip to content

NeptuneClient#

Index > Neptune > NeptuneClient

Auto-generated documentation for Neptune type annotations stubs module types-boto3-neptune.

NeptuneClient#

Type annotations and code completion for boto3.client("neptune"). boto3 documentation

# NeptuneClient usage example

from boto3.session import Session
from types_boto3_neptune.client import NeptuneClient

def get_neptune_client() -> NeptuneClient:
    return Session().client("neptune")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("neptune").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("neptune")

try:
    do_something(client)
except (
    client.exceptions.AuthorizationNotFoundFault,
    client.exceptions.CertificateNotFoundFault,
    client.exceptions.ClientError,
    client.exceptions.DBClusterAlreadyExistsFault,
    client.exceptions.DBClusterEndpointAlreadyExistsFault,
    client.exceptions.DBClusterEndpointNotFoundFault,
    client.exceptions.DBClusterEndpointQuotaExceededFault,
    client.exceptions.DBClusterNotFoundFault,
    client.exceptions.DBClusterParameterGroupNotFoundFault,
    client.exceptions.DBClusterQuotaExceededFault,
    client.exceptions.DBClusterRoleAlreadyExistsFault,
    client.exceptions.DBClusterRoleNotFoundFault,
    client.exceptions.DBClusterRoleQuotaExceededFault,
    client.exceptions.DBClusterSnapshotAlreadyExistsFault,
    client.exceptions.DBClusterSnapshotNotFoundFault,
    client.exceptions.DBInstanceAlreadyExistsFault,
    client.exceptions.DBInstanceNotFoundFault,
    client.exceptions.DBParameterGroupAlreadyExistsFault,
    client.exceptions.DBParameterGroupNotFoundFault,
    client.exceptions.DBParameterGroupQuotaExceededFault,
    client.exceptions.DBSecurityGroupNotFoundFault,
    client.exceptions.DBSnapshotAlreadyExistsFault,
    client.exceptions.DBSnapshotNotFoundFault,
    client.exceptions.DBSubnetGroupAlreadyExistsFault,
    client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs,
    client.exceptions.DBSubnetGroupNotFoundFault,
    client.exceptions.DBSubnetGroupQuotaExceededFault,
    client.exceptions.DBSubnetQuotaExceededFault,
    client.exceptions.DBUpgradeDependencyFailureFault,
    client.exceptions.DomainNotFoundFault,
    client.exceptions.EventSubscriptionQuotaExceededFault,
    client.exceptions.GlobalClusterAlreadyExistsFault,
    client.exceptions.GlobalClusterNotFoundFault,
    client.exceptions.GlobalClusterQuotaExceededFault,
    client.exceptions.InstanceQuotaExceededFault,
    client.exceptions.InsufficientDBClusterCapacityFault,
    client.exceptions.InsufficientDBInstanceCapacityFault,
    client.exceptions.InsufficientStorageClusterCapacityFault,
    client.exceptions.InvalidDBClusterEndpointStateFault,
    client.exceptions.InvalidDBClusterSnapshotStateFault,
    client.exceptions.InvalidDBClusterStateFault,
    client.exceptions.InvalidDBInstanceStateFault,
    client.exceptions.InvalidDBParameterGroupStateFault,
    client.exceptions.InvalidDBSecurityGroupStateFault,
    client.exceptions.InvalidDBSnapshotStateFault,
    client.exceptions.InvalidDBSubnetGroupStateFault,
    client.exceptions.InvalidDBSubnetStateFault,
    client.exceptions.InvalidEventSubscriptionStateFault,
    client.exceptions.InvalidGlobalClusterStateFault,
    client.exceptions.InvalidRestoreFault,
    client.exceptions.InvalidSubnet,
    client.exceptions.InvalidVPCNetworkStateFault,
    client.exceptions.KMSKeyNotAccessibleFault,
    client.exceptions.OptionGroupNotFoundFault,
    client.exceptions.ProvisionedIopsNotAvailableInAZFault,
    client.exceptions.ResourceNotFoundFault,
    client.exceptions.SNSInvalidTopicFault,
    client.exceptions.SNSNoAuthorizationFault,
    client.exceptions.SNSTopicArnNotFoundFault,
    client.exceptions.SharedSnapshotQuotaExceededFault,
    client.exceptions.SnapshotQuotaExceededFault,
    client.exceptions.SourceNotFoundFault,
    client.exceptions.StorageQuotaExceededFault,
    client.exceptions.StorageTypeNotSupportedFault,
    client.exceptions.SubnetAlreadyInUse,
    client.exceptions.SubscriptionAlreadyExistFault,
    client.exceptions.SubscriptionCategoryNotFoundFault,
    client.exceptions.SubscriptionNotFoundFault,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_neptune.client import Exceptions

def handle_error(exc: Exceptions.AuthorizationNotFoundFault) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("neptune").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("neptune").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

add_role_to_db_cluster#

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

Type annotations and code completion for boto3.client("neptune").add_role_to_db_cluster method. boto3 documentation

# add_role_to_db_cluster method definition

def add_role_to_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    RoleArn: str,
    FeatureName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# add_role_to_db_cluster method usage example with argument unpacking

kwargs: AddRoleToDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "RoleArn": ...,
}

parent.add_role_to_db_cluster(**kwargs)
  1. See AddRoleToDBClusterMessageTypeDef

add_source_identifier_to_subscription#

Adds a source identifier to an existing event notification subscription.

Type annotations and code completion for boto3.client("neptune").add_source_identifier_to_subscription method. boto3 documentation

# add_source_identifier_to_subscription method definition

def add_source_identifier_to_subscription(
    self,
    *,
    SubscriptionName: str,
    SourceIdentifier: str,
) -> AddSourceIdentifierToSubscriptionResultTypeDef:  # (1)
    ...
  1. See AddSourceIdentifierToSubscriptionResultTypeDef
# add_source_identifier_to_subscription method usage example with argument unpacking

kwargs: AddSourceIdentifierToSubscriptionMessageTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SourceIdentifier": ...,
}

parent.add_source_identifier_to_subscription(**kwargs)
  1. See AddSourceIdentifierToSubscriptionMessageTypeDef

add_tags_to_resource#

Adds metadata tags to an Amazon Neptune resource.

Type annotations and code completion for boto3.client("neptune").add_tags_to_resource method. boto3 documentation

# add_tags_to_resource method definition

def add_tags_to_resource(
    self,
    *,
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See EmptyResponseMetadataTypeDef
# add_tags_to_resource method usage example with argument unpacking

kwargs: AddTagsToResourceMessageTypeDef = {  # (1)
    "ResourceName": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceMessageTypeDef

apply_pending_maintenance_action#

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

Type annotations and code completion for boto3.client("neptune").apply_pending_maintenance_action method. boto3 documentation

# apply_pending_maintenance_action method definition

def apply_pending_maintenance_action(
    self,
    *,
    ResourceIdentifier: str,
    ApplyAction: str,
    OptInType: str,
) -> ApplyPendingMaintenanceActionResultTypeDef:  # (1)
    ...
  1. See ApplyPendingMaintenanceActionResultTypeDef
# apply_pending_maintenance_action method usage example with argument unpacking

kwargs: ApplyPendingMaintenanceActionMessageTypeDef = {  # (1)
    "ResourceIdentifier": ...,
    "ApplyAction": ...,
    "OptInType": ...,
}

parent.apply_pending_maintenance_action(**kwargs)
  1. See ApplyPendingMaintenanceActionMessageTypeDef

copy_db_cluster_parameter_group#

Copies the specified DB cluster parameter group.

Type annotations and code completion for boto3.client("neptune").copy_db_cluster_parameter_group method. boto3 documentation

# copy_db_cluster_parameter_group method definition

def copy_db_cluster_parameter_group(
    self,
    *,
    SourceDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupDescription: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CopyDBClusterParameterGroupResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CopyDBClusterParameterGroupResultTypeDef
# copy_db_cluster_parameter_group method usage example with argument unpacking

kwargs: CopyDBClusterParameterGroupMessageTypeDef = {  # (1)
    "SourceDBClusterParameterGroupIdentifier": ...,
    "TargetDBClusterParameterGroupIdentifier": ...,
    "TargetDBClusterParameterGroupDescription": ...,
}

parent.copy_db_cluster_parameter_group(**kwargs)
  1. See CopyDBClusterParameterGroupMessageTypeDef

copy_db_cluster_snapshot#

Copies a snapshot of a DB cluster.

Type annotations and code completion for boto3.client("neptune").copy_db_cluster_snapshot method. boto3 documentation

# copy_db_cluster_snapshot method definition

def copy_db_cluster_snapshot(
    self,
    *,
    SourceDBClusterSnapshotIdentifier: str,
    TargetDBClusterSnapshotIdentifier: str,
    KmsKeyId: str = ...,
    PreSignedUrl: str = ...,
    CopyTags: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    SourceRegion: str = ...,
) -> CopyDBClusterSnapshotResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CopyDBClusterSnapshotResultTypeDef
# copy_db_cluster_snapshot method usage example with argument unpacking

kwargs: CopyDBClusterSnapshotMessageTypeDef = {  # (1)
    "SourceDBClusterSnapshotIdentifier": ...,
    "TargetDBClusterSnapshotIdentifier": ...,
}

parent.copy_db_cluster_snapshot(**kwargs)
  1. See CopyDBClusterSnapshotMessageTypeDef

copy_db_parameter_group#

Copies the specified DB parameter group.

Type annotations and code completion for boto3.client("neptune").copy_db_parameter_group method. boto3 documentation

# copy_db_parameter_group method definition

def copy_db_parameter_group(
    self,
    *,
    SourceDBParameterGroupIdentifier: str,
    TargetDBParameterGroupIdentifier: str,
    TargetDBParameterGroupDescription: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CopyDBParameterGroupResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CopyDBParameterGroupResultTypeDef
# copy_db_parameter_group method usage example with argument unpacking

kwargs: CopyDBParameterGroupMessageTypeDef = {  # (1)
    "SourceDBParameterGroupIdentifier": ...,
    "TargetDBParameterGroupIdentifier": ...,
    "TargetDBParameterGroupDescription": ...,
}

parent.copy_db_parameter_group(**kwargs)
  1. See CopyDBParameterGroupMessageTypeDef

create_db_cluster#

Creates a new Amazon Neptune DB cluster.

Type annotations and code completion for boto3.client("neptune").create_db_cluster method. boto3 documentation

# create_db_cluster method definition

def create_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    Engine: str,
    AvailabilityZones: Sequence[str] = ...,
    BackupRetentionPeriod: int = ...,
    CharacterSetName: str = ...,
    CopyTagsToSnapshot: bool = ...,
    DatabaseName: str = ...,
    DBClusterParameterGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    DBSubnetGroupName: str = ...,
    EngineVersion: str = ...,
    Port: int = ...,
    MasterUsername: str = ...,
    MasterUserPassword: str = ...,
    OptionGroupName: str = ...,
    PreferredBackupWindow: str = ...,
    PreferredMaintenanceWindow: str = ...,
    ReplicationSourceIdentifier: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    StorageEncrypted: bool = ...,
    KmsKeyId: str = ...,
    PreSignedUrl: str = ...,
    EnableIAMDatabaseAuthentication: bool = ...,
    EnableCloudwatchLogsExports: Sequence[str] = ...,
    DeletionProtection: bool = ...,
    ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfigurationTypeDef = ...,  # (2)
    GlobalClusterIdentifier: str = ...,
    StorageType: str = ...,
    SourceRegion: str = ...,
) -> CreateDBClusterResultTypeDef:  # (3)
    ...
  1. See Sequence[TagTypeDef]
  2. See ServerlessV2ScalingConfigurationTypeDef
  3. See CreateDBClusterResultTypeDef
# create_db_cluster method usage example with argument unpacking

kwargs: CreateDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "Engine": ...,
}

parent.create_db_cluster(**kwargs)
  1. See CreateDBClusterMessageTypeDef

create_db_cluster_endpoint#

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

Type annotations and code completion for boto3.client("neptune").create_db_cluster_endpoint method. boto3 documentation

# create_db_cluster_endpoint method definition

def create_db_cluster_endpoint(
    self,
    *,
    DBClusterIdentifier: str,
    DBClusterEndpointIdentifier: str,
    EndpointType: str,
    StaticMembers: Sequence[str] = ...,
    ExcludedMembers: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBClusterEndpointOutputTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateDBClusterEndpointOutputTypeDef
# create_db_cluster_endpoint method usage example with argument unpacking

kwargs: CreateDBClusterEndpointMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "DBClusterEndpointIdentifier": ...,
    "EndpointType": ...,
}

parent.create_db_cluster_endpoint(**kwargs)
  1. See CreateDBClusterEndpointMessageTypeDef

create_db_cluster_parameter_group#

Creates a new DB cluster parameter group.

Type annotations and code completion for boto3.client("neptune").create_db_cluster_parameter_group method. boto3 documentation

# create_db_cluster_parameter_group method definition

def create_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
    DBParameterGroupFamily: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBClusterParameterGroupResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateDBClusterParameterGroupResultTypeDef
# create_db_cluster_parameter_group method usage example with argument unpacking

kwargs: CreateDBClusterParameterGroupMessageTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
    "DBParameterGroupFamily": ...,
    "Description": ...,
}

parent.create_db_cluster_parameter_group(**kwargs)
  1. See CreateDBClusterParameterGroupMessageTypeDef

create_db_cluster_snapshot#

Creates a snapshot of a DB cluster.

Type annotations and code completion for boto3.client("neptune").create_db_cluster_snapshot method. boto3 documentation

# create_db_cluster_snapshot method definition

def create_db_cluster_snapshot(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
    DBClusterIdentifier: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBClusterSnapshotResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateDBClusterSnapshotResultTypeDef
# create_db_cluster_snapshot method usage example with argument unpacking

kwargs: CreateDBClusterSnapshotMessageTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
    "DBClusterIdentifier": ...,
}

parent.create_db_cluster_snapshot(**kwargs)
  1. See CreateDBClusterSnapshotMessageTypeDef

create_db_instance#

Creates a new DB instance.

Type annotations and code completion for boto3.client("neptune").create_db_instance method. boto3 documentation

# create_db_instance method definition

def create_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    DBInstanceClass: str,
    Engine: str,
    DBClusterIdentifier: str,
    DBName: str = ...,
    AllocatedStorage: int = ...,
    MasterUsername: str = ...,
    MasterUserPassword: str = ...,
    DBSecurityGroups: Sequence[str] = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    AvailabilityZone: str = ...,
    DBSubnetGroupName: str = ...,
    PreferredMaintenanceWindow: str = ...,
    DBParameterGroupName: str = ...,
    BackupRetentionPeriod: int = ...,
    PreferredBackupWindow: str = ...,
    Port: int = ...,
    MultiAZ: bool = ...,
    EngineVersion: str = ...,
    AutoMinorVersionUpgrade: bool = ...,
    LicenseModel: str = ...,
    Iops: int = ...,
    OptionGroupName: str = ...,
    CharacterSetName: str = ...,
    PubliclyAccessible: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    StorageType: str = ...,
    TdeCredentialArn: str = ...,
    TdeCredentialPassword: str = ...,
    StorageEncrypted: bool = ...,
    KmsKeyId: str = ...,
    Domain: str = ...,
    CopyTagsToSnapshot: bool = ...,
    MonitoringInterval: int = ...,
    MonitoringRoleArn: str = ...,
    DomainIAMRoleName: str = ...,
    PromotionTier: int = ...,
    Timezone: str = ...,
    EnableIAMDatabaseAuthentication: bool = ...,
    EnablePerformanceInsights: bool = ...,
    PerformanceInsightsKMSKeyId: str = ...,
    EnableCloudwatchLogsExports: Sequence[str] = ...,
    DeletionProtection: bool = ...,
) -> CreateDBInstanceResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateDBInstanceResultTypeDef
# create_db_instance method usage example with argument unpacking

kwargs: CreateDBInstanceMessageTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
    "DBInstanceClass": ...,
    "Engine": ...,
    "DBClusterIdentifier": ...,
}

parent.create_db_instance(**kwargs)
  1. See CreateDBInstanceMessageTypeDef

create_db_parameter_group#

Creates a new DB parameter group.

Type annotations and code completion for boto3.client("neptune").create_db_parameter_group method. boto3 documentation

# create_db_parameter_group method definition

def create_db_parameter_group(
    self,
    *,
    DBParameterGroupName: str,
    DBParameterGroupFamily: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBParameterGroupResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateDBParameterGroupResultTypeDef
# create_db_parameter_group method usage example with argument unpacking

kwargs: CreateDBParameterGroupMessageTypeDef = {  # (1)
    "DBParameterGroupName": ...,
    "DBParameterGroupFamily": ...,
    "Description": ...,
}

parent.create_db_parameter_group(**kwargs)
  1. See CreateDBParameterGroupMessageTypeDef

create_db_subnet_group#

Creates a new DB subnet group.

Type annotations and code completion for boto3.client("neptune").create_db_subnet_group method. boto3 documentation

# create_db_subnet_group method definition

def create_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
    DBSubnetGroupDescription: str,
    SubnetIds: Sequence[str],
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBSubnetGroupResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateDBSubnetGroupResultTypeDef
# create_db_subnet_group method usage example with argument unpacking

kwargs: CreateDBSubnetGroupMessageTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
    "DBSubnetGroupDescription": ...,
    "SubnetIds": ...,
}

parent.create_db_subnet_group(**kwargs)
  1. See CreateDBSubnetGroupMessageTypeDef

create_event_subscription#

Creates an event notification subscription.

Type annotations and code completion for boto3.client("neptune").create_event_subscription method. boto3 documentation

# create_event_subscription method definition

def create_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str,
    SourceType: str = ...,
    EventCategories: Sequence[str] = ...,
    SourceIds: Sequence[str] = ...,
    Enabled: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateEventSubscriptionResultTypeDef:  # (2)
    ...
  1. See Sequence[TagTypeDef]
  2. See CreateEventSubscriptionResultTypeDef
# create_event_subscription method usage example with argument unpacking

kwargs: CreateEventSubscriptionMessageTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SnsTopicArn": ...,
}

parent.create_event_subscription(**kwargs)
  1. See CreateEventSubscriptionMessageTypeDef

create_global_cluster#

Creates a Neptune global database spread across multiple Amazon Regions.

Type annotations and code completion for boto3.client("neptune").create_global_cluster method. boto3 documentation

# create_global_cluster method definition

def create_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    SourceDBClusterIdentifier: str = ...,
    Engine: str = ...,
    EngineVersion: str = ...,
    DeletionProtection: bool = ...,
    StorageEncrypted: bool = ...,
) -> CreateGlobalClusterResultTypeDef:  # (1)
    ...
  1. See CreateGlobalClusterResultTypeDef
# create_global_cluster method usage example with argument unpacking

kwargs: CreateGlobalClusterMessageTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.create_global_cluster(**kwargs)
  1. See CreateGlobalClusterMessageTypeDef

delete_db_cluster#

The DeleteDBCluster action deletes a previously provisioned DB cluster.

Type annotations and code completion for boto3.client("neptune").delete_db_cluster method. boto3 documentation

# delete_db_cluster method definition

def delete_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    SkipFinalSnapshot: bool = ...,
    FinalDBSnapshotIdentifier: str = ...,
) -> DeleteDBClusterResultTypeDef:  # (1)
    ...
  1. See DeleteDBClusterResultTypeDef
# delete_db_cluster method usage example with argument unpacking

kwargs: DeleteDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.delete_db_cluster(**kwargs)
  1. See DeleteDBClusterMessageTypeDef

delete_db_cluster_endpoint#

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

Type annotations and code completion for boto3.client("neptune").delete_db_cluster_endpoint method. boto3 documentation

# delete_db_cluster_endpoint method definition

def delete_db_cluster_endpoint(
    self,
    *,
    DBClusterEndpointIdentifier: str,
) -> DeleteDBClusterEndpointOutputTypeDef:  # (1)
    ...
  1. See DeleteDBClusterEndpointOutputTypeDef
# delete_db_cluster_endpoint method usage example with argument unpacking

kwargs: DeleteDBClusterEndpointMessageTypeDef = {  # (1)
    "DBClusterEndpointIdentifier": ...,
}

parent.delete_db_cluster_endpoint(**kwargs)
  1. See DeleteDBClusterEndpointMessageTypeDef

delete_db_cluster_parameter_group#

Deletes a specified DB cluster parameter group.

Type annotations and code completion for boto3.client("neptune").delete_db_cluster_parameter_group method. boto3 documentation

# delete_db_cluster_parameter_group method definition

def delete_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_db_cluster_parameter_group method usage example with argument unpacking

kwargs: DeleteDBClusterParameterGroupMessageTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.delete_db_cluster_parameter_group(**kwargs)
  1. See DeleteDBClusterParameterGroupMessageTypeDef

delete_db_cluster_snapshot#

Deletes a DB cluster snapshot.

Type annotations and code completion for boto3.client("neptune").delete_db_cluster_snapshot method. boto3 documentation

# delete_db_cluster_snapshot method definition

def delete_db_cluster_snapshot(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
) -> DeleteDBClusterSnapshotResultTypeDef:  # (1)
    ...
  1. See DeleteDBClusterSnapshotResultTypeDef
# delete_db_cluster_snapshot method usage example with argument unpacking

kwargs: DeleteDBClusterSnapshotMessageTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
}

parent.delete_db_cluster_snapshot(**kwargs)
  1. See DeleteDBClusterSnapshotMessageTypeDef

delete_db_instance#

The DeleteDBInstance action deletes a previously provisioned DB instance.

Type annotations and code completion for boto3.client("neptune").delete_db_instance method. boto3 documentation

# delete_db_instance method definition

def delete_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    SkipFinalSnapshot: bool = ...,
    FinalDBSnapshotIdentifier: str = ...,
) -> DeleteDBInstanceResultTypeDef:  # (1)
    ...
  1. See DeleteDBInstanceResultTypeDef
# delete_db_instance method usage example with argument unpacking

kwargs: DeleteDBInstanceMessageTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.delete_db_instance(**kwargs)
  1. See DeleteDBInstanceMessageTypeDef

delete_db_parameter_group#

Deletes a specified DBParameterGroup.

Type annotations and code completion for boto3.client("neptune").delete_db_parameter_group method. boto3 documentation

# delete_db_parameter_group method definition

def delete_db_parameter_group(
    self,
    *,
    DBParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_db_parameter_group method usage example with argument unpacking

kwargs: DeleteDBParameterGroupMessageTypeDef = {  # (1)
    "DBParameterGroupName": ...,
}

parent.delete_db_parameter_group(**kwargs)
  1. See DeleteDBParameterGroupMessageTypeDef

delete_db_subnet_group#

Deletes a DB subnet group.

Type annotations and code completion for boto3.client("neptune").delete_db_subnet_group method. boto3 documentation

# delete_db_subnet_group method definition

def delete_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_db_subnet_group method usage example with argument unpacking

kwargs: DeleteDBSubnetGroupMessageTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
}

parent.delete_db_subnet_group(**kwargs)
  1. See DeleteDBSubnetGroupMessageTypeDef

delete_event_subscription#

Deletes an event notification subscription.

Type annotations and code completion for boto3.client("neptune").delete_event_subscription method. boto3 documentation

# delete_event_subscription method definition

def delete_event_subscription(
    self,
    *,
    SubscriptionName: str,
) -> DeleteEventSubscriptionResultTypeDef:  # (1)
    ...
  1. See DeleteEventSubscriptionResultTypeDef
# delete_event_subscription method usage example with argument unpacking

kwargs: DeleteEventSubscriptionMessageTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.delete_event_subscription(**kwargs)
  1. See DeleteEventSubscriptionMessageTypeDef

delete_global_cluster#

Deletes a global database.

Type annotations and code completion for boto3.client("neptune").delete_global_cluster method. boto3 documentation

# delete_global_cluster method definition

def delete_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
) -> DeleteGlobalClusterResultTypeDef:  # (1)
    ...
  1. See DeleteGlobalClusterResultTypeDef
# delete_global_cluster method usage example with argument unpacking

kwargs: DeleteGlobalClusterMessageTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.delete_global_cluster(**kwargs)
  1. See DeleteGlobalClusterMessageTypeDef

describe_db_cluster_endpoints#

Returns information about endpoints for an Amazon Neptune DB cluster.

Type annotations and code completion for boto3.client("neptune").describe_db_cluster_endpoints method. boto3 documentation

# describe_db_cluster_endpoints method definition

def describe_db_cluster_endpoints(
    self,
    *,
    DBClusterIdentifier: str = ...,
    DBClusterEndpointIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBClusterEndpointMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBClusterEndpointMessageTypeDef
# describe_db_cluster_endpoints method usage example with argument unpacking

kwargs: DescribeDBClusterEndpointsMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.describe_db_cluster_endpoints(**kwargs)
  1. See DescribeDBClusterEndpointsMessageTypeDef

describe_db_cluster_parameter_groups#

Returns a list of DBClusterParameterGroup descriptions.

Type annotations and code completion for boto3.client("neptune").describe_db_cluster_parameter_groups method. boto3 documentation

# describe_db_cluster_parameter_groups method definition

def describe_db_cluster_parameter_groups(
    self,
    *,
    DBClusterParameterGroupName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBClusterParameterGroupsMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBClusterParameterGroupsMessageTypeDef
# describe_db_cluster_parameter_groups method usage example with argument unpacking

kwargs: DescribeDBClusterParameterGroupsMessageTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.describe_db_cluster_parameter_groups(**kwargs)
  1. See DescribeDBClusterParameterGroupsMessageTypeDef

describe_db_cluster_parameters#

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

Type annotations and code completion for boto3.client("neptune").describe_db_cluster_parameters method. boto3 documentation

# describe_db_cluster_parameters method definition

def describe_db_cluster_parameters(
    self,
    *,
    DBClusterParameterGroupName: str,
    Source: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBClusterParameterGroupDetailsTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBClusterParameterGroupDetailsTypeDef
# describe_db_cluster_parameters method usage example with argument unpacking

kwargs: DescribeDBClusterParametersMessageTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.describe_db_cluster_parameters(**kwargs)
  1. See DescribeDBClusterParametersMessageTypeDef

describe_db_cluster_snapshot_attributes#

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

Type annotations and code completion for boto3.client("neptune").describe_db_cluster_snapshot_attributes method. boto3 documentation

# describe_db_cluster_snapshot_attributes method definition

def describe_db_cluster_snapshot_attributes(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
) -> DescribeDBClusterSnapshotAttributesResultTypeDef:  # (1)
    ...
  1. See DescribeDBClusterSnapshotAttributesResultTypeDef
# describe_db_cluster_snapshot_attributes method usage example with argument unpacking

kwargs: DescribeDBClusterSnapshotAttributesMessageTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
}

parent.describe_db_cluster_snapshot_attributes(**kwargs)
  1. See DescribeDBClusterSnapshotAttributesMessageTypeDef

describe_db_cluster_snapshots#

Returns information about DB cluster snapshots.

Type annotations and code completion for boto3.client("neptune").describe_db_cluster_snapshots method. boto3 documentation

# describe_db_cluster_snapshots method definition

def describe_db_cluster_snapshots(
    self,
    *,
    DBClusterIdentifier: str = ...,
    DBClusterSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
) -> DBClusterSnapshotMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBClusterSnapshotMessageTypeDef
# describe_db_cluster_snapshots method usage example with argument unpacking

kwargs: DescribeDBClusterSnapshotsMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.describe_db_cluster_snapshots(**kwargs)
  1. See DescribeDBClusterSnapshotsMessageTypeDef

describe_db_clusters#

Returns information about provisioned DB clusters, and supports pagination.

Type annotations and code completion for boto3.client("neptune").describe_db_clusters method. boto3 documentation

# describe_db_clusters method definition

def describe_db_clusters(
    self,
    *,
    DBClusterIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBClusterMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBClusterMessageTypeDef
# describe_db_clusters method usage example with argument unpacking

kwargs: DescribeDBClustersMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.describe_db_clusters(**kwargs)
  1. See DescribeDBClustersMessageTypeDef

describe_db_engine_versions#

Returns a list of the available DB engines.

Type annotations and code completion for boto3.client("neptune").describe_db_engine_versions method. boto3 documentation

# describe_db_engine_versions method definition

def describe_db_engine_versions(
    self,
    *,
    Engine: str = ...,
    EngineVersion: str = ...,
    DBParameterGroupFamily: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    DefaultOnly: bool = ...,
    ListSupportedCharacterSets: bool = ...,
    ListSupportedTimezones: bool = ...,
) -> DBEngineVersionMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBEngineVersionMessageTypeDef
# describe_db_engine_versions method usage example with argument unpacking

kwargs: DescribeDBEngineVersionsMessageTypeDef = {  # (1)
    "Engine": ...,
}

parent.describe_db_engine_versions(**kwargs)
  1. See DescribeDBEngineVersionsMessageTypeDef

describe_db_instances#

Returns information about provisioned instances, and supports pagination.

Type annotations and code completion for boto3.client("neptune").describe_db_instances method. boto3 documentation

# describe_db_instances method definition

def describe_db_instances(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBInstanceMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBInstanceMessageTypeDef
# describe_db_instances method usage example with argument unpacking

kwargs: DescribeDBInstancesMessageTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.describe_db_instances(**kwargs)
  1. See DescribeDBInstancesMessageTypeDef

describe_db_parameter_groups#

Returns a list of DBParameterGroup descriptions.

Type annotations and code completion for boto3.client("neptune").describe_db_parameter_groups method. boto3 documentation

# describe_db_parameter_groups method definition

def describe_db_parameter_groups(
    self,
    *,
    DBParameterGroupName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBParameterGroupsMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBParameterGroupsMessageTypeDef
# describe_db_parameter_groups method usage example with argument unpacking

kwargs: DescribeDBParameterGroupsMessageTypeDef = {  # (1)
    "DBParameterGroupName": ...,
}

parent.describe_db_parameter_groups(**kwargs)
  1. See DescribeDBParameterGroupsMessageTypeDef

describe_db_parameters#

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

Type annotations and code completion for boto3.client("neptune").describe_db_parameters method. boto3 documentation

# describe_db_parameters method definition

def describe_db_parameters(
    self,
    *,
    DBParameterGroupName: str,
    Source: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBParameterGroupDetailsTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBParameterGroupDetailsTypeDef
# describe_db_parameters method usage example with argument unpacking

kwargs: DescribeDBParametersMessageTypeDef = {  # (1)
    "DBParameterGroupName": ...,
}

parent.describe_db_parameters(**kwargs)
  1. See DescribeDBParametersMessageTypeDef

describe_db_subnet_groups#

Returns a list of DBSubnetGroup descriptions.

Type annotations and code completion for boto3.client("neptune").describe_db_subnet_groups method. boto3 documentation

# describe_db_subnet_groups method definition

def describe_db_subnet_groups(
    self,
    *,
    DBSubnetGroupName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBSubnetGroupMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DBSubnetGroupMessageTypeDef
# describe_db_subnet_groups method usage example with argument unpacking

kwargs: DescribeDBSubnetGroupsMessageTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
}

parent.describe_db_subnet_groups(**kwargs)
  1. See DescribeDBSubnetGroupsMessageTypeDef

describe_engine_default_cluster_parameters#

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

Type annotations and code completion for boto3.client("neptune").describe_engine_default_cluster_parameters method. boto3 documentation

# describe_engine_default_cluster_parameters method definition

def describe_engine_default_cluster_parameters(
    self,
    *,
    DBParameterGroupFamily: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEngineDefaultClusterParametersResultTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DescribeEngineDefaultClusterParametersResultTypeDef
# describe_engine_default_cluster_parameters method usage example with argument unpacking

kwargs: DescribeEngineDefaultClusterParametersMessageTypeDef = {  # (1)
    "DBParameterGroupFamily": ...,
}

parent.describe_engine_default_cluster_parameters(**kwargs)
  1. See DescribeEngineDefaultClusterParametersMessageTypeDef

describe_engine_default_parameters#

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

Type annotations and code completion for boto3.client("neptune").describe_engine_default_parameters method. boto3 documentation

# describe_engine_default_parameters method definition

def describe_engine_default_parameters(
    self,
    *,
    DBParameterGroupFamily: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEngineDefaultParametersResultTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See DescribeEngineDefaultParametersResultTypeDef
# describe_engine_default_parameters method usage example with argument unpacking

kwargs: DescribeEngineDefaultParametersMessageTypeDef = {  # (1)
    "DBParameterGroupFamily": ...,
}

parent.describe_engine_default_parameters(**kwargs)
  1. See DescribeEngineDefaultParametersMessageTypeDef

describe_event_categories#

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

Type annotations and code completion for boto3.client("neptune").describe_event_categories method. boto3 documentation

# describe_event_categories method definition

def describe_event_categories(
    self,
    *,
    SourceType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> EventCategoriesMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See EventCategoriesMessageTypeDef
# describe_event_categories method usage example with argument unpacking

kwargs: DescribeEventCategoriesMessageTypeDef = {  # (1)
    "SourceType": ...,
}

parent.describe_event_categories(**kwargs)
  1. See DescribeEventCategoriesMessageTypeDef

describe_event_subscriptions#

Lists all the subscription descriptions for a customer account.

Type annotations and code completion for boto3.client("neptune").describe_event_subscriptions method. boto3 documentation

# describe_event_subscriptions method definition

def describe_event_subscriptions(
    self,
    *,
    SubscriptionName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EventSubscriptionsMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See EventSubscriptionsMessageTypeDef
# describe_event_subscriptions method usage example with argument unpacking

kwargs: DescribeEventSubscriptionsMessageTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.describe_event_subscriptions(**kwargs)
  1. See DescribeEventSubscriptionsMessageTypeDef

describe_events#

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.

Type annotations and code completion for boto3.client("neptune").describe_events method. boto3 documentation

# describe_events method definition

def describe_events(
    self,
    *,
    SourceIdentifier: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    Duration: int = ...,
    EventCategories: Sequence[str] = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EventsMessageTypeDef:  # (3)
    ...
  1. See SourceTypeType
  2. See Sequence[FilterTypeDef]
  3. See EventsMessageTypeDef
# describe_events method usage example with argument unpacking

kwargs: DescribeEventsMessageTypeDef = {  # (1)
    "SourceIdentifier": ...,
}

parent.describe_events(**kwargs)
  1. See DescribeEventsMessageTypeDef

describe_global_clusters#

Returns information about Neptune global database clusters.

Type annotations and code completion for boto3.client("neptune").describe_global_clusters method. boto3 documentation

# describe_global_clusters method definition

def describe_global_clusters(
    self,
    *,
    GlobalClusterIdentifier: str = ...,
    MaxRecords: int = ...,
    Marker: str = ...,
) -> GlobalClustersMessageTypeDef:  # (1)
    ...
  1. See GlobalClustersMessageTypeDef
# describe_global_clusters method usage example with argument unpacking

kwargs: DescribeGlobalClustersMessageTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.describe_global_clusters(**kwargs)
  1. See DescribeGlobalClustersMessageTypeDef

describe_orderable_db_instance_options#

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

Type annotations and code completion for boto3.client("neptune").describe_orderable_db_instance_options method. boto3 documentation

# describe_orderable_db_instance_options method definition

def describe_orderable_db_instance_options(
    self,
    *,
    Engine: str,
    EngineVersion: str = ...,
    DBInstanceClass: str = ...,
    LicenseModel: str = ...,
    Vpc: bool = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> OrderableDBInstanceOptionsMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See OrderableDBInstanceOptionsMessageTypeDef
# describe_orderable_db_instance_options method usage example with argument unpacking

kwargs: DescribeOrderableDBInstanceOptionsMessageTypeDef = {  # (1)
    "Engine": ...,
}

parent.describe_orderable_db_instance_options(**kwargs)
  1. See DescribeOrderableDBInstanceOptionsMessageTypeDef

describe_pending_maintenance_actions#

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

Type annotations and code completion for boto3.client("neptune").describe_pending_maintenance_actions method. boto3 documentation

# describe_pending_maintenance_actions method definition

def describe_pending_maintenance_actions(
    self,
    *,
    ResourceIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    Marker: str = ...,
    MaxRecords: int = ...,
) -> PendingMaintenanceActionsMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See PendingMaintenanceActionsMessageTypeDef
# describe_pending_maintenance_actions method usage example with argument unpacking

kwargs: DescribePendingMaintenanceActionsMessageTypeDef = {  # (1)
    "ResourceIdentifier": ...,
}

parent.describe_pending_maintenance_actions(**kwargs)
  1. See DescribePendingMaintenanceActionsMessageTypeDef

describe_valid_db_instance_modifications#

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.

Type annotations and code completion for boto3.client("neptune").describe_valid_db_instance_modifications method. boto3 documentation

# describe_valid_db_instance_modifications method definition

def describe_valid_db_instance_modifications(
    self,
    *,
    DBInstanceIdentifier: str,
) -> DescribeValidDBInstanceModificationsResultTypeDef:  # (1)
    ...
  1. See DescribeValidDBInstanceModificationsResultTypeDef
# describe_valid_db_instance_modifications method usage example with argument unpacking

kwargs: DescribeValidDBInstanceModificationsMessageTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.describe_valid_db_instance_modifications(**kwargs)
  1. See DescribeValidDBInstanceModificationsMessageTypeDef

failover_db_cluster#

Forces a failover for a DB cluster.

Type annotations and code completion for boto3.client("neptune").failover_db_cluster method. boto3 documentation

# failover_db_cluster method definition

def failover_db_cluster(
    self,
    *,
    DBClusterIdentifier: str = ...,
    TargetDBInstanceIdentifier: str = ...,
) -> FailoverDBClusterResultTypeDef:  # (1)
    ...
  1. See FailoverDBClusterResultTypeDef
# failover_db_cluster method usage example with argument unpacking

kwargs: FailoverDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.failover_db_cluster(**kwargs)
  1. See FailoverDBClusterMessageTypeDef

failover_global_cluster#

Initiates the failover process for a Neptune global database.

Type annotations and code completion for boto3.client("neptune").failover_global_cluster method. boto3 documentation

# failover_global_cluster method definition

def failover_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    TargetDbClusterIdentifier: str,
    AllowDataLoss: bool = ...,
    Switchover: bool = ...,
) -> FailoverGlobalClusterResultTypeDef:  # (1)
    ...
  1. See FailoverGlobalClusterResultTypeDef
# failover_global_cluster method usage example with argument unpacking

kwargs: FailoverGlobalClusterMessageTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
    "TargetDbClusterIdentifier": ...,
}

parent.failover_global_cluster(**kwargs)
  1. See FailoverGlobalClusterMessageTypeDef

list_tags_for_resource#

Lists all tags on an Amazon Neptune resource.

Type annotations and code completion for boto3.client("neptune").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceName: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> TagListMessageTypeDef:  # (2)
    ...
  1. See Sequence[FilterTypeDef]
  2. See TagListMessageTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceMessageTypeDef = {  # (1)
    "ResourceName": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceMessageTypeDef

modify_db_cluster#

Modify a setting for a DB cluster.

Type annotations and code completion for boto3.client("neptune").modify_db_cluster method. boto3 documentation

# modify_db_cluster method definition

def modify_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    NewDBClusterIdentifier: str = ...,
    ApplyImmediately: bool = ...,
    BackupRetentionPeriod: int = ...,
    DBClusterParameterGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    Port: int = ...,
    MasterUserPassword: str = ...,
    OptionGroupName: str = ...,
    PreferredBackupWindow: str = ...,
    PreferredMaintenanceWindow: str = ...,
    EnableIAMDatabaseAuthentication: bool = ...,
    CloudwatchLogsExportConfiguration: CloudwatchLogsExportConfigurationTypeDef = ...,  # (1)
    EngineVersion: str = ...,
    AllowMajorVersionUpgrade: bool = ...,
    DBInstanceParameterGroupName: str = ...,
    DeletionProtection: bool = ...,
    CopyTagsToSnapshot: bool = ...,
    ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfigurationTypeDef = ...,  # (2)
    StorageType: str = ...,
) -> ModifyDBClusterResultTypeDef:  # (3)
    ...
  1. See CloudwatchLogsExportConfigurationTypeDef
  2. See ServerlessV2ScalingConfigurationTypeDef
  3. See ModifyDBClusterResultTypeDef
# modify_db_cluster method usage example with argument unpacking

kwargs: ModifyDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.modify_db_cluster(**kwargs)
  1. See ModifyDBClusterMessageTypeDef

modify_db_cluster_endpoint#

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

Type annotations and code completion for boto3.client("neptune").modify_db_cluster_endpoint method. boto3 documentation

# modify_db_cluster_endpoint method definition

def modify_db_cluster_endpoint(
    self,
    *,
    DBClusterEndpointIdentifier: str,
    EndpointType: str = ...,
    StaticMembers: Sequence[str] = ...,
    ExcludedMembers: Sequence[str] = ...,
) -> ModifyDBClusterEndpointOutputTypeDef:  # (1)
    ...
  1. See ModifyDBClusterEndpointOutputTypeDef
# modify_db_cluster_endpoint method usage example with argument unpacking

kwargs: ModifyDBClusterEndpointMessageTypeDef = {  # (1)
    "DBClusterEndpointIdentifier": ...,
}

parent.modify_db_cluster_endpoint(**kwargs)
  1. See ModifyDBClusterEndpointMessageTypeDef

modify_db_cluster_parameter_group#

Modifies the parameters of a DB cluster parameter group.

Type annotations and code completion for boto3.client("neptune").modify_db_cluster_parameter_group method. boto3 documentation

# modify_db_cluster_parameter_group method definition

def modify_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
    Parameters: Sequence[ParameterTypeDef],  # (1)
) -> DBClusterParameterGroupNameMessageTypeDef:  # (2)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See DBClusterParameterGroupNameMessageTypeDef
# modify_db_cluster_parameter_group method usage example with argument unpacking

kwargs: ModifyDBClusterParameterGroupMessageTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
    "Parameters": ...,
}

parent.modify_db_cluster_parameter_group(**kwargs)
  1. See ModifyDBClusterParameterGroupMessageTypeDef

modify_db_cluster_snapshot_attribute#

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

Type annotations and code completion for boto3.client("neptune").modify_db_cluster_snapshot_attribute method. boto3 documentation

# modify_db_cluster_snapshot_attribute method definition

def modify_db_cluster_snapshot_attribute(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
    AttributeName: str,
    ValuesToAdd: Sequence[str] = ...,
    ValuesToRemove: Sequence[str] = ...,
) -> ModifyDBClusterSnapshotAttributeResultTypeDef:  # (1)
    ...
  1. See ModifyDBClusterSnapshotAttributeResultTypeDef
# modify_db_cluster_snapshot_attribute method usage example with argument unpacking

kwargs: ModifyDBClusterSnapshotAttributeMessageTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
    "AttributeName": ...,
}

parent.modify_db_cluster_snapshot_attribute(**kwargs)
  1. See ModifyDBClusterSnapshotAttributeMessageTypeDef

modify_db_instance#

Modifies settings for a DB instance.

Type annotations and code completion for boto3.client("neptune").modify_db_instance method. boto3 documentation

# modify_db_instance method definition

def modify_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    AllocatedStorage: int = ...,
    DBInstanceClass: str = ...,
    DBSubnetGroupName: str = ...,
    DBSecurityGroups: Sequence[str] = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    ApplyImmediately: bool = ...,
    MasterUserPassword: str = ...,
    DBParameterGroupName: str = ...,
    BackupRetentionPeriod: int = ...,
    PreferredBackupWindow: str = ...,
    PreferredMaintenanceWindow: str = ...,
    MultiAZ: bool = ...,
    EngineVersion: str = ...,
    AllowMajorVersionUpgrade: bool = ...,
    AutoMinorVersionUpgrade: bool = ...,
    LicenseModel: str = ...,
    Iops: int = ...,
    OptionGroupName: str = ...,
    NewDBInstanceIdentifier: str = ...,
    StorageType: str = ...,
    TdeCredentialArn: str = ...,
    TdeCredentialPassword: str = ...,
    CACertificateIdentifier: str = ...,
    Domain: str = ...,
    CopyTagsToSnapshot: bool = ...,
    MonitoringInterval: int = ...,
    DBPortNumber: int = ...,
    PubliclyAccessible: bool = ...,
    MonitoringRoleArn: str = ...,
    DomainIAMRoleName: str = ...,
    PromotionTier: int = ...,
    EnableIAMDatabaseAuthentication: bool = ...,
    EnablePerformanceInsights: bool = ...,
    PerformanceInsightsKMSKeyId: str = ...,
    CloudwatchLogsExportConfiguration: CloudwatchLogsExportConfigurationTypeDef = ...,  # (1)
    DeletionProtection: bool = ...,
) -> ModifyDBInstanceResultTypeDef:  # (2)
    ...
  1. See CloudwatchLogsExportConfigurationTypeDef
  2. See ModifyDBInstanceResultTypeDef
# modify_db_instance method usage example with argument unpacking

kwargs: ModifyDBInstanceMessageTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.modify_db_instance(**kwargs)
  1. See ModifyDBInstanceMessageTypeDef

modify_db_parameter_group#

Modifies the parameters of a DB parameter group.

Type annotations and code completion for boto3.client("neptune").modify_db_parameter_group method. boto3 documentation

# modify_db_parameter_group method definition

def modify_db_parameter_group(
    self,
    *,
    DBParameterGroupName: str,
    Parameters: Sequence[ParameterTypeDef],  # (1)
) -> DBParameterGroupNameMessageTypeDef:  # (2)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See DBParameterGroupNameMessageTypeDef
# modify_db_parameter_group method usage example with argument unpacking

kwargs: ModifyDBParameterGroupMessageTypeDef = {  # (1)
    "DBParameterGroupName": ...,
    "Parameters": ...,
}

parent.modify_db_parameter_group(**kwargs)
  1. See ModifyDBParameterGroupMessageTypeDef

modify_db_subnet_group#

Modifies an existing DB subnet group.

Type annotations and code completion for boto3.client("neptune").modify_db_subnet_group method. boto3 documentation

# modify_db_subnet_group method definition

def modify_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
    SubnetIds: Sequence[str],
    DBSubnetGroupDescription: str = ...,
) -> ModifyDBSubnetGroupResultTypeDef:  # (1)
    ...
  1. See ModifyDBSubnetGroupResultTypeDef
# modify_db_subnet_group method usage example with argument unpacking

kwargs: ModifyDBSubnetGroupMessageTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
    "SubnetIds": ...,
}

parent.modify_db_subnet_group(**kwargs)
  1. See ModifyDBSubnetGroupMessageTypeDef

modify_event_subscription#

Modifies an existing event notification subscription.

Type annotations and code completion for boto3.client("neptune").modify_event_subscription method. boto3 documentation

# modify_event_subscription method definition

def modify_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str = ...,
    SourceType: str = ...,
    EventCategories: Sequence[str] = ...,
    Enabled: bool = ...,
) -> ModifyEventSubscriptionResultTypeDef:  # (1)
    ...
  1. See ModifyEventSubscriptionResultTypeDef
# modify_event_subscription method usage example with argument unpacking

kwargs: ModifyEventSubscriptionMessageTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.modify_event_subscription(**kwargs)
  1. See ModifyEventSubscriptionMessageTypeDef

modify_global_cluster#

Modify a setting for an Amazon Neptune global cluster.

Type annotations and code completion for boto3.client("neptune").modify_global_cluster method. boto3 documentation

# modify_global_cluster method definition

def modify_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    NewGlobalClusterIdentifier: str = ...,
    DeletionProtection: bool = ...,
    EngineVersion: str = ...,
    AllowMajorVersionUpgrade: bool = ...,
) -> ModifyGlobalClusterResultTypeDef:  # (1)
    ...
  1. See ModifyGlobalClusterResultTypeDef
# modify_global_cluster method usage example with argument unpacking

kwargs: ModifyGlobalClusterMessageTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.modify_global_cluster(**kwargs)
  1. See ModifyGlobalClusterMessageTypeDef

promote_read_replica_db_cluster#

Not supported.

Type annotations and code completion for boto3.client("neptune").promote_read_replica_db_cluster method. boto3 documentation

# promote_read_replica_db_cluster method definition

def promote_read_replica_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
) -> PromoteReadReplicaDBClusterResultTypeDef:  # (1)
    ...
  1. See PromoteReadReplicaDBClusterResultTypeDef
# promote_read_replica_db_cluster method usage example with argument unpacking

kwargs: PromoteReadReplicaDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.promote_read_replica_db_cluster(**kwargs)
  1. See PromoteReadReplicaDBClusterMessageTypeDef

reboot_db_instance#

You might need to reboot your DB instance, usually for maintenance reasons.

Type annotations and code completion for boto3.client("neptune").reboot_db_instance method. boto3 documentation

# reboot_db_instance method definition

def reboot_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    ForceFailover: bool = ...,
) -> RebootDBInstanceResultTypeDef:  # (1)
    ...
  1. See RebootDBInstanceResultTypeDef
# reboot_db_instance method usage example with argument unpacking

kwargs: RebootDBInstanceMessageTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.reboot_db_instance(**kwargs)
  1. See RebootDBInstanceMessageTypeDef

remove_from_global_cluster#

Detaches a Neptune DB cluster from a Neptune global database.

Type annotations and code completion for boto3.client("neptune").remove_from_global_cluster method. boto3 documentation

# remove_from_global_cluster method definition

def remove_from_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    DbClusterIdentifier: str,
) -> RemoveFromGlobalClusterResultTypeDef:  # (1)
    ...
  1. See RemoveFromGlobalClusterResultTypeDef
# remove_from_global_cluster method usage example with argument unpacking

kwargs: RemoveFromGlobalClusterMessageTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
    "DbClusterIdentifier": ...,
}

parent.remove_from_global_cluster(**kwargs)
  1. See RemoveFromGlobalClusterMessageTypeDef

remove_role_from_db_cluster#

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

Type annotations and code completion for boto3.client("neptune").remove_role_from_db_cluster method. boto3 documentation

# remove_role_from_db_cluster method definition

def remove_role_from_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    RoleArn: str,
    FeatureName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# remove_role_from_db_cluster method usage example with argument unpacking

kwargs: RemoveRoleFromDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "RoleArn": ...,
}

parent.remove_role_from_db_cluster(**kwargs)
  1. See RemoveRoleFromDBClusterMessageTypeDef

remove_source_identifier_from_subscription#

Removes a source identifier from an existing event notification subscription.

Type annotations and code completion for boto3.client("neptune").remove_source_identifier_from_subscription method. boto3 documentation

# remove_source_identifier_from_subscription method definition

def remove_source_identifier_from_subscription(
    self,
    *,
    SubscriptionName: str,
    SourceIdentifier: str,
) -> RemoveSourceIdentifierFromSubscriptionResultTypeDef:  # (1)
    ...
  1. See RemoveSourceIdentifierFromSubscriptionResultTypeDef
# remove_source_identifier_from_subscription method usage example with argument unpacking

kwargs: RemoveSourceIdentifierFromSubscriptionMessageTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SourceIdentifier": ...,
}

parent.remove_source_identifier_from_subscription(**kwargs)
  1. See RemoveSourceIdentifierFromSubscriptionMessageTypeDef

remove_tags_from_resource#

Removes metadata tags from an Amazon Neptune resource.

Type annotations and code completion for boto3.client("neptune").remove_tags_from_resource method. boto3 documentation

# remove_tags_from_resource method definition

def remove_tags_from_resource(
    self,
    *,
    ResourceName: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# remove_tags_from_resource method usage example with argument unpacking

kwargs: RemoveTagsFromResourceMessageTypeDef = {  # (1)
    "ResourceName": ...,
    "TagKeys": ...,
}

parent.remove_tags_from_resource(**kwargs)
  1. See RemoveTagsFromResourceMessageTypeDef

reset_db_cluster_parameter_group#

Modifies the parameters of a DB cluster parameter group to the default value.

Type annotations and code completion for boto3.client("neptune").reset_db_cluster_parameter_group method. boto3 documentation

# reset_db_cluster_parameter_group method definition

def reset_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
    ResetAllParameters: bool = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
) -> DBClusterParameterGroupNameMessageTypeDef:  # (2)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See DBClusterParameterGroupNameMessageTypeDef
# reset_db_cluster_parameter_group method usage example with argument unpacking

kwargs: ResetDBClusterParameterGroupMessageTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.reset_db_cluster_parameter_group(**kwargs)
  1. See ResetDBClusterParameterGroupMessageTypeDef

reset_db_parameter_group#

Modifies the parameters of a DB parameter group to the engine/system default value.

Type annotations and code completion for boto3.client("neptune").reset_db_parameter_group method. boto3 documentation

# reset_db_parameter_group method definition

def reset_db_parameter_group(
    self,
    *,
    DBParameterGroupName: str,
    ResetAllParameters: bool = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
) -> DBParameterGroupNameMessageTypeDef:  # (2)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See DBParameterGroupNameMessageTypeDef
# reset_db_parameter_group method usage example with argument unpacking

kwargs: ResetDBParameterGroupMessageTypeDef = {  # (1)
    "DBParameterGroupName": ...,
}

parent.reset_db_parameter_group(**kwargs)
  1. See ResetDBParameterGroupMessageTypeDef

restore_db_cluster_from_snapshot#

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

Type annotations and code completion for boto3.client("neptune").restore_db_cluster_from_snapshot method. boto3 documentation

# restore_db_cluster_from_snapshot method definition

def restore_db_cluster_from_snapshot(
    self,
    *,
    DBClusterIdentifier: str,
    SnapshotIdentifier: str,
    Engine: str,
    AvailabilityZones: Sequence[str] = ...,
    EngineVersion: str = ...,
    Port: int = ...,
    DBSubnetGroupName: str = ...,
    DatabaseName: str = ...,
    OptionGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    KmsKeyId: str = ...,
    EnableIAMDatabaseAuthentication: bool = ...,
    EnableCloudwatchLogsExports: Sequence[str] = ...,
    DBClusterParameterGroupName: str = ...,
    DeletionProtection: bool = ...,
    CopyTagsToSnapshot: bool = ...,
    ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfigurationTypeDef = ...,  # (2)
    StorageType: str = ...,
) -> RestoreDBClusterFromSnapshotResultTypeDef:  # (3)
    ...
  1. See Sequence[TagTypeDef]
  2. See ServerlessV2ScalingConfigurationTypeDef
  3. See RestoreDBClusterFromSnapshotResultTypeDef
# restore_db_cluster_from_snapshot method usage example with argument unpacking

kwargs: RestoreDBClusterFromSnapshotMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "SnapshotIdentifier": ...,
    "Engine": ...,
}

parent.restore_db_cluster_from_snapshot(**kwargs)
  1. See RestoreDBClusterFromSnapshotMessageTypeDef

restore_db_cluster_to_point_in_time#

Restores a DB cluster to an arbitrary point in time.

Type annotations and code completion for boto3.client("neptune").restore_db_cluster_to_point_in_time method. boto3 documentation

# restore_db_cluster_to_point_in_time method definition

def restore_db_cluster_to_point_in_time(
    self,
    *,
    DBClusterIdentifier: str,
    SourceDBClusterIdentifier: str,
    RestoreType: str = ...,
    RestoreToTime: TimestampTypeDef = ...,
    UseLatestRestorableTime: bool = ...,
    Port: int = ...,
    DBSubnetGroupName: str = ...,
    OptionGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    KmsKeyId: str = ...,
    EnableIAMDatabaseAuthentication: bool = ...,
    EnableCloudwatchLogsExports: Sequence[str] = ...,
    DBClusterParameterGroupName: str = ...,
    DeletionProtection: bool = ...,
    ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfigurationTypeDef = ...,  # (2)
    StorageType: str = ...,
) -> RestoreDBClusterToPointInTimeResultTypeDef:  # (3)
    ...
  1. See Sequence[TagTypeDef]
  2. See ServerlessV2ScalingConfigurationTypeDef
  3. See RestoreDBClusterToPointInTimeResultTypeDef
# restore_db_cluster_to_point_in_time method usage example with argument unpacking

kwargs: RestoreDBClusterToPointInTimeMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "SourceDBClusterIdentifier": ...,
}

parent.restore_db_cluster_to_point_in_time(**kwargs)
  1. See RestoreDBClusterToPointInTimeMessageTypeDef

start_db_cluster#

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

Type annotations and code completion for boto3.client("neptune").start_db_cluster method. boto3 documentation

# start_db_cluster method definition

def start_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
) -> StartDBClusterResultTypeDef:  # (1)
    ...
  1. See StartDBClusterResultTypeDef
# start_db_cluster method usage example with argument unpacking

kwargs: StartDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.start_db_cluster(**kwargs)
  1. See StartDBClusterMessageTypeDef

stop_db_cluster#

Stops an Amazon Neptune DB cluster.

Type annotations and code completion for boto3.client("neptune").stop_db_cluster method. boto3 documentation

# stop_db_cluster method definition

def stop_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
) -> StopDBClusterResultTypeDef:  # (1)
    ...
  1. See StopDBClusterResultTypeDef
# stop_db_cluster method usage example with argument unpacking

kwargs: StopDBClusterMessageTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.stop_db_cluster(**kwargs)
  1. See StopDBClusterMessageTypeDef

switchover_global_cluster#

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.

Type annotations and code completion for boto3.client("neptune").switchover_global_cluster method. boto3 documentation

# switchover_global_cluster method definition

def switchover_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    TargetDbClusterIdentifier: str,
) -> SwitchoverGlobalClusterResultTypeDef:  # (1)
    ...
  1. See SwitchoverGlobalClusterResultTypeDef
# switchover_global_cluster method usage example with argument unpacking

kwargs: SwitchoverGlobalClusterMessageTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
    "TargetDbClusterIdentifier": ...,
}

parent.switchover_global_cluster(**kwargs)
  1. See SwitchoverGlobalClusterMessageTypeDef

get_paginator#

Type annotations and code completion for boto3.client("neptune").get_paginator method with overloads.

get_waiter#

Type annotations and code completion for boto3.client("neptune").get_waiter method with overloads.