View Source AWS.Odb (aws-elixir v1.0.7)

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

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.

Link to this section Summary

Functions

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

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

Creates a VM cluster on the specified Exadata infrastructure.

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

Deletes the specified Exadata infrastructure.

Deletes the specified VM cluster.

Deletes the specified ODB network.

Gets information about a specific Autonomous VM cluster.

Returns information about the specified Exadata infrastructure.

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

Returns information about the specified VM cluster.

Returns information about the specified DB node.

Returns information about the specified database server.

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

Returns information about the specified ODB network.

Retrieves information about an ODB peering connection.

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

Lists all Autonomous VMs in an Autonomous VM cluster.

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

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

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

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

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

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

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

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

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

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

Returns information about the tags applied to this resource.

Reboots the specified DB node in a VM cluster.

Starts the specified DB node in a VM cluster.

Stops the specified DB node in a VM cluster.

Applies tags to the specified resource.

Removes tags from the specified resource.

Updates the properties of an Exadata infrastructure resource.

Updates properties of a specified ODB network.

Link to this section Functions

Link to this function

accept_marketplace_registration(client, input, options \\ [])

View Source

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

Link to this function

create_cloud_autonomous_vm_cluster(client, input, options \\ [])

View Source

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

Link to this function

create_cloud_exadata_infrastructure(client, input, options \\ [])

View Source

Creates an Exadata infrastructure.

Link to this function

create_cloud_vm_cluster(client, input, options \\ [])

View Source

Creates a VM cluster on the specified Exadata infrastructure.

Link to this function

create_odb_network(client, input, options \\ [])

View Source

Creates an ODB network.

Link to this function

create_odb_peering_connection(client, input, options \\ [])

View Source

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

A peering connection enables private connectivity between the networks for application-tier communication.

Link to this function

delete_cloud_autonomous_vm_cluster(client, input, options \\ [])

View Source

Deletes an Autonomous VM cluster.

Link to this function

delete_cloud_exadata_infrastructure(client, input, options \\ [])

View Source

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 to this function

delete_cloud_vm_cluster(client, input, options \\ [])

View Source

Deletes the specified VM cluster.

Link to this function

delete_odb_network(client, input, options \\ [])

View Source

Deletes the specified ODB network.

Link to this function

delete_odb_peering_connection(client, input, options \\ [])

View Source

Deletes an ODB peering connection.

When you delete an ODB peering connection, the underlying VPC peering connection is also deleted.

Link to this function

get_cloud_autonomous_vm_cluster(client, input, options \\ [])

View Source

Gets information about a specific Autonomous VM cluster.

Link to this function

get_cloud_exadata_infrastructure(client, input, options \\ [])

View Source

Returns information about the specified Exadata infrastructure.

Link to this function

get_cloud_exadata_infrastructure_unallocated_resources(client, input, options \\ [])

View Source

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

Link to this function

get_cloud_vm_cluster(client, input, options \\ [])

View Source

Returns information about the specified VM cluster.

Link to this function

get_db_node(client, input, options \\ [])

View Source

Returns information about the specified DB node.

Link to this function

get_db_server(client, input, options \\ [])

View Source

Returns information about the specified database server.

Link to this function

get_oci_onboarding_status(client, input, options \\ [])

View Source

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

Link to this function

get_odb_network(client, input, options \\ [])

View Source

Returns information about the specified ODB network.

Link to this function

get_odb_peering_connection(client, input, options \\ [])

View Source

Retrieves information about an ODB peering connection.

Link to this function

initialize_service(client, input, options \\ [])

View Source

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

Link to this function

list_autonomous_virtual_machines(client, input, options \\ [])

View Source

Lists all Autonomous VMs in an Autonomous VM cluster.

Link to this function

list_cloud_autonomous_vm_clusters(client, input, options \\ [])

View Source

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

Link to this function

list_cloud_exadata_infrastructures(client, input, options \\ [])

View Source

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

Link to this function

list_cloud_vm_clusters(client, input, options \\ [])

View Source

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

Link to this function

list_db_nodes(client, input, options \\ [])

View Source

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

Link to this function

list_db_servers(client, input, options \\ [])

View Source

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

Link to this function

list_db_system_shapes(client, input, options \\ [])

View Source

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

Link to this function

list_gi_versions(client, input, options \\ [])

View Source

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

Link to this function

list_odb_networks(client, input, options \\ [])

View Source

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

Link to this function

list_odb_peering_connections(client, input, options \\ [])

View Source

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

Link to this function

list_system_versions(client, input, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Returns information about the tags applied to this resource.

Link to this function

reboot_db_node(client, input, options \\ [])

View Source

Reboots the specified DB node in a VM cluster.

Link to this function

start_db_node(client, input, options \\ [])

View Source

Starts the specified DB node in a VM cluster.

Link to this function

stop_db_node(client, input, options \\ [])

View Source

Stops the specified DB node in a VM cluster.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Applies tags to the specified resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from the specified resource.

Link to this function

update_cloud_exadata_infrastructure(client, input, options \\ [])

View Source

Updates the properties of an Exadata infrastructure resource.

Link to this function

update_odb_network(client, input, options \\ [])

View Source

Updates properties of a specified ODB network.