OdbClient

interface OdbClient : SdkClient

Oracle Database@Amazon Web Services is an offering that enables you to access Oracle Exadata infrastructure managed by Oracle Cloud Infrastructure (OCI) inside Amazon Web Services data centers. You can migrate your Oracle Exadata workloads, establish low-latency connectivity with applications running on Amazon Web Services, and integrate with Amazon Web Services services. For example, you can run application servers in a virtual private cloud (VPC) and access an Oracle Exadata system running in Oracle Database@Amazon Web Services. You can get started with Oracle Database@Amazon Web Services by using the familiar Amazon Web Services Management Console, APIs, or CLI.

This interface reference for Oracle Database@Amazon Web Services contains documentation for a programming or command line interface that you can use to manage Oracle Database@Amazon Web Services. Oracle Database@Amazon Web Services is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. The reference structure is as follows.

In this preview release documentation, the links in the "See Also" sections do not work.

Oracle Database@Amazon Web Services API Reference

  • For the alphabetical list of API actions, see .

  • For the alphabetical list of data types, see .

  • For a list of common parameters, see CommonParameters.

  • For descriptions of the error codes, see CommonErrors.

Properties

Link copied to clipboard
abstract override val config: OdbClient.Config

OdbClient's configuration

Functions

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Creates a VM cluster on the specified Exadata infrastructure.

Link copied to clipboard

Creates an ODB network.

Link copied to clipboard

Creates a peering connection between an ODB network and either another ODB network or a customer-owned VPC.

Link copied to clipboard
Link copied to clipboard

Deletes the specified Exadata infrastructure. Before you use this operation, make sure to delete all of the VM clusters that are hosted on this Exadata infrastructure.

Link copied to clipboard

Deletes the specified VM cluster.

Link copied to clipboard

Deletes the specified ODB network.

Link copied to clipboard

Deletes an ODB peering connection.

Link copied to clipboard

Gets information about a specific Autonomous VM cluster.

Link copied to clipboard

Returns information about the specified Exadata infrastructure.

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

Link copied to clipboard

Returns information about the specified VM cluster.

Link copied to clipboard
abstract suspend fun getDbNode(input: GetDbNodeRequest): GetDbNodeResponse

Returns information about the specified DB node.

Link copied to clipboard
abstract suspend fun getDbServer(input: GetDbServerRequest): GetDbServerResponse

Returns information about the specified database server.

Link copied to clipboard
abstract suspend fun getOciOnboardingStatus(input: GetOciOnboardingStatusRequest = GetOciOnboardingStatusRequest { }): GetOciOnboardingStatusResponse

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

Link copied to clipboard

Returns information about the specified ODB network.

Link copied to clipboard

Retrieves information about an ODB peering connection.

Link copied to clipboard
abstract suspend fun initializeService(input: InitializeServiceRequest = InitializeServiceRequest { }): InitializeServiceResponse

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

Link copied to clipboard

Lists all Autonomous VMs in an Autonomous VM cluster.

Link copied to clipboard
abstract suspend fun listCloudAutonomousVmClusters(input: ListCloudAutonomousVmClustersRequest = ListCloudAutonomousVmClustersRequest { }): ListCloudAutonomousVmClustersResponse

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

Link copied to clipboard
abstract suspend fun listCloudExadataInfrastructures(input: ListCloudExadataInfrastructuresRequest = ListCloudExadataInfrastructuresRequest { }): ListCloudExadataInfrastructuresResponse

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

Link copied to clipboard
abstract suspend fun listCloudVmClusters(input: ListCloudVmClustersRequest = ListCloudVmClustersRequest { }): ListCloudVmClustersResponse

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

Link copied to clipboard
abstract suspend fun listDbNodes(input: ListDbNodesRequest): ListDbNodesResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listDbSystemShapes(input: ListDbSystemShapesRequest = ListDbSystemShapesRequest { }): ListDbSystemShapesResponse

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

Link copied to clipboard
abstract suspend fun listGiVersions(input: ListGiVersionsRequest = ListGiVersionsRequest { }): ListGiVersionsResponse

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

Link copied to clipboard
abstract suspend fun listOdbNetworks(input: ListOdbNetworksRequest = ListOdbNetworksRequest { }): ListOdbNetworksResponse

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

Link copied to clipboard
abstract suspend fun listOdbPeeringConnections(input: ListOdbPeeringConnectionsRequest = ListOdbPeeringConnectionsRequest { }): ListOdbPeeringConnectionsResponse

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about the tags applied to this resource.

Link copied to clipboard

Reboots the specified DB node in a VM cluster.

Link copied to clipboard
abstract suspend fun startDbNode(input: StartDbNodeRequest): StartDbNodeResponse

Starts the specified DB node in a VM cluster.

Link copied to clipboard
abstract suspend fun stopDbNode(input: StopDbNodeRequest): StopDbNodeResponse

Stops the specified DB node in a VM cluster.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Applies tags to the specified resource.

Link copied to clipboard

Removes tags from the specified resource.

Link copied to clipboard

Updates the properties of an Exadata infrastructure resource.

Link copied to clipboard

Updates properties of a specified ODB network.

Inherited functions

Link copied to clipboard

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

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Creates a VM cluster on the specified Exadata infrastructure.

Link copied to clipboard

Creates an ODB network.

Link copied to clipboard

Creates a peering connection between an ODB network and either another ODB network or a customer-owned VPC.

Link copied to clipboard
Link copied to clipboard

Deletes the specified Exadata infrastructure. Before you use this operation, make sure to delete all of the VM clusters that are hosted on this Exadata infrastructure.

Link copied to clipboard

Deletes the specified VM cluster.

Link copied to clipboard

Deletes the specified ODB network.

Link copied to clipboard

Deletes an ODB peering connection.

Link copied to clipboard

Gets information about a specific Autonomous VM cluster.

Link copied to clipboard

Returns information about the specified Exadata infrastructure.

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

Link copied to clipboard

Returns information about the specified VM cluster.

Link copied to clipboard
inline suspend fun OdbClient.getDbNode(crossinline block: GetDbNodeRequest.Builder.() -> Unit): GetDbNodeResponse

Returns information about the specified DB node.

Link copied to clipboard
inline suspend fun OdbClient.getDbServer(crossinline block: GetDbServerRequest.Builder.() -> Unit): GetDbServerResponse

Returns information about the specified database server.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun OdbClient.getOdbNetwork(crossinline block: GetOdbNetworkRequest.Builder.() -> Unit): GetOdbNetworkResponse

Returns information about the specified ODB network.

Link copied to clipboard

Retrieves information about an ODB peering connection.

Link copied to clipboard

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

Link copied to clipboard

Lists all Autonomous VMs in an Autonomous VM cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun OdbClient.listDbNodes(crossinline block: ListDbNodesRequest.Builder.() -> Unit): ListDbNodesResponse

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

Link copied to clipboard
inline suspend fun OdbClient.listDbServers(crossinline block: ListDbServersRequest.Builder.() -> Unit): ListDbServersResponse

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns information about the tags applied to this resource.

Link copied to clipboard
inline suspend fun OdbClient.rebootDbNode(crossinline block: RebootDbNodeRequest.Builder.() -> Unit): RebootDbNodeResponse

Reboots the specified DB node in a VM cluster.

Link copied to clipboard
inline suspend fun OdbClient.startDbNode(crossinline block: StartDbNodeRequest.Builder.() -> Unit): StartDbNodeResponse

Starts the specified DB node in a VM cluster.

Link copied to clipboard
inline suspend fun OdbClient.stopDbNode(crossinline block: StopDbNodeRequest.Builder.() -> Unit): StopDbNodeResponse

Stops the specified DB node in a VM cluster.

Link copied to clipboard
inline suspend fun OdbClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Applies tags to the specified resource.

Link copied to clipboard
inline suspend fun OdbClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from the specified resource.

Link copied to clipboard

Updates the properties of an Exadata infrastructure resource.

Link copied to clipboard

Updates properties of a specified ODB network.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.