Skip to content

OdbClient#

Index > Odb > OdbClient

Auto-generated documentation for Odb type annotations stubs module mypy-boto3-odb.

OdbClient#

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

# OdbClient usage example

from boto3.session import Session
from mypy_boto3_odb.client import OdbClient

def get_odb_client() -> OdbClient:
    return Session().client("odb")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("odb")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_odb.client import Exceptions

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

Methods#

can_paginate#

Type annotations and code completion for boto3.client("odb").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("odb").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:
    ...

accept_marketplace_registration#

Registers the Amazon Web Services Marketplace token for your Amazon Web Services account to activate your Oracle Database@Amazon Web Services subscription.

Type annotations and code completion for boto3.client("odb").accept_marketplace_registration method. boto3 documentation

# accept_marketplace_registration method definition

def accept_marketplace_registration(
    self,
    *,
    marketplaceRegistrationToken: str,
) -> dict[str, Any]:
    ...
# accept_marketplace_registration method usage example with argument unpacking

kwargs: AcceptMarketplaceRegistrationInputTypeDef = {  # (1)
    "marketplaceRegistrationToken": ...,
}

parent.accept_marketplace_registration(**kwargs)
  1. See AcceptMarketplaceRegistrationInputTypeDef

associate_iam_role_to_resource#

Associates an Amazon Web Services Identity and Access Management (IAM) service role with a specified resource to enable Amazon Web Services service integration.

Type annotations and code completion for boto3.client("odb").associate_iam_role_to_resource method. boto3 documentation

# associate_iam_role_to_resource method definition

def associate_iam_role_to_resource(
    self,
    *,
    iamRoleArn: str,
    awsIntegration: SupportedAwsIntegrationType,  # (1)
    resourceArn: str,
) -> dict[str, Any]:
    ...
  1. See SupportedAwsIntegrationType
# associate_iam_role_to_resource method usage example with argument unpacking

kwargs: AssociateIamRoleToResourceInputTypeDef = {  # (1)
    "iamRoleArn": ...,
    "awsIntegration": ...,
    "resourceArn": ...,
}

parent.associate_iam_role_to_resource(**kwargs)
  1. See AssociateIamRoleToResourceInputTypeDef

create_autonomous_database#

Creates a new Autonomous Database.

Type annotations and code completion for boto3.client("odb").create_autonomous_database method. boto3 documentation

# create_autonomous_database method definition

def create_autonomous_database(
    self,
    *,
    odbNetworkId: str = ...,
    displayName: str = ...,
    dbName: str = ...,
    adminPassword: str = ...,
    computeCount: float = ...,
    dataStorageSizeInTBs: int = ...,
    dataStorageSizeInGBs: int = ...,
    dbWorkload: DbWorkloadType = ...,  # (1)
    isAutoScalingEnabled: bool = ...,
    isAutoScalingForStorageEnabled: bool = ...,
    licenseModel: LicenseModelType = ...,  # (2)
    characterSet: str = ...,
    ncharacterSet: str = ...,
    dbVersion: str = ...,
    databaseEdition: DatabaseEditionType = ...,  # (3)
    standbyAllowlistedIpsSource: StandbyAllowlistedIpsSourceType = ...,  # (4)
    autonomousMaintenanceScheduleType: AutonomousMaintenanceScheduleTypeType = ...,  # (5)
    backupRetentionPeriodInDays: int = ...,
    byolComputeCountLimit: float = ...,
    cpuCoreCount: int = ...,
    customerContactsToSendToOCI: Sequence[CustomerContactTypeDef] = ...,  # (6)
    privateEndpointIp: str = ...,
    privateEndpointLabel: str = ...,
    resourcePoolLeaderId: str = ...,
    resourcePoolSummary: ResourcePoolSummaryTypeDef = ...,  # (7)
    scheduledOperations: Sequence[ScheduledOperationDetailsTypeDef] = ...,  # (8)
    standbyAllowlistedIps: Sequence[str] = ...,
    allowlistedIps: Sequence[str] = ...,
    transportableTablespace: TransportableTablespaceTypeDef = ...,  # (9)
    isBackupRetentionLocked: bool = ...,
    isLocalDataGuardEnabled: bool = ...,
    isMtlsConnectionRequired: bool = ...,
    dbToolsDetails: Sequence[DatabaseToolTypeDef] = ...,  # (10)
    source: SourceTypeType = ...,  # (11)
    sourceConfiguration: SourceConfigurationTypeDef = ...,  # (12)
    encryptionKeyProvider: EncryptionKeyProviderInputType = ...,  # (13)
    encryptionKeyConfiguration: EncryptionKeyConfigurationInputTypeDef = ...,  # (14)
    adminPasswordSource: AdminPasswordSourceType = ...,  # (15)
    adminPasswordSourceConfiguration: AdminPasswordSourceConfigurationInputTypeDef = ...,  # (16)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAutonomousDatabaseOutputTypeDef:  # (17)
    ...
  1. See DbWorkloadType
  2. See LicenseModelType
  3. See DatabaseEditionType
  4. See StandbyAllowlistedIpsSourceType
  5. See AutonomousMaintenanceScheduleTypeType
  6. See Sequence[CustomerContactTypeDef]
  7. See ResourcePoolSummaryTypeDef
  8. See Sequence[ScheduledOperationDetailsTypeDef]
  9. See TransportableTablespaceTypeDef
  10. See Sequence[DatabaseToolTypeDef]
  11. See SourceTypeType
  12. See SourceConfigurationTypeDef
  13. See EncryptionKeyProviderInputType
  14. See EncryptionKeyConfigurationInputTypeDef
  15. See AdminPasswordSourceType
  16. See AdminPasswordSourceConfigurationInputTypeDef
  17. See CreateAutonomousDatabaseOutputTypeDef
# create_autonomous_database method usage example with argument unpacking

kwargs: CreateAutonomousDatabaseInputTypeDef = {  # (1)
    "odbNetworkId": ...,
}

parent.create_autonomous_database(**kwargs)
  1. See CreateAutonomousDatabaseInputTypeDef

create_autonomous_database_backup#

Creates a new backup of the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").create_autonomous_database_backup method. boto3 documentation

# create_autonomous_database_backup method definition

def create_autonomous_database_backup(
    self,
    *,
    autonomousDatabaseId: str,
    displayName: str = ...,
    retentionPeriodInDays: int = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAutonomousDatabaseBackupOutputTypeDef:  # (1)
    ...
  1. See CreateAutonomousDatabaseBackupOutputTypeDef
# create_autonomous_database_backup method usage example with argument unpacking

kwargs: CreateAutonomousDatabaseBackupInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.create_autonomous_database_backup(**kwargs)
  1. See CreateAutonomousDatabaseBackupInputTypeDef

create_autonomous_database_wallet#

Creates a new wallet for the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").create_autonomous_database_wallet method. boto3 documentation

# create_autonomous_database_wallet method definition

def create_autonomous_database_wallet(
    self,
    *,
    autonomousDatabaseId: str,
    walletType: WalletTypeType = ...,  # (1)
    password: str = ...,
    passwordSource: WalletPasswordSourceType = ...,  # (2)
    passwordSourceConfiguration: WalletPasswordSourceConfigurationInputTypeDef = ...,  # (3)
    clientToken: str = ...,
) -> CreateAutonomousDatabaseWalletOutputTypeDef:  # (4)
    ...
  1. See WalletTypeType
  2. See WalletPasswordSourceType
  3. See WalletPasswordSourceConfigurationInputTypeDef
  4. See CreateAutonomousDatabaseWalletOutputTypeDef
# create_autonomous_database_wallet method usage example with argument unpacking

kwargs: CreateAutonomousDatabaseWalletInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.create_autonomous_database_wallet(**kwargs)
  1. See CreateAutonomousDatabaseWalletInputTypeDef

create_cloud_autonomous_vm_cluster#

Creates a new Autonomous VM cluster in the specified Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").create_cloud_autonomous_vm_cluster method. boto3 documentation

# create_cloud_autonomous_vm_cluster method definition

def create_cloud_autonomous_vm_cluster(
    self,
    *,
    cloudExadataInfrastructureId: str,
    odbNetworkId: str,
    displayName: str,
    autonomousDataStorageSizeInTBs: float,
    cpuCoreCountPerNode: int,
    memoryPerOracleComputeUnitInGBs: int,
    totalContainerDatabases: int,
    clientToken: str = ...,
    dbServers: Sequence[str] = ...,
    description: str = ...,
    isMtlsEnabledVmCluster: bool = ...,
    licenseModel: LicenseModelType = ...,  # (1)
    maintenanceWindow: MaintenanceWindowUnionTypeDef = ...,  # (2)
    scanListenerPortNonTls: int = ...,
    scanListenerPortTls: int = ...,
    tags: Mapping[str, str] = ...,
    timeZone: str = ...,
) -> CreateCloudAutonomousVmClusterOutputTypeDef:  # (3)
    ...
  1. See LicenseModelType
  2. See MaintenanceWindowUnionTypeDef
  3. See CreateCloudAutonomousVmClusterOutputTypeDef
# create_cloud_autonomous_vm_cluster method usage example with argument unpacking

kwargs: CreateCloudAutonomousVmClusterInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
    "odbNetworkId": ...,
    "displayName": ...,
    "autonomousDataStorageSizeInTBs": ...,
    "cpuCoreCountPerNode": ...,
    "memoryPerOracleComputeUnitInGBs": ...,
    "totalContainerDatabases": ...,
}

parent.create_cloud_autonomous_vm_cluster(**kwargs)
  1. See CreateCloudAutonomousVmClusterInputTypeDef

create_cloud_exadata_infrastructure#

Creates an Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").create_cloud_exadata_infrastructure method. boto3 documentation

# create_cloud_exadata_infrastructure method definition

def create_cloud_exadata_infrastructure(
    self,
    *,
    displayName: str,
    shape: str,
    computeCount: int,
    storageCount: int,
    availabilityZone: str = ...,
    availabilityZoneId: str = ...,
    tags: Mapping[str, str] = ...,
    customerContactsToSendToOCI: Sequence[CustomerContactTypeDef] = ...,  # (1)
    maintenanceWindow: MaintenanceWindowUnionTypeDef = ...,  # (2)
    clientToken: str = ...,
    databaseServerType: str = ...,
    storageServerType: str = ...,
) -> CreateCloudExadataInfrastructureOutputTypeDef:  # (3)
    ...
  1. See Sequence[CustomerContactTypeDef]
  2. See MaintenanceWindowUnionTypeDef
  3. See CreateCloudExadataInfrastructureOutputTypeDef
# create_cloud_exadata_infrastructure method usage example with argument unpacking

kwargs: CreateCloudExadataInfrastructureInputTypeDef = {  # (1)
    "displayName": ...,
    "shape": ...,
    "computeCount": ...,
    "storageCount": ...,
}

parent.create_cloud_exadata_infrastructure(**kwargs)
  1. See CreateCloudExadataInfrastructureInputTypeDef

create_cloud_vm_cluster#

Creates a VM cluster on the specified Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").create_cloud_vm_cluster method. boto3 documentation

# create_cloud_vm_cluster method definition

def create_cloud_vm_cluster(
    self,
    *,
    cloudExadataInfrastructureId: str,
    cpuCoreCount: int,
    displayName: str,
    giVersion: str,
    hostname: str,
    sshPublicKeys: Sequence[str],
    odbNetworkId: str,
    clusterName: str = ...,
    dataCollectionOptions: DataCollectionOptionsTypeDef = ...,  # (1)
    dataStorageSizeInTBs: float = ...,
    dbNodeStorageSizeInGBs: int = ...,
    dbServers: Sequence[str] = ...,
    tags: Mapping[str, str] = ...,
    isLocalBackupEnabled: bool = ...,
    isSparseDiskgroupEnabled: bool = ...,
    licenseModel: LicenseModelType = ...,  # (2)
    memorySizeInGBs: int = ...,
    systemVersion: str = ...,
    timeZone: str = ...,
    clientToken: str = ...,
    scanListenerPortTcp: int = ...,
) -> CreateCloudVmClusterOutputTypeDef:  # (3)
    ...
  1. See DataCollectionOptionsTypeDef
  2. See LicenseModelType
  3. See CreateCloudVmClusterOutputTypeDef
# create_cloud_vm_cluster method usage example with argument unpacking

kwargs: CreateCloudVmClusterInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
    "cpuCoreCount": ...,
    "displayName": ...,
    "giVersion": ...,
    "hostname": ...,
    "sshPublicKeys": ...,
    "odbNetworkId": ...,
}

parent.create_cloud_vm_cluster(**kwargs)
  1. See CreateCloudVmClusterInputTypeDef

create_odb_network#

Creates an ODB network.

Type annotations and code completion for boto3.client("odb").create_odb_network method. boto3 documentation

# create_odb_network method definition

def create_odb_network(
    self,
    *,
    displayName: str,
    clientSubnetCidr: str,
    availabilityZone: str = ...,
    availabilityZoneId: str = ...,
    backupSubnetCidr: str = ...,
    customDomainName: str = ...,
    defaultDnsPrefix: str = ...,
    clientToken: str = ...,
    s3Access: AccessType = ...,  # (1)
    zeroEtlAccess: AccessType = ...,  # (1)
    stsAccess: AccessType = ...,  # (1)
    kmsAccess: AccessType = ...,  # (1)
    s3PolicyDocument: str = ...,
    stsPolicyDocument: str = ...,
    kmsPolicyDocument: str = ...,
    crossRegionS3RestoreSourcesToEnable: Sequence[str] = ...,
    tags: Mapping[str, str] = ...,
) -> CreateOdbNetworkOutputTypeDef:  # (5)
    ...
  1. See AccessType
  2. See AccessType
  3. See AccessType
  4. See AccessType
  5. See CreateOdbNetworkOutputTypeDef
# create_odb_network method usage example with argument unpacking

kwargs: CreateOdbNetworkInputTypeDef = {  # (1)
    "displayName": ...,
    "clientSubnetCidr": ...,
}

parent.create_odb_network(**kwargs)
  1. See CreateOdbNetworkInputTypeDef

create_odb_peering_connection#

Creates a peering connection between an ODB network and a VPC.

Type annotations and code completion for boto3.client("odb").create_odb_peering_connection method. boto3 documentation

# create_odb_peering_connection method definition

def create_odb_peering_connection(
    self,
    *,
    odbNetworkId: str,
    peerNetworkId: str,
    displayName: str = ...,
    peerNetworkCidrsToBeAdded: Sequence[str] = ...,
    peerNetworkRouteTableIds: Sequence[str] = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateOdbPeeringConnectionOutputTypeDef:  # (1)
    ...
  1. See CreateOdbPeeringConnectionOutputTypeDef
# create_odb_peering_connection method usage example with argument unpacking

kwargs: CreateOdbPeeringConnectionInputTypeDef = {  # (1)
    "odbNetworkId": ...,
    "peerNetworkId": ...,
}

parent.create_odb_peering_connection(**kwargs)
  1. See CreateOdbPeeringConnectionInputTypeDef

delete_autonomous_database#

Deletes the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").delete_autonomous_database method. boto3 documentation

# delete_autonomous_database method definition

def delete_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
) -> dict[str, Any]:
    ...
# delete_autonomous_database method usage example with argument unpacking

kwargs: DeleteAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.delete_autonomous_database(**kwargs)
  1. See DeleteAutonomousDatabaseInputTypeDef

delete_autonomous_database_backup#

Deletes the specified Autonomous Database backup.

Type annotations and code completion for boto3.client("odb").delete_autonomous_database_backup method. boto3 documentation

# delete_autonomous_database_backup method definition

def delete_autonomous_database_backup(
    self,
    *,
    autonomousDatabaseBackupId: str,
) -> dict[str, Any]:
    ...
# delete_autonomous_database_backup method usage example with argument unpacking

kwargs: DeleteAutonomousDatabaseBackupInputTypeDef = {  # (1)
    "autonomousDatabaseBackupId": ...,
}

parent.delete_autonomous_database_backup(**kwargs)
  1. See DeleteAutonomousDatabaseBackupInputTypeDef

delete_cloud_autonomous_vm_cluster#

Deletes an Autonomous VM cluster.

Type annotations and code completion for boto3.client("odb").delete_cloud_autonomous_vm_cluster method. boto3 documentation

# delete_cloud_autonomous_vm_cluster method definition

def delete_cloud_autonomous_vm_cluster(
    self,
    *,
    cloudAutonomousVmClusterId: str,
) -> dict[str, Any]:
    ...
# delete_cloud_autonomous_vm_cluster method usage example with argument unpacking

kwargs: DeleteCloudAutonomousVmClusterInputTypeDef = {  # (1)
    "cloudAutonomousVmClusterId": ...,
}

parent.delete_cloud_autonomous_vm_cluster(**kwargs)
  1. See DeleteCloudAutonomousVmClusterInputTypeDef

delete_cloud_exadata_infrastructure#

Deletes the specified Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").delete_cloud_exadata_infrastructure method. boto3 documentation

# delete_cloud_exadata_infrastructure method definition

def delete_cloud_exadata_infrastructure(
    self,
    *,
    cloudExadataInfrastructureId: str,
) -> dict[str, Any]:
    ...
# delete_cloud_exadata_infrastructure method usage example with argument unpacking

kwargs: DeleteCloudExadataInfrastructureInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
}

parent.delete_cloud_exadata_infrastructure(**kwargs)
  1. See DeleteCloudExadataInfrastructureInputTypeDef

delete_cloud_vm_cluster#

Deletes the specified VM cluster.

Type annotations and code completion for boto3.client("odb").delete_cloud_vm_cluster method. boto3 documentation

# delete_cloud_vm_cluster method definition

def delete_cloud_vm_cluster(
    self,
    *,
    cloudVmClusterId: str,
) -> dict[str, Any]:
    ...
# delete_cloud_vm_cluster method usage example with argument unpacking

kwargs: DeleteCloudVmClusterInputTypeDef = {  # (1)
    "cloudVmClusterId": ...,
}

parent.delete_cloud_vm_cluster(**kwargs)
  1. See DeleteCloudVmClusterInputTypeDef

delete_odb_network#

Deletes the specified ODB network.

Type annotations and code completion for boto3.client("odb").delete_odb_network method. boto3 documentation

# delete_odb_network method definition

def delete_odb_network(
    self,
    *,
    odbNetworkId: str,
    deleteAssociatedResources: bool,
) -> dict[str, Any]:
    ...
# delete_odb_network method usage example with argument unpacking

kwargs: DeleteOdbNetworkInputTypeDef = {  # (1)
    "odbNetworkId": ...,
    "deleteAssociatedResources": ...,
}

parent.delete_odb_network(**kwargs)
  1. See DeleteOdbNetworkInputTypeDef

delete_odb_peering_connection#

Deletes an ODB peering connection.

Type annotations and code completion for boto3.client("odb").delete_odb_peering_connection method. boto3 documentation

# delete_odb_peering_connection method definition

def delete_odb_peering_connection(
    self,
    *,
    odbPeeringConnectionId: str,
) -> dict[str, Any]:
    ...
# delete_odb_peering_connection method usage example with argument unpacking

kwargs: DeleteOdbPeeringConnectionInputTypeDef = {  # (1)
    "odbPeeringConnectionId": ...,
}

parent.delete_odb_peering_connection(**kwargs)
  1. See DeleteOdbPeeringConnectionInputTypeDef

disassociate_iam_role_from_resource#

Disassociates an Amazon Web Services Identity and Access Management (IAM) service role from a specified resource to disable Amazon Web Services service integration.

Type annotations and code completion for boto3.client("odb").disassociate_iam_role_from_resource method. boto3 documentation

# disassociate_iam_role_from_resource method definition

def disassociate_iam_role_from_resource(
    self,
    *,
    iamRoleArn: str,
    awsIntegration: SupportedAwsIntegrationType,  # (1)
    resourceArn: str,
) -> dict[str, Any]:
    ...
  1. See SupportedAwsIntegrationType
# disassociate_iam_role_from_resource method usage example with argument unpacking

kwargs: DisassociateIamRoleFromResourceInputTypeDef = {  # (1)
    "iamRoleArn": ...,
    "awsIntegration": ...,
    "resourceArn": ...,
}

parent.disassociate_iam_role_from_resource(**kwargs)
  1. See DisassociateIamRoleFromResourceInputTypeDef

failover_autonomous_database#

Initiates a failover of the specified Autonomous Database to a standby peer database.

Type annotations and code completion for boto3.client("odb").failover_autonomous_database method. boto3 documentation

# failover_autonomous_database method definition

def failover_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
    peerDbArn: str = ...,
) -> FailoverAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See FailoverAutonomousDatabaseOutputTypeDef
# failover_autonomous_database method usage example with argument unpacking

kwargs: FailoverAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.failover_autonomous_database(**kwargs)
  1. See FailoverAutonomousDatabaseInputTypeDef

get_autonomous_database#

Gets information about a specific Autonomous Database.

Type annotations and code completion for boto3.client("odb").get_autonomous_database method. boto3 documentation

# get_autonomous_database method definition

def get_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
) -> GetAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See GetAutonomousDatabaseOutputTypeDef
# get_autonomous_database method usage example with argument unpacking

kwargs: GetAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.get_autonomous_database(**kwargs)
  1. See GetAutonomousDatabaseInputTypeDef

get_autonomous_database_backup#

Gets information about a specific Autonomous Database backup.

Type annotations and code completion for boto3.client("odb").get_autonomous_database_backup method. boto3 documentation

# get_autonomous_database_backup method definition

def get_autonomous_database_backup(
    self,
    *,
    autonomousDatabaseBackupId: str,
) -> GetAutonomousDatabaseBackupOutputTypeDef:  # (1)
    ...
  1. See GetAutonomousDatabaseBackupOutputTypeDef
# get_autonomous_database_backup method usage example with argument unpacking

kwargs: GetAutonomousDatabaseBackupInputTypeDef = {  # (1)
    "autonomousDatabaseBackupId": ...,
}

parent.get_autonomous_database_backup(**kwargs)
  1. See GetAutonomousDatabaseBackupInputTypeDef

get_autonomous_database_wallet_details#

Gets the wallet details for the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").get_autonomous_database_wallet_details method. boto3 documentation

# get_autonomous_database_wallet_details method definition

def get_autonomous_database_wallet_details(
    self,
    *,
    autonomousDatabaseId: str,
) -> GetAutonomousDatabaseWalletDetailsOutputTypeDef:  # (1)
    ...
  1. See GetAutonomousDatabaseWalletDetailsOutputTypeDef
# get_autonomous_database_wallet_details method usage example with argument unpacking

kwargs: GetAutonomousDatabaseWalletDetailsInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.get_autonomous_database_wallet_details(**kwargs)
  1. See GetAutonomousDatabaseWalletDetailsInputTypeDef

get_cloud_autonomous_vm_cluster#

Gets information about a specific Autonomous VM cluster.

Type annotations and code completion for boto3.client("odb").get_cloud_autonomous_vm_cluster method. boto3 documentation

# get_cloud_autonomous_vm_cluster method definition

def get_cloud_autonomous_vm_cluster(
    self,
    *,
    cloudAutonomousVmClusterId: str,
) -> GetCloudAutonomousVmClusterOutputTypeDef:  # (1)
    ...
  1. See GetCloudAutonomousVmClusterOutputTypeDef
# get_cloud_autonomous_vm_cluster method usage example with argument unpacking

kwargs: GetCloudAutonomousVmClusterInputTypeDef = {  # (1)
    "cloudAutonomousVmClusterId": ...,
}

parent.get_cloud_autonomous_vm_cluster(**kwargs)
  1. See GetCloudAutonomousVmClusterInputTypeDef

get_cloud_exadata_infrastructure#

Returns information about the specified Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").get_cloud_exadata_infrastructure method. boto3 documentation

# get_cloud_exadata_infrastructure method definition

def get_cloud_exadata_infrastructure(
    self,
    *,
    cloudExadataInfrastructureId: str,
) -> GetCloudExadataInfrastructureOutputTypeDef:  # (1)
    ...
  1. See GetCloudExadataInfrastructureOutputTypeDef
# get_cloud_exadata_infrastructure method usage example with argument unpacking

kwargs: GetCloudExadataInfrastructureInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
}

parent.get_cloud_exadata_infrastructure(**kwargs)
  1. See GetCloudExadataInfrastructureInputTypeDef

get_cloud_exadata_infrastructure_unallocated_resources#

Retrieves information about unallocated resources in a specified Cloud Exadata Infrastructure.

Type annotations and code completion for boto3.client("odb").get_cloud_exadata_infrastructure_unallocated_resources method. boto3 documentation

# get_cloud_exadata_infrastructure_unallocated_resources method definition

def get_cloud_exadata_infrastructure_unallocated_resources(
    self,
    *,
    cloudExadataInfrastructureId: str,
    dbServers: Sequence[str] = ...,
) -> GetCloudExadataInfrastructureUnallocatedResourcesOutputTypeDef:  # (1)
    ...
  1. See GetCloudExadataInfrastructureUnallocatedResourcesOutputTypeDef
# get_cloud_exadata_infrastructure_unallocated_resources method usage example with argument unpacking

kwargs: GetCloudExadataInfrastructureUnallocatedResourcesInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
}

parent.get_cloud_exadata_infrastructure_unallocated_resources(**kwargs)
  1. See GetCloudExadataInfrastructureUnallocatedResourcesInputTypeDef

get_cloud_vm_cluster#

Returns information about the specified VM cluster.

Type annotations and code completion for boto3.client("odb").get_cloud_vm_cluster method. boto3 documentation

# get_cloud_vm_cluster method definition

def get_cloud_vm_cluster(
    self,
    *,
    cloudVmClusterId: str,
) -> GetCloudVmClusterOutputTypeDef:  # (1)
    ...
  1. See GetCloudVmClusterOutputTypeDef
# get_cloud_vm_cluster method usage example with argument unpacking

kwargs: GetCloudVmClusterInputTypeDef = {  # (1)
    "cloudVmClusterId": ...,
}

parent.get_cloud_vm_cluster(**kwargs)
  1. See GetCloudVmClusterInputTypeDef

get_db_node#

Returns information about the specified DB node.

Type annotations and code completion for boto3.client("odb").get_db_node method. boto3 documentation

# get_db_node method definition

def get_db_node(
    self,
    *,
    cloudVmClusterId: str,
    dbNodeId: str,
) -> GetDbNodeOutputTypeDef:  # (1)
    ...
  1. See GetDbNodeOutputTypeDef
# get_db_node method usage example with argument unpacking

kwargs: GetDbNodeInputTypeDef = {  # (1)
    "cloudVmClusterId": ...,
    "dbNodeId": ...,
}

parent.get_db_node(**kwargs)
  1. See GetDbNodeInputTypeDef

get_db_server#

Returns information about the specified database server.

Type annotations and code completion for boto3.client("odb").get_db_server method. boto3 documentation

# get_db_server method definition

def get_db_server(
    self,
    *,
    cloudExadataInfrastructureId: str,
    dbServerId: str,
) -> GetDbServerOutputTypeDef:  # (1)
    ...
  1. See GetDbServerOutputTypeDef
# get_db_server method usage example with argument unpacking

kwargs: GetDbServerInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
    "dbServerId": ...,
}

parent.get_db_server(**kwargs)
  1. See GetDbServerInputTypeDef

get_oci_onboarding_status#

Returns the tenancy activation link and onboarding status for your Amazon Web Services account.

Type annotations and code completion for boto3.client("odb").get_oci_onboarding_status method. boto3 documentation

# get_oci_onboarding_status method definition

def get_oci_onboarding_status(
    self,
) -> GetOciOnboardingStatusOutputTypeDef:  # (1)
    ...
  1. See GetOciOnboardingStatusOutputTypeDef

get_odb_network#

Returns information about the specified ODB network.

Type annotations and code completion for boto3.client("odb").get_odb_network method. boto3 documentation

# get_odb_network method definition

def get_odb_network(
    self,
    *,
    odbNetworkId: str,
) -> GetOdbNetworkOutputTypeDef:  # (1)
    ...
  1. See GetOdbNetworkOutputTypeDef
# get_odb_network method usage example with argument unpacking

kwargs: GetOdbNetworkInputTypeDef = {  # (1)
    "odbNetworkId": ...,
}

parent.get_odb_network(**kwargs)
  1. See GetOdbNetworkInputTypeDef

get_odb_peering_connection#

Retrieves information about an ODB peering connection.

Type annotations and code completion for boto3.client("odb").get_odb_peering_connection method. boto3 documentation

# get_odb_peering_connection method definition

def get_odb_peering_connection(
    self,
    *,
    odbPeeringConnectionId: str,
) -> GetOdbPeeringConnectionOutputTypeDef:  # (1)
    ...
  1. See GetOdbPeeringConnectionOutputTypeDef
# get_odb_peering_connection method usage example with argument unpacking

kwargs: GetOdbPeeringConnectionInputTypeDef = {  # (1)
    "odbPeeringConnectionId": ...,
}

parent.get_odb_peering_connection(**kwargs)
  1. See GetOdbPeeringConnectionInputTypeDef

initialize_service#

Initializes the ODB service for the first time in an account.

Type annotations and code completion for boto3.client("odb").initialize_service method. boto3 documentation

# initialize_service method definition

def initialize_service(
    self,
    *,
    ociIdentityDomain: bool = ...,
    autonomousDatabaseOciAwsSecretsManagerIntegration: AccessType = ...,  # (1)
) -> dict[str, Any]:
    ...
  1. See AccessType
# initialize_service method usage example with argument unpacking

kwargs: InitializeServiceInputTypeDef = {  # (1)
    "ociIdentityDomain": ...,
}

parent.initialize_service(**kwargs)
  1. See InitializeServiceInputTypeDef

list_autonomous_database_backups#

Lists the backups of the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").list_autonomous_database_backups method. boto3 documentation

# list_autonomous_database_backups method definition

def list_autonomous_database_backups(
    self,
    *,
    autonomousDatabaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    status: AutonomousDatabaseBackupStatusType = ...,  # (1)
    type: AutonomousDatabaseBackupTypeType = ...,  # (2)
) -> ListAutonomousDatabaseBackupsOutputTypeDef:  # (3)
    ...
  1. See AutonomousDatabaseBackupStatusType
  2. See AutonomousDatabaseBackupTypeType
  3. See ListAutonomousDatabaseBackupsOutputTypeDef
# list_autonomous_database_backups method usage example with argument unpacking

kwargs: ListAutonomousDatabaseBackupsInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.list_autonomous_database_backups(**kwargs)
  1. See ListAutonomousDatabaseBackupsInputTypeDef

list_autonomous_database_character_sets#

Lists the available character sets for Autonomous Databases.

Type annotations and code completion for boto3.client("odb").list_autonomous_database_character_sets method. boto3 documentation

# list_autonomous_database_character_sets method definition

def list_autonomous_database_character_sets(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    characterSetType: CharacterSetTypeType = ...,  # (1)
) -> ListAutonomousDatabaseCharacterSetsOutputTypeDef:  # (2)
    ...
  1. See CharacterSetTypeType
  2. See ListAutonomousDatabaseCharacterSetsOutputTypeDef
# list_autonomous_database_character_sets method usage example with argument unpacking

kwargs: ListAutonomousDatabaseCharacterSetsInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_autonomous_database_character_sets(**kwargs)
  1. See ListAutonomousDatabaseCharacterSetsInputTypeDef

list_autonomous_database_clones#

Lists the clones of the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").list_autonomous_database_clones method. boto3 documentation

# list_autonomous_database_clones method definition

def list_autonomous_database_clones(
    self,
    *,
    autonomousDatabaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAutonomousDatabaseClonesOutputTypeDef:  # (1)
    ...
  1. See ListAutonomousDatabaseClonesOutputTypeDef
# list_autonomous_database_clones method usage example with argument unpacking

kwargs: ListAutonomousDatabaseClonesInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.list_autonomous_database_clones(**kwargs)
  1. See ListAutonomousDatabaseClonesInputTypeDef

list_autonomous_database_peers#

Lists the peer databases of the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").list_autonomous_database_peers method. boto3 documentation

# list_autonomous_database_peers method definition

def list_autonomous_database_peers(
    self,
    *,
    autonomousDatabaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAutonomousDatabasePeersOutputTypeDef:  # (1)
    ...
  1. See ListAutonomousDatabasePeersOutputTypeDef
# list_autonomous_database_peers method usage example with argument unpacking

kwargs: ListAutonomousDatabasePeersInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.list_autonomous_database_peers(**kwargs)
  1. See ListAutonomousDatabasePeersInputTypeDef

list_autonomous_database_versions#

Lists the available Oracle Database software versions for Autonomous Databases.

Type annotations and code completion for boto3.client("odb").list_autonomous_database_versions method. boto3 documentation

# list_autonomous_database_versions method definition

def list_autonomous_database_versions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    dbWorkload: DbWorkloadType = ...,  # (1)
) -> ListAutonomousDatabaseVersionsOutputTypeDef:  # (2)
    ...
  1. See DbWorkloadType
  2. See ListAutonomousDatabaseVersionsOutputTypeDef
# list_autonomous_database_versions method usage example with argument unpacking

kwargs: ListAutonomousDatabaseVersionsInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_autonomous_database_versions(**kwargs)
  1. See ListAutonomousDatabaseVersionsInputTypeDef

list_autonomous_databases#

Returns information about the Autonomous Databases owned by your Amazon Web Services account in the current Amazon Web Services Region.

Type annotations and code completion for boto3.client("odb").list_autonomous_databases method. boto3 documentation

# list_autonomous_databases method definition

def list_autonomous_databases(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAutonomousDatabasesOutputTypeDef:  # (1)
    ...
  1. See ListAutonomousDatabasesOutputTypeDef
# list_autonomous_databases method usage example with argument unpacking

kwargs: ListAutonomousDatabasesInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_autonomous_databases(**kwargs)
  1. See ListAutonomousDatabasesInputTypeDef

list_autonomous_virtual_machines#

Lists all Autonomous VMs in an Autonomous VM cluster.

Type annotations and code completion for boto3.client("odb").list_autonomous_virtual_machines method. boto3 documentation

# list_autonomous_virtual_machines method definition

def list_autonomous_virtual_machines(
    self,
    *,
    cloudAutonomousVmClusterId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAutonomousVirtualMachinesOutputTypeDef:  # (1)
    ...
  1. See ListAutonomousVirtualMachinesOutputTypeDef
# list_autonomous_virtual_machines method usage example with argument unpacking

kwargs: ListAutonomousVirtualMachinesInputTypeDef = {  # (1)
    "cloudAutonomousVmClusterId": ...,
}

parent.list_autonomous_virtual_machines(**kwargs)
  1. See ListAutonomousVirtualMachinesInputTypeDef

list_cloud_autonomous_vm_clusters#

Lists all Autonomous VM clusters in a specified Cloud Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").list_cloud_autonomous_vm_clusters method. boto3 documentation

# list_cloud_autonomous_vm_clusters method definition

def list_cloud_autonomous_vm_clusters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    cloudExadataInfrastructureId: str = ...,
) -> ListCloudAutonomousVmClustersOutputTypeDef:  # (1)
    ...
  1. See ListCloudAutonomousVmClustersOutputTypeDef
# list_cloud_autonomous_vm_clusters method usage example with argument unpacking

kwargs: ListCloudAutonomousVmClustersInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_cloud_autonomous_vm_clusters(**kwargs)
  1. See ListCloudAutonomousVmClustersInputTypeDef

list_cloud_exadata_infrastructures#

Returns information about the Exadata infrastructures owned by your Amazon Web Services account.

Type annotations and code completion for boto3.client("odb").list_cloud_exadata_infrastructures method. boto3 documentation

# list_cloud_exadata_infrastructures method definition

def list_cloud_exadata_infrastructures(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCloudExadataInfrastructuresOutputTypeDef:  # (1)
    ...
  1. See ListCloudExadataInfrastructuresOutputTypeDef
# list_cloud_exadata_infrastructures method usage example with argument unpacking

kwargs: ListCloudExadataInfrastructuresInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_cloud_exadata_infrastructures(**kwargs)
  1. See ListCloudExadataInfrastructuresInputTypeDef

list_cloud_vm_clusters#

Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").list_cloud_vm_clusters method. boto3 documentation

# list_cloud_vm_clusters method definition

def list_cloud_vm_clusters(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    cloudExadataInfrastructureId: str = ...,
) -> ListCloudVmClustersOutputTypeDef:  # (1)
    ...
  1. See ListCloudVmClustersOutputTypeDef
# list_cloud_vm_clusters method usage example with argument unpacking

kwargs: ListCloudVmClustersInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_cloud_vm_clusters(**kwargs)
  1. See ListCloudVmClustersInputTypeDef

list_db_nodes#

Returns information about the DB nodes for the specified VM cluster.

Type annotations and code completion for boto3.client("odb").list_db_nodes method. boto3 documentation

# list_db_nodes method definition

def list_db_nodes(
    self,
    *,
    cloudVmClusterId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDbNodesOutputTypeDef:  # (1)
    ...
  1. See ListDbNodesOutputTypeDef
# list_db_nodes method usage example with argument unpacking

kwargs: ListDbNodesInputTypeDef = {  # (1)
    "cloudVmClusterId": ...,
}

parent.list_db_nodes(**kwargs)
  1. See ListDbNodesInputTypeDef

list_db_servers#

Returns information about the database servers that belong to the specified Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").list_db_servers method. boto3 documentation

# list_db_servers method definition

def list_db_servers(
    self,
    *,
    cloudExadataInfrastructureId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListDbServersOutputTypeDef:  # (1)
    ...
  1. See ListDbServersOutputTypeDef
# list_db_servers method usage example with argument unpacking

kwargs: ListDbServersInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
}

parent.list_db_servers(**kwargs)
  1. See ListDbServersInputTypeDef

list_db_system_shapes#

Returns information about the shapes that are available for an Exadata infrastructure.

Type annotations and code completion for boto3.client("odb").list_db_system_shapes method. boto3 documentation

# list_db_system_shapes method definition

def list_db_system_shapes(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    availabilityZone: str = ...,
    availabilityZoneId: str = ...,
) -> ListDbSystemShapesOutputTypeDef:  # (1)
    ...
  1. See ListDbSystemShapesOutputTypeDef
# list_db_system_shapes method usage example with argument unpacking

kwargs: ListDbSystemShapesInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_db_system_shapes(**kwargs)
  1. See ListDbSystemShapesInputTypeDef

list_gi_versions#

Returns information about Oracle Grid Infrastructure (GI) software versions that are available for a VM cluster for the specified shape.

Type annotations and code completion for boto3.client("odb").list_gi_versions method. boto3 documentation

# list_gi_versions method definition

def list_gi_versions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    shape: str = ...,
) -> ListGiVersionsOutputTypeDef:  # (1)
    ...
  1. See ListGiVersionsOutputTypeDef
# list_gi_versions method usage example with argument unpacking

kwargs: ListGiVersionsInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_gi_versions(**kwargs)
  1. See ListGiVersionsInputTypeDef

list_odb_networks#

Returns information about the ODB networks owned by your Amazon Web Services account.

Type annotations and code completion for boto3.client("odb").list_odb_networks method. boto3 documentation

# list_odb_networks method definition

def list_odb_networks(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListOdbNetworksOutputTypeDef:  # (1)
    ...
  1. See ListOdbNetworksOutputTypeDef
# list_odb_networks method usage example with argument unpacking

kwargs: ListOdbNetworksInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_odb_networks(**kwargs)
  1. See ListOdbNetworksInputTypeDef

list_odb_peering_connections#

Lists all ODB peering connections or those associated with a specific ODB network.

Type annotations and code completion for boto3.client("odb").list_odb_peering_connections method. boto3 documentation

# list_odb_peering_connections method definition

def list_odb_peering_connections(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    odbNetworkId: str = ...,
) -> ListOdbPeeringConnectionsOutputTypeDef:  # (1)
    ...
  1. See ListOdbPeeringConnectionsOutputTypeDef
# list_odb_peering_connections method usage example with argument unpacking

kwargs: ListOdbPeeringConnectionsInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_odb_peering_connections(**kwargs)
  1. See ListOdbPeeringConnectionsInputTypeDef

list_system_versions#

Returns information about the system versions that are available for a VM cluster for the specified giVersion and shape.

Type annotations and code completion for boto3.client("odb").list_system_versions method. boto3 documentation

# list_system_versions method definition

def list_system_versions(
    self,
    *,
    giVersion: str,
    shape: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSystemVersionsOutputTypeDef:  # (1)
    ...
  1. See ListSystemVersionsOutputTypeDef
# list_system_versions method usage example with argument unpacking

kwargs: ListSystemVersionsInputTypeDef = {  # (1)
    "giVersion": ...,
    "shape": ...,
}

parent.list_system_versions(**kwargs)
  1. See ListSystemVersionsInputTypeDef

list_tags_for_resource#

Returns information about the tags applied to this resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

reboot_autonomous_database#

Reboots the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").reboot_autonomous_database method. boto3 documentation

# reboot_autonomous_database method definition

def reboot_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
    isOnlineReboot: bool = ...,
) -> RebootAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See RebootAutonomousDatabaseOutputTypeDef
# reboot_autonomous_database method usage example with argument unpacking

kwargs: RebootAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.reboot_autonomous_database(**kwargs)
  1. See RebootAutonomousDatabaseInputTypeDef

reboot_db_node#

Reboots the specified DB node in a VM cluster.

Type annotations and code completion for boto3.client("odb").reboot_db_node method. boto3 documentation

# reboot_db_node method definition

def reboot_db_node(
    self,
    *,
    cloudVmClusterId: str,
    dbNodeId: str,
) -> RebootDbNodeOutputTypeDef:  # (1)
    ...
  1. See RebootDbNodeOutputTypeDef
# reboot_db_node method usage example with argument unpacking

kwargs: RebootDbNodeInputTypeDef = {  # (1)
    "cloudVmClusterId": ...,
    "dbNodeId": ...,
}

parent.reboot_db_node(**kwargs)
  1. See RebootDbNodeInputTypeDef

restore_autonomous_database#

Restores the specified Autonomous Database to a point in time.

Type annotations and code completion for boto3.client("odb").restore_autonomous_database method. boto3 documentation

# restore_autonomous_database method definition

def restore_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
    timestamp: TimestampTypeDef,
) -> RestoreAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See RestoreAutonomousDatabaseOutputTypeDef
# restore_autonomous_database method usage example with argument unpacking

kwargs: RestoreAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
    "timestamp": ...,
}

parent.restore_autonomous_database(**kwargs)
  1. See RestoreAutonomousDatabaseInputTypeDef

shrink_autonomous_database#

Shrinks the storage of the specified Autonomous Database to reclaim unused space.

Type annotations and code completion for boto3.client("odb").shrink_autonomous_database method. boto3 documentation

# shrink_autonomous_database method definition

def shrink_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
) -> ShrinkAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See ShrinkAutonomousDatabaseOutputTypeDef
# shrink_autonomous_database method usage example with argument unpacking

kwargs: ShrinkAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.shrink_autonomous_database(**kwargs)
  1. See ShrinkAutonomousDatabaseInputTypeDef

start_autonomous_database#

Starts the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").start_autonomous_database method. boto3 documentation

# start_autonomous_database method definition

def start_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
) -> StartAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See StartAutonomousDatabaseOutputTypeDef
# start_autonomous_database method usage example with argument unpacking

kwargs: StartAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.start_autonomous_database(**kwargs)
  1. See StartAutonomousDatabaseInputTypeDef

start_db_node#

Starts the specified DB node in a VM cluster.

Type annotations and code completion for boto3.client("odb").start_db_node method. boto3 documentation

# start_db_node method definition

def start_db_node(
    self,
    *,
    cloudVmClusterId: str,
    dbNodeId: str,
) -> StartDbNodeOutputTypeDef:  # (1)
    ...
  1. See StartDbNodeOutputTypeDef
# start_db_node method usage example with argument unpacking

kwargs: StartDbNodeInputTypeDef = {  # (1)
    "cloudVmClusterId": ...,
    "dbNodeId": ...,
}

parent.start_db_node(**kwargs)
  1. See StartDbNodeInputTypeDef

stop_autonomous_database#

Stops the specified Autonomous Database.

Type annotations and code completion for boto3.client("odb").stop_autonomous_database method. boto3 documentation

# stop_autonomous_database method definition

def stop_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
) -> StopAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See StopAutonomousDatabaseOutputTypeDef
# stop_autonomous_database method usage example with argument unpacking

kwargs: StopAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.stop_autonomous_database(**kwargs)
  1. See StopAutonomousDatabaseInputTypeDef

stop_db_node#

Stops the specified DB node in a VM cluster.

Type annotations and code completion for boto3.client("odb").stop_db_node method. boto3 documentation

# stop_db_node method definition

def stop_db_node(
    self,
    *,
    cloudVmClusterId: str,
    dbNodeId: str,
) -> StopDbNodeOutputTypeDef:  # (1)
    ...
  1. See StopDbNodeOutputTypeDef
# stop_db_node method usage example with argument unpacking

kwargs: StopDbNodeInputTypeDef = {  # (1)
    "cloudVmClusterId": ...,
    "dbNodeId": ...,
}

parent.stop_db_node(**kwargs)
  1. See StopDbNodeInputTypeDef

switchover_autonomous_database#

Performs a switchover of the specified Autonomous Database to a standby peer database.

Type annotations and code completion for boto3.client("odb").switchover_autonomous_database method. boto3 documentation

# switchover_autonomous_database method definition

def switchover_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
    peerDbArn: str = ...,
) -> SwitchoverAutonomousDatabaseOutputTypeDef:  # (1)
    ...
  1. See SwitchoverAutonomousDatabaseOutputTypeDef
# switchover_autonomous_database method usage example with argument unpacking

kwargs: SwitchoverAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.switchover_autonomous_database(**kwargs)
  1. See SwitchoverAutonomousDatabaseInputTypeDef

tag_resource#

Applies tags to the specified resource.

Type annotations and code completion for boto3.client("odb").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes tags from the specified resource.

Type annotations and code completion for boto3.client("odb").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_autonomous_database#

Updates the properties of an Autonomous Database.

Type annotations and code completion for boto3.client("odb").update_autonomous_database method. boto3 documentation

# update_autonomous_database method definition

def update_autonomous_database(
    self,
    *,
    autonomousDatabaseId: str,
    adminPassword: str = ...,
    computeCount: float = ...,
    cpuCoreCount: int = ...,
    dataStorageSizeInTBs: int = ...,
    dataStorageSizeInGBs: int = ...,
    displayName: str = ...,
    dbName: str = ...,
    dbVersion: str = ...,
    dbWorkload: DbWorkloadType = ...,  # (1)
    dbToolsDetails: Sequence[DatabaseToolTypeDef] = ...,  # (2)
    databaseEdition: DatabaseEditionType = ...,  # (3)
    licenseModel: LicenseModelType = ...,  # (4)
    isAutoScalingEnabled: bool = ...,
    isAutoScalingForStorageEnabled: bool = ...,
    isBackupRetentionLocked: bool = ...,
    isLocalDataGuardEnabled: bool = ...,
    isMtlsConnectionRequired: bool = ...,
    isRefreshableClone: bool = ...,
    isDisconnectPeer: bool = ...,
    backupRetentionPeriodInDays: int = ...,
    byolComputeCountLimit: float = ...,
    localAdgAutoFailoverMaxDataLossLimit: int = ...,
    autonomousMaintenanceScheduleType: AutonomousMaintenanceScheduleTypeType = ...,  # (5)
    customerContactsToSendToOCI: Sequence[CustomerContactTypeDef] = ...,  # (6)
    scheduledOperations: Sequence[ScheduledOperationDetailsTypeDef] = ...,  # (7)
    longTermBackupSchedule: LongTermBackupScheduleUnionTypeDef = ...,  # (8)
    openMode: OpenModeType = ...,  # (9)
    permissionLevel: PermissionLevelType = ...,  # (10)
    refreshableMode: RefreshableModeType = ...,  # (11)
    privateEndpointIp: str = ...,
    privateEndpointLabel: str = ...,
    peerDbId: str = ...,
    resourcePoolLeaderId: str = ...,
    resourcePoolSummary: ResourcePoolSummaryTypeDef = ...,  # (12)
    standbyAllowlistedIpsSource: StandbyAllowlistedIpsSourceType = ...,  # (13)
    standbyAllowlistedIps: Sequence[str] = ...,
    allowlistedIps: Sequence[str] = ...,
    autoRefreshFrequencyInSeconds: int = ...,
    autoRefreshPointLagInSeconds: int = ...,
    timeOfAutoRefreshStart: TimestampTypeDef = ...,
    encryptionKeyProvider: EncryptionKeyProviderInputType = ...,  # (14)
    encryptionKeyConfiguration: EncryptionKeyConfigurationInputTypeDef = ...,  # (15)
    adminPasswordSource: AdminPasswordSourceType = ...,  # (16)
    adminPasswordSourceConfiguration: AdminPasswordSourceConfigurationInputTypeDef = ...,  # (17)
) -> UpdateAutonomousDatabaseOutputTypeDef:  # (18)
    ...
  1. See DbWorkloadType
  2. See Sequence[DatabaseToolTypeDef]
  3. See DatabaseEditionType
  4. See LicenseModelType
  5. See AutonomousMaintenanceScheduleTypeType
  6. See Sequence[CustomerContactTypeDef]
  7. See Sequence[ScheduledOperationDetailsTypeDef]
  8. See LongTermBackupScheduleUnionTypeDef
  9. See OpenModeType
  10. See PermissionLevelType
  11. See RefreshableModeType
  12. See ResourcePoolSummaryTypeDef
  13. See StandbyAllowlistedIpsSourceType
  14. See EncryptionKeyProviderInputType
  15. See EncryptionKeyConfigurationInputTypeDef
  16. See AdminPasswordSourceType
  17. See AdminPasswordSourceConfigurationInputTypeDef
  18. See UpdateAutonomousDatabaseOutputTypeDef
# update_autonomous_database method usage example with argument unpacking

kwargs: UpdateAutonomousDatabaseInputTypeDef = {  # (1)
    "autonomousDatabaseId": ...,
}

parent.update_autonomous_database(**kwargs)
  1. See UpdateAutonomousDatabaseInputTypeDef

update_autonomous_database_backup#

Updates the properties of an Autonomous Database backup.

Type annotations and code completion for boto3.client("odb").update_autonomous_database_backup method. boto3 documentation

# update_autonomous_database_backup method definition

def update_autonomous_database_backup(
    self,
    *,
    autonomousDatabaseBackupId: str,
    retentionPeriodInDays: int = ...,
) -> UpdateAutonomousDatabaseBackupOutputTypeDef:  # (1)
    ...
  1. See UpdateAutonomousDatabaseBackupOutputTypeDef
# update_autonomous_database_backup method usage example with argument unpacking

kwargs: UpdateAutonomousDatabaseBackupInputTypeDef = {  # (1)
    "autonomousDatabaseBackupId": ...,
}

parent.update_autonomous_database_backup(**kwargs)
  1. See UpdateAutonomousDatabaseBackupInputTypeDef

update_cloud_exadata_infrastructure#

Updates the properties of an Exadata infrastructure resource.

Type annotations and code completion for boto3.client("odb").update_cloud_exadata_infrastructure method. boto3 documentation

# update_cloud_exadata_infrastructure method definition

def update_cloud_exadata_infrastructure(
    self,
    *,
    cloudExadataInfrastructureId: str,
    maintenanceWindow: MaintenanceWindowUnionTypeDef = ...,  # (1)
) -> UpdateCloudExadataInfrastructureOutputTypeDef:  # (2)
    ...
  1. See MaintenanceWindowUnionTypeDef
  2. See UpdateCloudExadataInfrastructureOutputTypeDef
# update_cloud_exadata_infrastructure method usage example with argument unpacking

kwargs: UpdateCloudExadataInfrastructureInputTypeDef = {  # (1)
    "cloudExadataInfrastructureId": ...,
}

parent.update_cloud_exadata_infrastructure(**kwargs)
  1. See UpdateCloudExadataInfrastructureInputTypeDef

update_odb_network#

Updates properties of a specified ODB network.

Type annotations and code completion for boto3.client("odb").update_odb_network method. boto3 documentation

# update_odb_network method definition

def update_odb_network(
    self,
    *,
    odbNetworkId: str,
    displayName: str = ...,
    peeredCidrsToBeAdded: Sequence[str] = ...,
    peeredCidrsToBeRemoved: Sequence[str] = ...,
    s3Access: AccessType = ...,  # (1)
    zeroEtlAccess: AccessType = ...,  # (1)
    stsAccess: AccessType = ...,  # (1)
    kmsAccess: AccessType = ...,  # (1)
    s3PolicyDocument: str = ...,
    stsPolicyDocument: str = ...,
    kmsPolicyDocument: str = ...,
    crossRegionS3RestoreSourcesToEnable: Sequence[str] = ...,
    crossRegionS3RestoreSourcesToDisable: Sequence[str] = ...,
) -> UpdateOdbNetworkOutputTypeDef:  # (5)
    ...
  1. See AccessType
  2. See AccessType
  3. See AccessType
  4. See AccessType
  5. See UpdateOdbNetworkOutputTypeDef
# update_odb_network method usage example with argument unpacking

kwargs: UpdateOdbNetworkInputTypeDef = {  # (1)
    "odbNetworkId": ...,
}

parent.update_odb_network(**kwargs)
  1. See UpdateOdbNetworkInputTypeDef

update_odb_peering_connection#

Modifies the settings of an Oracle Database@Amazon Web Services peering connection.

Type annotations and code completion for boto3.client("odb").update_odb_peering_connection method. boto3 documentation

# update_odb_peering_connection method definition

def update_odb_peering_connection(
    self,
    *,
    odbPeeringConnectionId: str,
    displayName: str = ...,
    peerNetworkCidrsToBeAdded: Sequence[str] = ...,
    peerNetworkCidrsToBeRemoved: Sequence[str] = ...,
) -> UpdateOdbPeeringConnectionOutputTypeDef:  # (1)
    ...
  1. See UpdateOdbPeeringConnectionOutputTypeDef
# update_odb_peering_connection method usage example with argument unpacking

kwargs: UpdateOdbPeeringConnectionInputTypeDef = {  # (1)
    "odbPeeringConnectionId": ...,
}

parent.update_odb_peering_connection(**kwargs)
  1. See UpdateOdbPeeringConnectionInputTypeDef

get_paginator#

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