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

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)
    s3PolicyDocument: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateOdbNetworkOutputTypeDef:  # (3)
    ...

1. See AccessType
2. See AccessType
3. 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 either another ODB network or a customer-owned 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 = ...,
    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_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

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,
) -> Dict[str, Any]:
    ...

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

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

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_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)
    s3PolicyDocument: str = ...,
) -> UpdateOdbNetworkOutputTypeDef:  # (3)
    ...

1. See AccessType
2. See AccessType
3. See UpdateOdbNetworkOutputTypeDef

# update_odb_network method usage example with argument unpacking

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

parent.update_odb_network(**kwargs)

1. See UpdateOdbNetworkInputTypeDef

get_paginator

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

• client.get_paginator("list_autonomous_virtual_machines") -> ListAutonomousVirtualMachinesPaginator
• client.get_paginator("list_cloud_autonomous_vm_clusters") -> ListCloudAutonomousVmClustersPaginator
• client.get_paginator("list_cloud_exadata_infrastructures") -> ListCloudExadataInfrastructuresPaginator
• client.get_paginator("list_cloud_vm_clusters") -> ListCloudVmClustersPaginator
• client.get_paginator("list_db_nodes") -> ListDbNodesPaginator
• client.get_paginator("list_db_servers") -> ListDbServersPaginator
• client.get_paginator("list_db_system_shapes") -> ListDbSystemShapesPaginator
• client.get_paginator("list_gi_versions") -> ListGiVersionsPaginator
• client.get_paginator("list_odb_networks") -> ListOdbNetworksPaginator
• client.get_paginator("list_odb_peering_connections") -> ListOdbPeeringConnectionsPaginator
• client.get_paginator("list_system_versions") -> ListSystemVersionsPaginator