AcceptMarketplaceRegistration

$result = $client->acceptMarketplaceRegistration([/* ... */]);
$promise = $client->acceptMarketplaceRegistrationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->acceptMarketplaceRegistration([
    'marketplaceRegistrationToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

AssociateIamRoleToResource

$result = $client->associateIamRoleToResource([/* ... */]);
$promise = $client->associateIamRoleToResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->associateIamRoleToResource([
    'awsIntegration' => 'KmsTde', // REQUIRED
    'iamRoleArn' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

CreateAutonomousDatabase

$result = $client->createAutonomousDatabase([/* ... */]);
$promise = $client->createAutonomousDatabaseAsync([/* ... */]);

Creates a new Autonomous Database.

Parameter Syntax

$result = $client->createAutonomousDatabase([
    'adminPassword' => '<string>',
    'allowlistedIps' => ['<string>', ...],
    'autonomousMaintenanceScheduleType' => 'EARLY|REGULAR',
    'backupRetentionPeriodInDays' => <integer>,
    'byolComputeCountLimit' => <float>,
    'characterSet' => '<string>',
    'clientToken' => '<string>',
    'computeCount' => <float>,
    'cpuCoreCount' => <integer>,
    'customerContactsToSendToOCI' => [
        [
            'email' => '<string>',
        ],
        // ...
    ],
    'dataStorageSizeInGBs' => <integer>,
    'dataStorageSizeInTBs' => <integer>,
    'databaseEdition' => 'STANDARD_EDITION|ENTERPRISE_EDITION',
    'dbName' => '<string>',
    'dbToolsDetails' => [
        [
            'computeCount' => <float>,
            'isEnabled' => true || false,
            'maxIdleTimeInMinutes' => <integer>,
            'name' => '<string>',
        ],
        // ...
    ],
    'dbVersion' => '<string>',
    'dbWorkload' => 'OLTP|AJD|APEX|LH',
    'displayName' => '<string>',
    'encryptionKeyConfiguration' => [
        'awsEncryptionKey' => [
            'externalIdType' => 'database_ocid|compartment_ocid|tenant_ocid',
            'iamRoleArn' => '<string>',
            'kmsKeyId' => '<string>',
        ],
    ],
    'encryptionKeyProvider' => 'ORACLE_MANAGED|AWS_KMS',
    'isAutoScalingEnabled' => true || false,
    'isAutoScalingForStorageEnabled' => true || false,
    'isBackupRetentionLocked' => true || false,
    'isLocalDataGuardEnabled' => true || false,
    'isMtlsConnectionRequired' => true || false,
    'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
    'ncharacterSet' => '<string>',
    'odbNetworkId' => '<string>',
    'privateEndpointIp' => '<string>',
    'privateEndpointLabel' => '<string>',
    'resourcePoolLeaderId' => '<string>',
    'resourcePoolSummary' => [
        'availableComputeCapacity' => <integer>,
        'availableStorageCapacityInTBs' => <float>,
        'isDisabled' => true || false,
        'poolSize' => <integer>,
        'poolStorageSizeInTBs' => <integer>,
        'totalComputeCapacity' => <integer>,
    ],
    'scheduledOperations' => [
        [
            'dayOfWeek' => [ // REQUIRED
                'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
            ],
            'scheduledStartTime' => '<string>',
            'scheduledStopTime' => '<string>',
        ],
        // ...
    ],
    'source' => 'NONE|DATABASE|BACKUP_FROM_ID|BACKUP_FROM_TIMESTAMP|CROSS_REGION_DATAGUARD|CROSS_REGION_DISASTER_RECOVERY|CLONE_TO_REFRESHABLE',
    'sourceConfiguration' => [
        'cloneToRefreshable' => [
            'autoRefreshFrequencyInSeconds' => <integer>,
            'autoRefreshPointLagInSeconds' => <integer>,
            'cloneType' => 'FULL|METADATA|PARTIAL',
            'openMode' => 'READ_ONLY|READ_WRITE',
            'refreshableMode' => 'AUTOMATIC|MANUAL',
            'sourceAutonomousDatabaseId' => '<string>', // REQUIRED
            'timeOfAutoRefreshStart' => <integer || string || DateTime>,
        ],
        'crossRegionDataGuard' => [
            'sourceAutonomousDatabaseArn' => '<string>', // REQUIRED
        ],
        'crossRegionDisasterRecovery' => [
            'isReplicateAutomaticBackups' => true || false,
            'remoteDisasterRecoveryType' => 'ADG|BACKUP_BASED', // REQUIRED
            'sourceAutonomousDatabaseArn' => '<string>', // REQUIRED
        ],
        'databaseClone' => [
            'cloneType' => 'FULL|METADATA|PARTIAL', // REQUIRED
            'sourceAutonomousDatabaseId' => '<string>', // REQUIRED
        ],
        'pointInTimeRestore' => [
            'cloneTableSpaceList' => [<integer>, ...],
            'cloneType' => 'FULL|METADATA|PARTIAL', // REQUIRED
            'sourceAutonomousDatabaseId' => '<string>', // REQUIRED
            'timestamp' => <integer || string || DateTime>,
            'useLatestAvailableBackupTimestamp' => true || false,
        ],
        'restoreFromBackup' => [
            'autonomousDatabaseBackupId' => '<string>', // REQUIRED
            'cloneTableSpaceList' => [<integer>, ...],
            'cloneType' => 'FULL|METADATA|PARTIAL', // REQUIRED
        ],
    ],
    'standbyAllowlistedIps' => ['<string>', ...],
    'standbyAllowlistedIpsSource' => 'PRIMARY|SEPARATE|NOT_APPLICABLE',
    'tags' => ['<string>', ...],
    'transportableTablespace' => [
        'ttsBundleUrl' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded the service quota.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

CreateAutonomousDatabaseBackup

$result = $client->createAutonomousDatabaseBackup([/* ... */]);
$promise = $client->createAutonomousDatabaseBackupAsync([/* ... */]);

Creates a new backup of the specified Autonomous Database.

Parameter Syntax

$result = $client->createAutonomousDatabaseBackup([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'displayName' => '<string>',
    'retentionPeriodInDays' => <integer>,
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseBackupId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded the service quota.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

CreateAutonomousDatabaseWallet

$result = $client->createAutonomousDatabaseWallet([/* ... */]);
$promise = $client->createAutonomousDatabaseWalletAsync([/* ... */]);

Creates a new wallet for the specified Autonomous Database.

Parameter Syntax

$result = $client->createAutonomousDatabaseWallet([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'password' => '<string>', // REQUIRED
    'walletType' => 'REGIONAL|INSTANCE',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseWalletFile' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

CreateCloudAutonomousVmCluster

$result = $client->createCloudAutonomousVmCluster([/* ... */]);
$promise = $client->createCloudAutonomousVmClusterAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createCloudAutonomousVmCluster([
    'autonomousDataStorageSizeInTBs' => <float>, // REQUIRED
    'clientToken' => '<string>',
    'cloudExadataInfrastructureId' => '<string>', // REQUIRED
    'cpuCoreCountPerNode' => <integer>, // REQUIRED
    'dbServers' => ['<string>', ...],
    'description' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'isMtlsEnabledVmCluster' => true || false,
    'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
    'maintenanceWindow' => [
        'customActionTimeoutInMins' => <integer>,
        'daysOfWeek' => [
            [
                'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
            ],
            // ...
        ],
        'hoursOfDay' => [<integer>, ...],
        'isCustomActionTimeoutEnabled' => true || false,
        'leadTimeInWeeks' => <integer>,
        'months' => [
            [
                'name' => 'JANUARY|FEBRUARY|MARCH|APRIL|MAY|JUNE|JULY|AUGUST|SEPTEMBER|OCTOBER|NOVEMBER|DECEMBER',
            ],
            // ...
        ],
        'patchingMode' => 'ROLLING|NONROLLING',
        'preference' => 'NO_PREFERENCE|CUSTOM_PREFERENCE',
        'skipRu' => true || false,
        'weeksOfMonth' => [<integer>, ...],
    ],
    'memoryPerOracleComputeUnitInGBs' => <integer>, // REQUIRED
    'odbNetworkId' => '<string>', // REQUIRED
    'scanListenerPortNonTls' => <integer>,
    'scanListenerPortTls' => <integer>,
    'tags' => ['<string>', ...],
    'timeZone' => '<string>',
    'totalContainerDatabases' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cloudAutonomousVmClusterId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded the service quota.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

CreateCloudExadataInfrastructure

$result = $client->createCloudExadataInfrastructure([/* ... */]);
$promise = $client->createCloudExadataInfrastructureAsync([/* ... */]);

Creates an Exadata infrastructure.

Parameter Syntax

$result = $client->createCloudExadataInfrastructure([
    'availabilityZone' => '<string>',
    'availabilityZoneId' => '<string>',
    'clientToken' => '<string>',
    'computeCount' => <integer>, // REQUIRED
    'customerContactsToSendToOCI' => [
        [
            'email' => '<string>',
        ],
        // ...
    ],
    'databaseServerType' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'maintenanceWindow' => [
        'customActionTimeoutInMins' => <integer>,
        'daysOfWeek' => [
            [
                'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
            ],
            // ...
        ],
        'hoursOfDay' => [<integer>, ...],
        'isCustomActionTimeoutEnabled' => true || false,
        'leadTimeInWeeks' => <integer>,
        'months' => [
            [
                'name' => 'JANUARY|FEBRUARY|MARCH|APRIL|MAY|JUNE|JULY|AUGUST|SEPTEMBER|OCTOBER|NOVEMBER|DECEMBER',
            ],
            // ...
        ],
        'patchingMode' => 'ROLLING|NONROLLING',
        'preference' => 'NO_PREFERENCE|CUSTOM_PREFERENCE',
        'skipRu' => true || false,
        'weeksOfMonth' => [<integer>, ...],
    ],
    'shape' => '<string>', // REQUIRED
    'storageCount' => <integer>, // REQUIRED
    'storageServerType' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'cloudExadataInfrastructureId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded the service quota.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

CreateCloudVmCluster

$result = $client->createCloudVmCluster([/* ... */]);
$promise = $client->createCloudVmClusterAsync([/* ... */]);

Creates a VM cluster on the specified Exadata infrastructure.

Parameter Syntax

$result = $client->createCloudVmCluster([
    'clientToken' => '<string>',
    'cloudExadataInfrastructureId' => '<string>', // REQUIRED
    'clusterName' => '<string>',
    'cpuCoreCount' => <integer>, // REQUIRED
    'dataCollectionOptions' => [
        'isDiagnosticsEventsEnabled' => true || false,
        'isHealthMonitoringEnabled' => true || false,
        'isIncidentLogsEnabled' => true || false,
    ],
    'dataStorageSizeInTBs' => <float>,
    'dbNodeStorageSizeInGBs' => <integer>,
    'dbServers' => ['<string>', ...],
    'displayName' => '<string>', // REQUIRED
    'giVersion' => '<string>', // REQUIRED
    'hostname' => '<string>', // REQUIRED
    'isLocalBackupEnabled' => true || false,
    'isSparseDiskgroupEnabled' => true || false,
    'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
    'memorySizeInGBs' => <integer>,
    'odbNetworkId' => '<string>', // REQUIRED
    'scanListenerPortTcp' => <integer>,
    'sshPublicKeys' => ['<string>', ...], // REQUIRED
    'systemVersion' => '<string>',
    'tags' => ['<string>', ...],
    'timeZone' => '<string>',
]);

Parameter Details

Result Syntax

[
    'cloudVmClusterId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded the service quota.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

CreateOdbNetwork

$result = $client->createOdbNetwork([/* ... */]);
$promise = $client->createOdbNetworkAsync([/* ... */]);

Creates an ODB network.

Parameter Syntax

$result = $client->createOdbNetwork([
    'availabilityZone' => '<string>',
    'availabilityZoneId' => '<string>',
    'backupSubnetCidr' => '<string>',
    'clientSubnetCidr' => '<string>', // REQUIRED
    'clientToken' => '<string>',
    'crossRegionS3RestoreSourcesToEnable' => ['<string>', ...],
    'customDomainName' => '<string>',
    'defaultDnsPrefix' => '<string>',
    'displayName' => '<string>', // REQUIRED
    'kmsAccess' => 'ENABLED|DISABLED',
    'kmsPolicyDocument' => '<string>',
    's3Access' => 'ENABLED|DISABLED',
    's3PolicyDocument' => '<string>',
    'stsAccess' => 'ENABLED|DISABLED',
    'stsPolicyDocument' => '<string>',
    'tags' => ['<string>', ...],
    'zeroEtlAccess' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[
    'displayName' => '<string>',
    'odbNetworkId' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

You have exceeded the service quota.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

CreateOdbPeeringConnection

$result = $client->createOdbPeeringConnection([/* ... */]);
$promise = $client->createOdbPeeringConnectionAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->createOdbPeeringConnection([
    'clientToken' => '<string>',
    'displayName' => '<string>',
    'odbNetworkId' => '<string>', // REQUIRED
    'peerNetworkCidrsToBeAdded' => ['<string>', ...],
    'peerNetworkId' => '<string>', // REQUIRED
    'peerNetworkRouteTableIds' => ['<string>', ...],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'displayName' => '<string>',
    'odbPeeringConnectionId' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DeleteAutonomousDatabase

$result = $client->deleteAutonomousDatabase([/* ... */]);
$promise = $client->deleteAutonomousDatabaseAsync([/* ... */]);

Deletes the specified Autonomous Database.

Parameter Syntax

$result = $client->deleteAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DeleteAutonomousDatabaseBackup

$result = $client->deleteAutonomousDatabaseBackup([/* ... */]);
$promise = $client->deleteAutonomousDatabaseBackupAsync([/* ... */]);

Deletes the specified Autonomous Database backup.

Parameter Syntax

$result = $client->deleteAutonomousDatabaseBackup([
    'autonomousDatabaseBackupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DeleteCloudAutonomousVmCluster

$result = $client->deleteCloudAutonomousVmCluster([/* ... */]);
$promise = $client->deleteCloudAutonomousVmClusterAsync([/* ... */]);

Deletes an Autonomous VM cluster.

Parameter Syntax

$result = $client->deleteCloudAutonomousVmCluster([
    'cloudAutonomousVmClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DeleteCloudExadataInfrastructure

$result = $client->deleteCloudExadataInfrastructure([/* ... */]);
$promise = $client->deleteCloudExadataInfrastructureAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteCloudExadataInfrastructure([
    'cloudExadataInfrastructureId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DeleteCloudVmCluster

$result = $client->deleteCloudVmCluster([/* ... */]);
$promise = $client->deleteCloudVmClusterAsync([/* ... */]);

Deletes the specified VM cluster.

Parameter Syntax

$result = $client->deleteCloudVmCluster([
    'cloudVmClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DeleteOdbNetwork

$result = $client->deleteOdbNetwork([/* ... */]);
$promise = $client->deleteOdbNetworkAsync([/* ... */]);

Deletes the specified ODB network.

Parameter Syntax

$result = $client->deleteOdbNetwork([
    'deleteAssociatedResources' => true || false, // REQUIRED
    'odbNetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DeleteOdbPeeringConnection

$result = $client->deleteOdbPeeringConnection([/* ... */]);
$promise = $client->deleteOdbPeeringConnectionAsync([/* ... */]);

Deletes an ODB peering connection.

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

Parameter Syntax

$result = $client->deleteOdbPeeringConnection([
    'odbPeeringConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

DisassociateIamRoleFromResource

$result = $client->disassociateIamRoleFromResource([/* ... */]);
$promise = $client->disassociateIamRoleFromResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociateIamRoleFromResource([
    'awsIntegration' => 'KmsTde', // REQUIRED
    'iamRoleArn' => '<string>', // REQUIRED
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

FailoverAutonomousDatabase

$result = $client->failoverAutonomousDatabase([/* ... */]);
$promise = $client->failoverAutonomousDatabaseAsync([/* ... */]);

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

Parameter Syntax

$result = $client->failoverAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'peerDbArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetAutonomousDatabase

$result = $client->getAutonomousDatabase([/* ... */]);
$promise = $client->getAutonomousDatabaseAsync([/* ... */]);

Gets information about a specific Autonomous Database.

Parameter Syntax

$result = $client->getAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autonomousDatabase' => [
        'actualUsedDataStorageSizeInTBs' => <float>,
        'allocatedStorageSizeInTBs' => <float>,
        'allowlistedIps' => ['<string>', ...],
        'apexDetails' => [
            'apexVersion' => '<string>',
            'ordsVersion' => '<string>',
        ],
        'autoRefreshFrequencyInSeconds' => <integer>,
        'autoRefreshPointLagInSeconds' => <integer>,
        'autonomousDatabaseArn' => '<string>',
        'autonomousDatabaseId' => '<string>',
        'autonomousMaintenanceScheduleType' => 'EARLY|REGULAR',
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'availableUpgradeVersions' => ['<string>', ...],
        'backupRetentionPeriodInDays' => <integer>,
        'byolComputeCountLimit' => <integer>,
        'characterSet' => '<string>',
        'cloneTableSpaceList' => [<integer>, ...],
        'computeCount' => <float>,
        'computeModel' => 'ECPU|OCPU',
        'connectionStringDetails' => [
            'allConnectionStrings' => ['<string>', ...],
            'dedicated' => '<string>',
            'high' => '<string>',
            'low' => '<string>',
            'medium' => '<string>',
            'profiles' => [
                [
                    'consumerGroup' => '<string>',
                    'displayName' => '<string>',
                    'hostFormat' => '<string>',
                    'isRegional' => true || false,
                    'protocol' => '<string>',
                    'sessionMode' => '<string>',
                    'syntaxFormat' => '<string>',
                    'tlsAuthentication' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
        ],
        'connectionUrls' => [
            'apexUrl' => '<string>',
            'databaseTransformsUrl' => '<string>',
            'graphStudioUrl' => '<string>',
            'machineLearningNotebookUrl' => '<string>',
            'machineLearningUserManagementUrl' => '<string>',
            'mongoDbUrl' => '<string>',
            'ordsUrl' => '<string>',
            'spatialStudioUrl' => '<string>',
            'sqlDevWebUrl' => '<string>',
        ],
        'cpuCoreCount' => <integer>,
        'createdAt' => <DateTime>,
        'customerContacts' => [
            [
                'email' => '<string>',
            ],
            // ...
        ],
        'dataSafeStatus' => 'REGISTERING|REGISTERED|DEREGISTERING|NOT_REGISTERED|FAILED',
        'dataStorageSizeInGBs' => <integer>,
        'dataStorageSizeInTBs' => <float>,
        'databaseEdition' => 'STANDARD_EDITION|ENTERPRISE_EDITION',
        'databaseManagementStatus' => 'ENABLING|ENABLED|DISABLING|NOT_ENABLED|FAILED_ENABLING|FAILED_DISABLING',
        'databaseType' => 'REGULAR|CLONE',
        'dbName' => '<string>',
        'dbToolsDetails' => [
            [
                'computeCount' => <float>,
                'isEnabled' => true || false,
                'maxIdleTimeInMinutes' => <integer>,
                'name' => '<string>',
            ],
            // ...
        ],
        'dbVersion' => '<string>',
        'dbWorkload' => 'OLTP|AJD|APEX|LH',
        'displayName' => '<string>',
        'encryptionSummary' => [
            'encryptionKeyConfiguration' => [
                'awsEncryptionKey' => [
                    'externalIdType' => 'database_ocid|compartment_ocid|tenant_ocid',
                    'iamRoleArn' => '<string>',
                    'kmsKeyId' => '<string>',
                ],
                'ociEncryptionKey' => [
                    'kmsKeyId' => '<string>',
                    'vaultId' => '<string>',
                ],
                'okvEncryptionKey' => [
                    'certificateDirectoryName' => '<string>',
                    'certificateId' => '<string>',
                    'directoryName' => '<string>',
                    'okvKmsKey' => '<string>',
                    'okvUri' => '<string>',
                ],
            ],
            'encryptionKeyProvider' => 'ORACLE_MANAGED|AWS_KMS|OKV|OCI',
        ],
        'failedDataRecoveryInSeconds' => <integer>,
        'inMemoryAreaInGBs' => <integer>,
        'isAutoScalingEnabled' => true || false,
        'isAutoScalingForStorageEnabled' => true || false,
        'isBackupRetentionLocked' => true || false,
        'isLocalDataGuardEnabled' => true || false,
        'isMtlsConnectionRequired' => true || false,
        'isReconnectCloneEnabled' => true || false,
        'isRefreshableClone' => true || false,
        'isRemoteDataGuardEnabled' => true || false,
        'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
        'localAdgAutoFailoverMaxDataLossLimit' => <integer>,
        'localDisasterRecoveryType' => 'ADG|BACKUP_BASED',
        'localStandbyDb' => [
            'availabilityDomain' => '<string>',
            'lagTimeInSeconds' => <integer>,
            'maintenanceTargetComponent' => '<string>',
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
            'statusReason' => '<string>',
            'timeDataGuardRoleChanged' => <DateTime>,
            'timeDisasterRecoveryRoleChanged' => <DateTime>,
            'timeMaintenanceBegin' => <DateTime>,
            'timeMaintenanceEnd' => <DateTime>,
        ],
        'longTermBackupSchedule' => [
            'isDisabled' => true || false,
            'repeatCadence' => 'ONE_TIME|WEEKLY|MONTHLY|YEARLY',
            'retentionPeriodInDays' => <integer>,
            'timeOfBackup' => <DateTime>,
        ],
        'maintenanceTargetComponent' => '<string>',
        'memoryPerOracleComputeUnitInGBs' => <integer>,
        'ncharacterSet' => '<string>',
        'netServicesArchitecture' => 'DEDICATED|SHARED',
        'nextLongTermBackupTimeStamp' => <DateTime>,
        'ociResourceAnchorName' => '<string>',
        'ociUrl' => '<string>',
        'ocid' => '<string>',
        'odbNetworkArn' => '<string>',
        'odbNetworkId' => '<string>',
        'openMode' => 'READ_ONLY|READ_WRITE',
        'operationsInsightsStatus' => 'ENABLING|ENABLED|DISABLING|NOT_ENABLED|FAILED_ENABLING|FAILED_DISABLING',
        'peerDbIds' => ['<string>', ...],
        'percentProgress' => <float>,
        'permissionLevel' => 'RESTRICTED|UNRESTRICTED',
        'privateEndpoint' => '<string>',
        'privateEndpointIp' => '<string>',
        'privateEndpointLabel' => '<string>',
        'provisionableCpus' => [<integer>, ...],
        'refreshableMode' => 'AUTOMATIC|MANUAL',
        'refreshableStatus' => 'REFRESHING|NOT_REFRESHING',
        'remoteDisasterRecoveryConfiguration' => [
            'disasterRecoveryType' => 'ADG|BACKUP_BASED',
            'isReplicateAutomaticBackups' => true || false,
            'isSnapshotStandby' => true || false,
            'timeSnapshotStandbyEnabledTill' => <DateTime>,
        ],
        'resourcePoolLeaderId' => '<string>',
        'resourcePoolSummary' => [
            'availableComputeCapacity' => <integer>,
            'availableStorageCapacityInTBs' => <float>,
            'isDisabled' => true || false,
            'poolSize' => <integer>,
            'poolStorageSizeInTBs' => <integer>,
            'totalComputeCapacity' => <integer>,
        ],
        'role' => 'PRIMARY|STANDBY|DISABLED_STANDBY|BACKUP_COPY|SNAPSHOT_STANDBY',
        'scheduledOperations' => [
            [
                'dayOfWeek' => [
                    'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
                ],
                'scheduledStartTime' => '<string>',
                'scheduledStopTime' => '<string>',
            ],
            // ...
        ],
        'serviceConsoleUrl' => '<string>',
        'sourceId' => '<string>',
        'sqlWebDeveloperUrl' => '<string>',
        'standbyAllowlistedIps' => ['<string>', ...],
        'standbyAllowlistedIpsSource' => 'PRIMARY|SEPARATE|NOT_APPLICABLE',
        'standbyDb' => [
            'availabilityDomain' => '<string>',
            'lagTimeInSeconds' => <integer>,
            'maintenanceTargetComponent' => '<string>',
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
            'statusReason' => '<string>',
            'timeDataGuardRoleChanged' => <DateTime>,
            'timeDisasterRecoveryRoleChanged' => <DateTime>,
            'timeMaintenanceBegin' => <DateTime>,
            'timeMaintenanceEnd' => <DateTime>,
        ],
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
        'statusReason' => '<string>',
        'timeDataGuardRoleChanged' => <DateTime>,
        'timeDeletionOfFreeAutonomousDatabase' => <DateTime>,
        'timeDisasterRecoveryRoleChanged' => <DateTime>,
        'timeLocalDataGuardEnabled' => <DateTime>,
        'timeMaintenanceBegin' => <DateTime>,
        'timeMaintenanceEnd' => <DateTime>,
        'timeOfAutoRefreshStart' => <DateTime>,
        'timeOfLastBackup' => <DateTime>,
        'timeOfLastFailover' => <DateTime>,
        'timeOfLastRefresh' => <DateTime>,
        'timeOfLastRefreshPoint' => <DateTime>,
        'timeOfLastSwitchover' => <DateTime>,
        'timeOfNextRefresh' => <DateTime>,
        'timeReclamationOfFreeAutonomousDatabase' => <DateTime>,
        'timeUndeleted' => <DateTime>,
        'timeUntilReconnectCloneEnabled' => <DateTime>,
        'totalBackupStorageSizeInGBs' => <float>,
        'usedDataStorageSizeInGBs' => <integer>,
        'usedDataStorageSizeInTBs' => <float>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetAutonomousDatabaseBackup

$result = $client->getAutonomousDatabaseBackup([/* ... */]);
$promise = $client->getAutonomousDatabaseBackupAsync([/* ... */]);

Gets information about a specific Autonomous Database backup.

Parameter Syntax

$result = $client->getAutonomousDatabaseBackup([
    'autonomousDatabaseBackupId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseBackup' => [
        'autonomousDatabaseBackupArn' => '<string>',
        'autonomousDatabaseBackupId' => '<string>',
        'autonomousDatabaseId' => '<string>',
        'dbVersion' => '<string>',
        'displayName' => '<string>',
        'isAutomatic' => true || false,
        'ocid' => '<string>',
        'retentionPeriodInDays' => <integer>,
        'sizeInTBs' => <float>,
        'status' => 'ACTIVE|CREATING|UPDATING|DELETING|FAILED',
        'statusReason' => '<string>',
        'timeAvailableTill' => <DateTime>,
        'timeEnded' => <DateTime>,
        'timeStarted' => <DateTime>,
        'type' => 'INCREMENTAL|FULL|LONGTERM|VIRTUAL_FULL|CUMULATIVE_INCREMENTAL|ROLL_FORWARD_IMAGE_COPY',
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetAutonomousDatabaseWalletDetails

$result = $client->getAutonomousDatabaseWalletDetails([/* ... */]);
$promise = $client->getAutonomousDatabaseWalletDetailsAsync([/* ... */]);

Gets the wallet details for the specified Autonomous Database.

Parameter Syntax

$result = $client->getAutonomousDatabaseWalletDetails([
    'autonomousDatabaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseWalletDetails' => [
        'status' => 'ACTIVE|UPDATING',
        'timeRotated' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetCloudAutonomousVmCluster

$result = $client->getCloudAutonomousVmCluster([/* ... */]);
$promise = $client->getCloudAutonomousVmClusterAsync([/* ... */]);

Gets information about a specific Autonomous VM cluster.

Parameter Syntax

$result = $client->getCloudAutonomousVmCluster([
    'cloudAutonomousVmClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cloudAutonomousVmCluster' => [
        'autonomousDataStoragePercentage' => <float>,
        'autonomousDataStorageSizeInTBs' => <float>,
        'availableAutonomousDataStorageSizeInTBs' => <float>,
        'availableContainerDatabases' => <integer>,
        'availableCpus' => <float>,
        'cloudAutonomousVmClusterArn' => '<string>',
        'cloudAutonomousVmClusterId' => '<string>',
        'cloudExadataInfrastructureArn' => '<string>',
        'cloudExadataInfrastructureId' => '<string>',
        'computeModel' => 'ECPU|OCPU',
        'cpuCoreCount' => <integer>,
        'cpuCoreCountPerNode' => <integer>,
        'cpuPercentage' => <float>,
        'createdAt' => <DateTime>,
        'dataStorageSizeInGBs' => <float>,
        'dataStorageSizeInTBs' => <float>,
        'dbNodeStorageSizeInGBs' => <integer>,
        'dbServers' => ['<string>', ...],
        'description' => '<string>',
        'displayName' => '<string>',
        'domain' => '<string>',
        'exadataStorageInTBsLowestScaledValue' => <float>,
        'hostname' => '<string>',
        'iamRoles' => [
            [
                'awsIntegration' => 'KmsTde',
                'iamRoleArn' => '<string>',
                'status' => 'ASSOCIATING|DISASSOCIATING|FAILED|CONNECTED|DISCONNECTED|PARTIALLY_CONNECTED|UNKNOWN',
                'statusReason' => '<string>',
            ],
            // ...
        ],
        'isMtlsEnabledVmCluster' => true || false,
        'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
        'maintenanceWindow' => [
            'customActionTimeoutInMins' => <integer>,
            'daysOfWeek' => [
                [
                    'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
                ],
                // ...
            ],
            'hoursOfDay' => [<integer>, ...],
            'isCustomActionTimeoutEnabled' => true || false,
            'leadTimeInWeeks' => <integer>,
            'months' => [
                [
                    'name' => 'JANUARY|FEBRUARY|MARCH|APRIL|MAY|JUNE|JULY|AUGUST|SEPTEMBER|OCTOBER|NOVEMBER|DECEMBER',
                ],
                // ...
            ],
            'patchingMode' => 'ROLLING|NONROLLING',
            'preference' => 'NO_PREFERENCE|CUSTOM_PREFERENCE',
            'skipRu' => true || false,
            'weeksOfMonth' => [<integer>, ...],
        ],
        'maxAcdsLowestScaledValue' => <integer>,
        'memoryPerOracleComputeUnitInGBs' => <integer>,
        'memorySizeInGBs' => <integer>,
        'nodeCount' => <integer>,
        'nonProvisionableAutonomousContainerDatabases' => <integer>,
        'ociResourceAnchorName' => '<string>',
        'ociUrl' => '<string>',
        'ocid' => '<string>',
        'odbNetworkArn' => '<string>',
        'odbNetworkId' => '<string>',
        'percentProgress' => <float>,
        'provisionableAutonomousContainerDatabases' => <integer>,
        'provisionedAutonomousContainerDatabases' => <integer>,
        'provisionedCpus' => <float>,
        'reclaimableCpus' => <float>,
        'reservedCpus' => <float>,
        'scanListenerPortNonTls' => <integer>,
        'scanListenerPortTls' => <integer>,
        'shape' => '<string>',
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
        'statusReason' => '<string>',
        'timeDatabaseSslCertificateExpires' => <DateTime>,
        'timeOrdsCertificateExpires' => <DateTime>,
        'timeZone' => '<string>',
        'totalContainerDatabases' => <integer>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetCloudExadataInfrastructure

$result = $client->getCloudExadataInfrastructure([/* ... */]);
$promise = $client->getCloudExadataInfrastructureAsync([/* ... */]);

Returns information about the specified Exadata infrastructure.

Parameter Syntax

$result = $client->getCloudExadataInfrastructure([
    'cloudExadataInfrastructureId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cloudExadataInfrastructure' => [
        'activatedStorageCount' => <integer>,
        'additionalStorageCount' => <integer>,
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'availableStorageSizeInGBs' => <integer>,
        'cloudExadataInfrastructureArn' => '<string>',
        'cloudExadataInfrastructureId' => '<string>',
        'computeCount' => <integer>,
        'computeModel' => 'ECPU|OCPU',
        'cpuCount' => <integer>,
        'createdAt' => <DateTime>,
        'customerContactsToSendToOCI' => [
            [
                'email' => '<string>',
            ],
            // ...
        ],
        'dataStorageSizeInTBs' => <float>,
        'databaseServerType' => '<string>',
        'dbNodeStorageSizeInGBs' => <integer>,
        'dbServerVersion' => '<string>',
        'displayName' => '<string>',
        'lastMaintenanceRunId' => '<string>',
        'maintenanceWindow' => [
            'customActionTimeoutInMins' => <integer>,
            'daysOfWeek' => [
                [
                    'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
                ],
                // ...
            ],
            'hoursOfDay' => [<integer>, ...],
            'isCustomActionTimeoutEnabled' => true || false,
            'leadTimeInWeeks' => <integer>,
            'months' => [
                [
                    'name' => 'JANUARY|FEBRUARY|MARCH|APRIL|MAY|JUNE|JULY|AUGUST|SEPTEMBER|OCTOBER|NOVEMBER|DECEMBER',
                ],
                // ...
            ],
            'patchingMode' => 'ROLLING|NONROLLING',
            'preference' => 'NO_PREFERENCE|CUSTOM_PREFERENCE',
            'skipRu' => true || false,
            'weeksOfMonth' => [<integer>, ...],
        ],
        'maxCpuCount' => <integer>,
        'maxDataStorageInTBs' => <float>,
        'maxDbNodeStorageSizeInGBs' => <integer>,
        'maxMemoryInGBs' => <integer>,
        'memorySizeInGBs' => <integer>,
        'monthlyDbServerVersion' => '<string>',
        'monthlyStorageServerVersion' => '<string>',
        'nextMaintenanceRunId' => '<string>',
        'ociResourceAnchorName' => '<string>',
        'ociUrl' => '<string>',
        'ocid' => '<string>',
        'percentProgress' => <float>,
        'shape' => '<string>',
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
        'statusReason' => '<string>',
        'storageCount' => <integer>,
        'storageServerType' => '<string>',
        'storageServerVersion' => '<string>',
        'totalStorageSizeInGBs' => <integer>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetCloudExadataInfrastructureUnallocatedResources

$result = $client->getCloudExadataInfrastructureUnallocatedResources([/* ... */]);
$promise = $client->getCloudExadataInfrastructureUnallocatedResourcesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getCloudExadataInfrastructureUnallocatedResources([
    'cloudExadataInfrastructureId' => '<string>', // REQUIRED
    'dbServers' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'cloudExadataInfrastructureUnallocatedResources' => [
        'cloudAutonomousVmClusters' => [
            [
                'cloudAutonomousVmClusterId' => '<string>',
                'unallocatedAdbStorageInTBs' => <float>,
            ],
            // ...
        ],
        'cloudExadataInfrastructureDisplayName' => '<string>',
        'cloudExadataInfrastructureId' => '<string>',
        'exadataStorageInTBs' => <float>,
        'localStorageInGBs' => <integer>,
        'memoryInGBs' => <integer>,
        'ocpus' => <integer>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetCloudVmCluster

$result = $client->getCloudVmCluster([/* ... */]);
$promise = $client->getCloudVmClusterAsync([/* ... */]);

Returns information about the specified VM cluster.

Parameter Syntax

$result = $client->getCloudVmCluster([
    'cloudVmClusterId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'cloudVmCluster' => [
        'cloudExadataInfrastructureArn' => '<string>',
        'cloudExadataInfrastructureId' => '<string>',
        'cloudVmClusterArn' => '<string>',
        'cloudVmClusterId' => '<string>',
        'clusterName' => '<string>',
        'computeModel' => 'ECPU|OCPU',
        'cpuCoreCount' => <integer>,
        'createdAt' => <DateTime>,
        'dataCollectionOptions' => [
            'isDiagnosticsEventsEnabled' => true || false,
            'isHealthMonitoringEnabled' => true || false,
            'isIncidentLogsEnabled' => true || false,
        ],
        'dataStorageSizeInTBs' => <float>,
        'dbNodeStorageSizeInGBs' => <integer>,
        'dbServers' => ['<string>', ...],
        'diskRedundancy' => 'HIGH|NORMAL',
        'displayName' => '<string>',
        'domain' => '<string>',
        'giVersion' => '<string>',
        'hostname' => '<string>',
        'iamRoles' => [
            [
                'awsIntegration' => 'KmsTde',
                'iamRoleArn' => '<string>',
                'status' => 'ASSOCIATING|DISASSOCIATING|FAILED|CONNECTED|DISCONNECTED|PARTIALLY_CONNECTED|UNKNOWN',
                'statusReason' => '<string>',
            ],
            // ...
        ],
        'iormConfigCache' => [
            'dbPlans' => [
                [
                    'dbName' => '<string>',
                    'flashCacheLimit' => '<string>',
                    'share' => <integer>,
                ],
                // ...
            ],
            'lifecycleDetails' => '<string>',
            'lifecycleState' => 'BOOTSTRAPPING|DISABLED|ENABLED|FAILED|UPDATING',
            'objective' => 'AUTO|BALANCED|BASIC|HIGH_THROUGHPUT|LOW_LATENCY',
        ],
        'isLocalBackupEnabled' => true || false,
        'isSparseDiskgroupEnabled' => true || false,
        'lastUpdateHistoryEntryId' => '<string>',
        'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
        'listenerPort' => <integer>,
        'memorySizeInGBs' => <integer>,
        'nodeCount' => <integer>,
        'ociResourceAnchorName' => '<string>',
        'ociUrl' => '<string>',
        'ocid' => '<string>',
        'odbNetworkArn' => '<string>',
        'odbNetworkId' => '<string>',
        'percentProgress' => <float>,
        'scanDnsName' => '<string>',
        'scanDnsRecordId' => '<string>',
        'scanIpIds' => ['<string>', ...],
        'shape' => '<string>',
        'sshPublicKeys' => ['<string>', ...],
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
        'statusReason' => '<string>',
        'storageSizeInGBs' => <integer>,
        'systemVersion' => '<string>',
        'timeZone' => '<string>',
        'vipIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetDbNode

$result = $client->getDbNode([/* ... */]);
$promise = $client->getDbNodeAsync([/* ... */]);

Returns information about the specified DB node.

Parameter Syntax

$result = $client->getDbNode([
    'cloudVmClusterId' => '<string>', // REQUIRED
    'dbNodeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dbNode' => [
        'additionalDetails' => '<string>',
        'backupIpId' => '<string>',
        'backupVnic2Id' => '<string>',
        'backupVnicId' => '<string>',
        'cpuCoreCount' => <integer>,
        'createdAt' => <DateTime>,
        'dbNodeArn' => '<string>',
        'dbNodeId' => '<string>',
        'dbNodeStorageSizeInGBs' => <integer>,
        'dbServerId' => '<string>',
        'dbSystemId' => '<string>',
        'faultDomain' => '<string>',
        'floatingIpAddress' => '<string>',
        'hostIpId' => '<string>',
        'hostname' => '<string>',
        'maintenanceType' => 'VMDB_REBOOT_MIGRATION',
        'memorySizeInGBs' => <integer>,
        'ociResourceAnchorName' => '<string>',
        'ocid' => '<string>',
        'privateIpAddress' => '<string>',
        'softwareStorageSizeInGB' => <integer>,
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|STOPPING|STOPPED|STARTING',
        'statusReason' => '<string>',
        'timeMaintenanceWindowEnd' => '<string>',
        'timeMaintenanceWindowStart' => '<string>',
        'totalCpuCoreCount' => <integer>,
        'vnic2Id' => '<string>',
        'vnicId' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetDbServer

$result = $client->getDbServer([/* ... */]);
$promise = $client->getDbServerAsync([/* ... */]);

Returns information about the specified database server.

Parameter Syntax

$result = $client->getDbServer([
    'cloudExadataInfrastructureId' => '<string>', // REQUIRED
    'dbServerId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dbServer' => [
        'autonomousVirtualMachineIds' => ['<string>', ...],
        'autonomousVmClusterIds' => ['<string>', ...],
        'computeModel' => 'ECPU|OCPU',
        'cpuCoreCount' => <integer>,
        'createdAt' => <DateTime>,
        'dbNodeStorageSizeInGBs' => <integer>,
        'dbServerId' => '<string>',
        'dbServerPatchingDetails' => [
            'estimatedPatchDuration' => <integer>,
            'patchingStatus' => 'COMPLETE|FAILED|MAINTENANCE_IN_PROGRESS|SCHEDULED',
            'timePatchingEnded' => '<string>',
            'timePatchingStarted' => '<string>',
        ],
        'displayName' => '<string>',
        'exadataInfrastructureId' => '<string>',
        'maxCpuCount' => <integer>,
        'maxDbNodeStorageInGBs' => <integer>,
        'maxMemoryInGBs' => <integer>,
        'memorySizeInGBs' => <integer>,
        'ociResourceAnchorName' => '<string>',
        'ocid' => '<string>',
        'shape' => '<string>',
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
        'statusReason' => '<string>',
        'vmClusterIds' => ['<string>', ...],
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetOciOnboardingStatus

$result = $client->getOciOnboardingStatus([/* ... */]);
$promise = $client->getOciOnboardingStatusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getOciOnboardingStatus([
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseOciIntegrationIamRoles' => [
        [
            'awsIntegration' => 'KmsTde',
            'iamRoleArn' => '<string>',
        ],
        // ...
    ],
    'existingTenancyActivationLink' => '<string>',
    'linkedOciCompartmentId' => '<string>',
    'linkedOciTenancyId' => '<string>',
    'newTenancyActivationLink' => '<string>',
    'ociIdentityDomain' => [
        'accountSetupCloudFormationUrl' => '<string>',
        'ociIdentityDomainId' => '<string>',
        'ociIdentityDomainResourceUrl' => '<string>',
        'ociIdentityDomainUrl' => '<string>',
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
        'statusReason' => '<string>',
    ],
    'status' => 'NOT_STARTED|PENDING_LINK_GENERATION|PENDING_CUSTOMER_ACTION|PENDING_INITIALIZATION|ACTIVATING|ACTIVE_IN_HOME_REGION|ACTIVE|ACTIVE_LIMITED|FAILED|PUBLIC_OFFER_UNSUPPORTED|SUSPENDED|CANCELED',
    'subscriptionErrors' => [
        [
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

GetOdbNetwork

$result = $client->getOdbNetwork([/* ... */]);
$promise = $client->getOdbNetworkAsync([/* ... */]);

Returns information about the specified ODB network.

Parameter Syntax

$result = $client->getOdbNetwork([
    'odbNetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'odbNetwork' => [
        'availabilityZone' => '<string>',
        'availabilityZoneId' => '<string>',
        'backupSubnetCidr' => '<string>',
        'clientSubnetCidr' => '<string>',
        'createdAt' => <DateTime>,
        'customDomainName' => '<string>',
        'defaultDnsPrefix' => '<string>',
        'displayName' => '<string>',
        'ec2PlacementGroupIds' => ['<string>', ...],
        'managedServices' => [
            'crossRegionS3RestoreSourcesAccess' => [
                [
                    'ipv4Addresses' => ['<string>', ...],
                    'region' => '<string>',
                    'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                ],
                // ...
            ],
            'kmsAccess' => [
                'domainName' => '<string>',
                'ipv4Addresses' => ['<string>', ...],
                'kmsPolicyDocument' => '<string>',
                'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
            ],
            'managedS3BackupAccess' => [
                'ipv4Addresses' => ['<string>', ...],
                'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
            ],
            'managedServicesIpv4Cidrs' => ['<string>', ...],
            'resourceGatewayArn' => '<string>',
            's3Access' => [
                'domainName' => '<string>',
                'ipv4Addresses' => ['<string>', ...],
                's3PolicyDocument' => '<string>',
                'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
            ],
            'serviceNetworkArn' => '<string>',
            'serviceNetworkEndpoint' => [
                'vpcEndpointId' => '<string>',
                'vpcEndpointType' => 'SERVICENETWORK',
            ],
            'stsAccess' => [
                'domainName' => '<string>',
                'ipv4Addresses' => ['<string>', ...],
                'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                'stsPolicyDocument' => '<string>',
            ],
            'zeroEtlAccess' => [
                'cidr' => '<string>',
                'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
            ],
        ],
        'ociDnsForwardingConfigs' => [
            [
                'domainName' => '<string>',
                'ociDnsListenerIp' => '<string>',
            ],
            // ...
        ],
        'ociNetworkAnchorId' => '<string>',
        'ociNetworkAnchorUrl' => '<string>',
        'ociResourceAnchorName' => '<string>',
        'ociVcnId' => '<string>',
        'ociVcnUrl' => '<string>',
        'odbNetworkArn' => '<string>',
        'odbNetworkId' => '<string>',
        'peeredCidrs' => ['<string>', ...],
        'percentProgress' => <float>,
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
        'statusReason' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

GetOdbPeeringConnection

$result = $client->getOdbPeeringConnection([/* ... */]);
$promise = $client->getOdbPeeringConnectionAsync([/* ... */]);

Retrieves information about an ODB peering connection.

Parameter Syntax

$result = $client->getOdbPeeringConnection([
    'odbPeeringConnectionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'odbPeeringConnection' => [
        'createdAt' => <DateTime>,
        'displayName' => '<string>',
        'odbNetworkArn' => '<string>',
        'odbPeeringConnectionArn' => '<string>',
        'odbPeeringConnectionId' => '<string>',
        'odbPeeringConnectionType' => '<string>',
        'peerNetworkArn' => '<string>',
        'peerNetworkCidrs' => ['<string>', ...],
        'percentProgress' => <float>,
        'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
        'statusReason' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

InitializeService

$result = $client->initializeService([/* ... */]);
$promise = $client->initializeServiceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->initializeService([
    'ociIdentityDomain' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListAutonomousDatabaseBackups

$result = $client->listAutonomousDatabaseBackups([/* ... */]);
$promise = $client->listAutonomousDatabaseBackupsAsync([/* ... */]);

Lists the backups of the specified Autonomous Database.

Parameter Syntax

$result = $client->listAutonomousDatabaseBackups([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => 'ACTIVE|CREATING|UPDATING|DELETING|FAILED',
    'type' => 'INCREMENTAL|FULL|LONGTERM|VIRTUAL_FULL|CUMULATIVE_INCREMENTAL|ROLL_FORWARD_IMAGE_COPY',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseBackups' => [
        [
            'autonomousDatabaseBackupArn' => '<string>',
            'autonomousDatabaseBackupId' => '<string>',
            'autonomousDatabaseId' => '<string>',
            'dbVersion' => '<string>',
            'displayName' => '<string>',
            'isAutomatic' => true || false,
            'ocid' => '<string>',
            'retentionPeriodInDays' => <integer>,
            'sizeInTBs' => <float>,
            'status' => 'ACTIVE|CREATING|UPDATING|DELETING|FAILED',
            'statusReason' => '<string>',
            'timeAvailableTill' => <DateTime>,
            'timeEnded' => <DateTime>,
            'timeStarted' => <DateTime>,
            'type' => 'INCREMENTAL|FULL|LONGTERM|VIRTUAL_FULL|CUMULATIVE_INCREMENTAL|ROLL_FORWARD_IMAGE_COPY',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListAutonomousDatabaseCharacterSets

$result = $client->listAutonomousDatabaseCharacterSets([/* ... */]);
$promise = $client->listAutonomousDatabaseCharacterSetsAsync([/* ... */]);

Lists the available character sets for Autonomous Databases.

Parameter Syntax

$result = $client->listAutonomousDatabaseCharacterSets([
    'characterSetType' => 'DATABASE|NATIONAL',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseCharacterSets' => [
        [
            'characterSet' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListAutonomousDatabaseClones

$result = $client->listAutonomousDatabaseClones([/* ... */]);
$promise = $client->listAutonomousDatabaseClonesAsync([/* ... */]);

Lists the clones of the specified Autonomous Database.

Parameter Syntax

$result = $client->listAutonomousDatabaseClones([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseClones' => [
        [
            'actualUsedDataStorageSizeInTBs' => <float>,
            'allocatedStorageSizeInTBs' => <float>,
            'allowlistedIps' => ['<string>', ...],
            'apexDetails' => [
                'apexVersion' => '<string>',
                'ordsVersion' => '<string>',
            ],
            'autoRefreshFrequencyInSeconds' => <integer>,
            'autoRefreshPointLagInSeconds' => <integer>,
            'autonomousDatabaseArn' => '<string>',
            'autonomousDatabaseId' => '<string>',
            'autonomousMaintenanceScheduleType' => 'EARLY|REGULAR',
            'availabilityZone' => '<string>',
            'availabilityZoneId' => '<string>',
            'availableUpgradeVersions' => ['<string>', ...],
            'backupRetentionPeriodInDays' => <integer>,
            'byolComputeCountLimit' => <integer>,
            'characterSet' => '<string>',
            'cloneTableSpaceList' => [<integer>, ...],
            'computeCount' => <float>,
            'computeModel' => 'ECPU|OCPU',
            'connectionStringDetails' => [
                'allConnectionStrings' => ['<string>', ...],
                'dedicated' => '<string>',
                'high' => '<string>',
                'low' => '<string>',
                'medium' => '<string>',
                'profiles' => [
                    [
                        'consumerGroup' => '<string>',
                        'displayName' => '<string>',
                        'hostFormat' => '<string>',
                        'isRegional' => true || false,
                        'protocol' => '<string>',
                        'sessionMode' => '<string>',
                        'syntaxFormat' => '<string>',
                        'tlsAuthentication' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'connectionUrls' => [
                'apexUrl' => '<string>',
                'databaseTransformsUrl' => '<string>',
                'graphStudioUrl' => '<string>',
                'machineLearningNotebookUrl' => '<string>',
                'machineLearningUserManagementUrl' => '<string>',
                'mongoDbUrl' => '<string>',
                'ordsUrl' => '<string>',
                'spatialStudioUrl' => '<string>',
                'sqlDevWebUrl' => '<string>',
            ],
            'cpuCoreCount' => <integer>,
            'createdAt' => <DateTime>,
            'customerContacts' => [
                [
                    'email' => '<string>',
                ],
                // ...
            ],
            'dataSafeStatus' => 'REGISTERING|REGISTERED|DEREGISTERING|NOT_REGISTERED|FAILED',
            'dataStorageSizeInGBs' => <integer>,
            'dataStorageSizeInTBs' => <float>,
            'databaseEdition' => 'STANDARD_EDITION|ENTERPRISE_EDITION',
            'databaseManagementStatus' => 'ENABLING|ENABLED|DISABLING|NOT_ENABLED|FAILED_ENABLING|FAILED_DISABLING',
            'databaseType' => 'REGULAR|CLONE',
            'dbName' => '<string>',
            'dbToolsDetails' => [
                [
                    'computeCount' => <float>,
                    'isEnabled' => true || false,
                    'maxIdleTimeInMinutes' => <integer>,
                    'name' => '<string>',
                ],
                // ...
            ],
            'dbVersion' => '<string>',
            'dbWorkload' => 'OLTP|AJD|APEX|LH',
            'displayName' => '<string>',
            'encryptionSummary' => [
                'encryptionKeyConfiguration' => [
                    'awsEncryptionKey' => [
                        'externalIdType' => 'database_ocid|compartment_ocid|tenant_ocid',
                        'iamRoleArn' => '<string>',
                        'kmsKeyId' => '<string>',
                    ],
                    'ociEncryptionKey' => [
                        'kmsKeyId' => '<string>',
                        'vaultId' => '<string>',
                    ],
                    'okvEncryptionKey' => [
                        'certificateDirectoryName' => '<string>',
                        'certificateId' => '<string>',
                        'directoryName' => '<string>',
                        'okvKmsKey' => '<string>',
                        'okvUri' => '<string>',
                    ],
                ],
                'encryptionKeyProvider' => 'ORACLE_MANAGED|AWS_KMS|OKV|OCI',
            ],
            'failedDataRecoveryInSeconds' => <integer>,
            'inMemoryAreaInGBs' => <integer>,
            'isAutoScalingEnabled' => true || false,
            'isAutoScalingForStorageEnabled' => true || false,
            'isBackupRetentionLocked' => true || false,
            'isLocalDataGuardEnabled' => true || false,
            'isMtlsConnectionRequired' => true || false,
            'isReconnectCloneEnabled' => true || false,
            'isRefreshableClone' => true || false,
            'isRemoteDataGuardEnabled' => true || false,
            'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
            'localAdgAutoFailoverMaxDataLossLimit' => <integer>,
            'localDisasterRecoveryType' => 'ADG|BACKUP_BASED',
            'localStandbyDb' => [
                'availabilityDomain' => '<string>',
                'lagTimeInSeconds' => <integer>,
                'maintenanceTargetComponent' => '<string>',
                'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
                'statusReason' => '<string>',
                'timeDataGuardRoleChanged' => <DateTime>,
                'timeDisasterRecoveryRoleChanged' => <DateTime>,
                'timeMaintenanceBegin' => <DateTime>,
                'timeMaintenanceEnd' => <DateTime>,
            ],
            'longTermBackupSchedule' => [
                'isDisabled' => true || false,
                'repeatCadence' => 'ONE_TIME|WEEKLY|MONTHLY|YEARLY',
                'retentionPeriodInDays' => <integer>,
                'timeOfBackup' => <DateTime>,
            ],
            'maintenanceTargetComponent' => '<string>',
            'memoryPerOracleComputeUnitInGBs' => <integer>,
            'ncharacterSet' => '<string>',
            'netServicesArchitecture' => 'DEDICATED|SHARED',
            'nextLongTermBackupTimeStamp' => <DateTime>,
            'ociResourceAnchorName' => '<string>',
            'ociUrl' => '<string>',
            'ocid' => '<string>',
            'odbNetworkArn' => '<string>',
            'odbNetworkId' => '<string>',
            'openMode' => 'READ_ONLY|READ_WRITE',
            'operationsInsightsStatus' => 'ENABLING|ENABLED|DISABLING|NOT_ENABLED|FAILED_ENABLING|FAILED_DISABLING',
            'peerDbIds' => ['<string>', ...],
            'percentProgress' => <float>,
            'permissionLevel' => 'RESTRICTED|UNRESTRICTED',
            'privateEndpoint' => '<string>',
            'privateEndpointIp' => '<string>',
            'privateEndpointLabel' => '<string>',
            'provisionableCpus' => [<integer>, ...],
            'refreshableMode' => 'AUTOMATIC|MANUAL',
            'refreshableStatus' => 'REFRESHING|NOT_REFRESHING',
            'remoteDisasterRecoveryConfiguration' => [
                'disasterRecoveryType' => 'ADG|BACKUP_BASED',
                'isReplicateAutomaticBackups' => true || false,
                'isSnapshotStandby' => true || false,
                'timeSnapshotStandbyEnabledTill' => <DateTime>,
            ],
            'resourcePoolLeaderId' => '<string>',
            'resourcePoolSummary' => [
                'availableComputeCapacity' => <integer>,
                'availableStorageCapacityInTBs' => <float>,
                'isDisabled' => true || false,
                'poolSize' => <integer>,
                'poolStorageSizeInTBs' => <integer>,
                'totalComputeCapacity' => <integer>,
            ],
            'role' => 'PRIMARY|STANDBY|DISABLED_STANDBY|BACKUP_COPY|SNAPSHOT_STANDBY',
            'scheduledOperations' => [
                [
                    'dayOfWeek' => [
                        'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
                    ],
                    'scheduledStartTime' => '<string>',
                    'scheduledStopTime' => '<string>',
                ],
                // ...
            ],
            'serviceConsoleUrl' => '<string>',
            'sourceId' => '<string>',
            'sqlWebDeveloperUrl' => '<string>',
            'standbyAllowlistedIps' => ['<string>', ...],
            'standbyAllowlistedIpsSource' => 'PRIMARY|SEPARATE|NOT_APPLICABLE',
            'standbyDb' => [
                'availabilityDomain' => '<string>',
                'lagTimeInSeconds' => <integer>,
                'maintenanceTargetComponent' => '<string>',
                'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
                'statusReason' => '<string>',
                'timeDataGuardRoleChanged' => <DateTime>,
                'timeDisasterRecoveryRoleChanged' => <DateTime>,
                'timeMaintenanceBegin' => <DateTime>,
                'timeMaintenanceEnd' => <DateTime>,
            ],
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
            'statusReason' => '<string>',
            'timeDataGuardRoleChanged' => <DateTime>,
            'timeDeletionOfFreeAutonomousDatabase' => <DateTime>,
            'timeDisasterRecoveryRoleChanged' => <DateTime>,
            'timeLocalDataGuardEnabled' => <DateTime>,
            'timeMaintenanceBegin' => <DateTime>,
            'timeMaintenanceEnd' => <DateTime>,
            'timeOfAutoRefreshStart' => <DateTime>,
            'timeOfLastBackup' => <DateTime>,
            'timeOfLastFailover' => <DateTime>,
            'timeOfLastRefresh' => <DateTime>,
            'timeOfLastRefreshPoint' => <DateTime>,
            'timeOfLastSwitchover' => <DateTime>,
            'timeOfNextRefresh' => <DateTime>,
            'timeReclamationOfFreeAutonomousDatabase' => <DateTime>,
            'timeUndeleted' => <DateTime>,
            'timeUntilReconnectCloneEnabled' => <DateTime>,
            'totalBackupStorageSizeInGBs' => <float>,
            'usedDataStorageSizeInGBs' => <integer>,
            'usedDataStorageSizeInTBs' => <float>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListAutonomousDatabasePeers

$result = $client->listAutonomousDatabasePeers([/* ... */]);
$promise = $client->listAutonomousDatabasePeersAsync([/* ... */]);

Lists the peer databases of the specified Autonomous Database.

Parameter Syntax

$result = $client->listAutonomousDatabasePeers([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabasePeers' => [
        [
            'autonomousDatabaseArn' => '<string>',
            'autonomousDatabaseId' => '<string>',
            'ocid' => '<string>',
            'region' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListAutonomousDatabaseVersions

$result = $client->listAutonomousDatabaseVersions([/* ... */]);
$promise = $client->listAutonomousDatabaseVersionsAsync([/* ... */]);

Lists the available Oracle Database software versions for Autonomous Databases.

Parameter Syntax

$result = $client->listAutonomousDatabaseVersions([
    'dbWorkload' => 'OLTP|AJD|APEX|LH',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseVersions' => [
        [
            'dbWorkload' => 'OLTP|AJD|APEX|LH',
            'details' => '<string>',
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListAutonomousDatabases

$result = $client->listAutonomousDatabases([/* ... */]);
$promise = $client->listAutonomousDatabasesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listAutonomousDatabases([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabases' => [
        [
            'actualUsedDataStorageSizeInTBs' => <float>,
            'allocatedStorageSizeInTBs' => <float>,
            'allowlistedIps' => ['<string>', ...],
            'apexDetails' => [
                'apexVersion' => '<string>',
                'ordsVersion' => '<string>',
            ],
            'autoRefreshFrequencyInSeconds' => <integer>,
            'autoRefreshPointLagInSeconds' => <integer>,
            'autonomousDatabaseArn' => '<string>',
            'autonomousDatabaseId' => '<string>',
            'autonomousMaintenanceScheduleType' => 'EARLY|REGULAR',
            'availabilityZone' => '<string>',
            'availabilityZoneId' => '<string>',
            'availableUpgradeVersions' => ['<string>', ...],
            'backupRetentionPeriodInDays' => <integer>,
            'byolComputeCountLimit' => <integer>,
            'characterSet' => '<string>',
            'cloneTableSpaceList' => [<integer>, ...],
            'computeCount' => <float>,
            'computeModel' => 'ECPU|OCPU',
            'connectionStringDetails' => [
                'allConnectionStrings' => ['<string>', ...],
                'dedicated' => '<string>',
                'high' => '<string>',
                'low' => '<string>',
                'medium' => '<string>',
                'profiles' => [
                    [
                        'consumerGroup' => '<string>',
                        'displayName' => '<string>',
                        'hostFormat' => '<string>',
                        'isRegional' => true || false,
                        'protocol' => '<string>',
                        'sessionMode' => '<string>',
                        'syntaxFormat' => '<string>',
                        'tlsAuthentication' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'connectionUrls' => [
                'apexUrl' => '<string>',
                'databaseTransformsUrl' => '<string>',
                'graphStudioUrl' => '<string>',
                'machineLearningNotebookUrl' => '<string>',
                'machineLearningUserManagementUrl' => '<string>',
                'mongoDbUrl' => '<string>',
                'ordsUrl' => '<string>',
                'spatialStudioUrl' => '<string>',
                'sqlDevWebUrl' => '<string>',
            ],
            'cpuCoreCount' => <integer>,
            'createdAt' => <DateTime>,
            'customerContacts' => [
                [
                    'email' => '<string>',
                ],
                // ...
            ],
            'dataSafeStatus' => 'REGISTERING|REGISTERED|DEREGISTERING|NOT_REGISTERED|FAILED',
            'dataStorageSizeInGBs' => <integer>,
            'dataStorageSizeInTBs' => <float>,
            'databaseEdition' => 'STANDARD_EDITION|ENTERPRISE_EDITION',
            'databaseManagementStatus' => 'ENABLING|ENABLED|DISABLING|NOT_ENABLED|FAILED_ENABLING|FAILED_DISABLING',
            'databaseType' => 'REGULAR|CLONE',
            'dbName' => '<string>',
            'dbToolsDetails' => [
                [
                    'computeCount' => <float>,
                    'isEnabled' => true || false,
                    'maxIdleTimeInMinutes' => <integer>,
                    'name' => '<string>',
                ],
                // ...
            ],
            'dbVersion' => '<string>',
            'dbWorkload' => 'OLTP|AJD|APEX|LH',
            'displayName' => '<string>',
            'encryptionSummary' => [
                'encryptionKeyConfiguration' => [
                    'awsEncryptionKey' => [
                        'externalIdType' => 'database_ocid|compartment_ocid|tenant_ocid',
                        'iamRoleArn' => '<string>',
                        'kmsKeyId' => '<string>',
                    ],
                    'ociEncryptionKey' => [
                        'kmsKeyId' => '<string>',
                        'vaultId' => '<string>',
                    ],
                    'okvEncryptionKey' => [
                        'certificateDirectoryName' => '<string>',
                        'certificateId' => '<string>',
                        'directoryName' => '<string>',
                        'okvKmsKey' => '<string>',
                        'okvUri' => '<string>',
                    ],
                ],
                'encryptionKeyProvider' => 'ORACLE_MANAGED|AWS_KMS|OKV|OCI',
            ],
            'failedDataRecoveryInSeconds' => <integer>,
            'inMemoryAreaInGBs' => <integer>,
            'isAutoScalingEnabled' => true || false,
            'isAutoScalingForStorageEnabled' => true || false,
            'isBackupRetentionLocked' => true || false,
            'isLocalDataGuardEnabled' => true || false,
            'isMtlsConnectionRequired' => true || false,
            'isReconnectCloneEnabled' => true || false,
            'isRefreshableClone' => true || false,
            'isRemoteDataGuardEnabled' => true || false,
            'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
            'localAdgAutoFailoverMaxDataLossLimit' => <integer>,
            'localDisasterRecoveryType' => 'ADG|BACKUP_BASED',
            'localStandbyDb' => [
                'availabilityDomain' => '<string>',
                'lagTimeInSeconds' => <integer>,
                'maintenanceTargetComponent' => '<string>',
                'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
                'statusReason' => '<string>',
                'timeDataGuardRoleChanged' => <DateTime>,
                'timeDisasterRecoveryRoleChanged' => <DateTime>,
                'timeMaintenanceBegin' => <DateTime>,
                'timeMaintenanceEnd' => <DateTime>,
            ],
            'longTermBackupSchedule' => [
                'isDisabled' => true || false,
                'repeatCadence' => 'ONE_TIME|WEEKLY|MONTHLY|YEARLY',
                'retentionPeriodInDays' => <integer>,
                'timeOfBackup' => <DateTime>,
            ],
            'maintenanceTargetComponent' => '<string>',
            'memoryPerOracleComputeUnitInGBs' => <integer>,
            'ncharacterSet' => '<string>',
            'netServicesArchitecture' => 'DEDICATED|SHARED',
            'nextLongTermBackupTimeStamp' => <DateTime>,
            'ociResourceAnchorName' => '<string>',
            'ociUrl' => '<string>',
            'ocid' => '<string>',
            'odbNetworkArn' => '<string>',
            'odbNetworkId' => '<string>',
            'openMode' => 'READ_ONLY|READ_WRITE',
            'operationsInsightsStatus' => 'ENABLING|ENABLED|DISABLING|NOT_ENABLED|FAILED_ENABLING|FAILED_DISABLING',
            'peerDbIds' => ['<string>', ...],
            'percentProgress' => <float>,
            'permissionLevel' => 'RESTRICTED|UNRESTRICTED',
            'privateEndpoint' => '<string>',
            'privateEndpointIp' => '<string>',
            'privateEndpointLabel' => '<string>',
            'provisionableCpus' => [<integer>, ...],
            'refreshableMode' => 'AUTOMATIC|MANUAL',
            'refreshableStatus' => 'REFRESHING|NOT_REFRESHING',
            'remoteDisasterRecoveryConfiguration' => [
                'disasterRecoveryType' => 'ADG|BACKUP_BASED',
                'isReplicateAutomaticBackups' => true || false,
                'isSnapshotStandby' => true || false,
                'timeSnapshotStandbyEnabledTill' => <DateTime>,
            ],
            'resourcePoolLeaderId' => '<string>',
            'resourcePoolSummary' => [
                'availableComputeCapacity' => <integer>,
                'availableStorageCapacityInTBs' => <float>,
                'isDisabled' => true || false,
                'poolSize' => <integer>,
                'poolStorageSizeInTBs' => <integer>,
                'totalComputeCapacity' => <integer>,
            ],
            'role' => 'PRIMARY|STANDBY|DISABLED_STANDBY|BACKUP_COPY|SNAPSHOT_STANDBY',
            'scheduledOperations' => [
                [
                    'dayOfWeek' => [
                        'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
                    ],
                    'scheduledStartTime' => '<string>',
                    'scheduledStopTime' => '<string>',
                ],
                // ...
            ],
            'serviceConsoleUrl' => '<string>',
            'sourceId' => '<string>',
            'sqlWebDeveloperUrl' => '<string>',
            'standbyAllowlistedIps' => ['<string>', ...],
            'standbyAllowlistedIpsSource' => 'PRIMARY|SEPARATE|NOT_APPLICABLE',
            'standbyDb' => [
                'availabilityDomain' => '<string>',
                'lagTimeInSeconds' => <integer>,
                'maintenanceTargetComponent' => '<string>',
                'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
                'statusReason' => '<string>',
                'timeDataGuardRoleChanged' => <DateTime>,
                'timeDisasterRecoveryRoleChanged' => <DateTime>,
                'timeMaintenanceBegin' => <DateTime>,
                'timeMaintenanceEnd' => <DateTime>,
            ],
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
            'statusReason' => '<string>',
            'timeDataGuardRoleChanged' => <DateTime>,
            'timeDeletionOfFreeAutonomousDatabase' => <DateTime>,
            'timeDisasterRecoveryRoleChanged' => <DateTime>,
            'timeLocalDataGuardEnabled' => <DateTime>,
            'timeMaintenanceBegin' => <DateTime>,
            'timeMaintenanceEnd' => <DateTime>,
            'timeOfAutoRefreshStart' => <DateTime>,
            'timeOfLastBackup' => <DateTime>,
            'timeOfLastFailover' => <DateTime>,
            'timeOfLastRefresh' => <DateTime>,
            'timeOfLastRefreshPoint' => <DateTime>,
            'timeOfLastSwitchover' => <DateTime>,
            'timeOfNextRefresh' => <DateTime>,
            'timeReclamationOfFreeAutonomousDatabase' => <DateTime>,
            'timeUndeleted' => <DateTime>,
            'timeUntilReconnectCloneEnabled' => <DateTime>,
            'totalBackupStorageSizeInGBs' => <float>,
            'usedDataStorageSizeInGBs' => <integer>,
            'usedDataStorageSizeInTBs' => <float>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListAutonomousVirtualMachines

$result = $client->listAutonomousVirtualMachines([/* ... */]);
$promise = $client->listAutonomousVirtualMachinesAsync([/* ... */]);

Lists all Autonomous VMs in an Autonomous VM cluster.

Parameter Syntax

$result = $client->listAutonomousVirtualMachines([
    'cloudAutonomousVmClusterId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousVirtualMachines' => [
        [
            'autonomousVirtualMachineId' => '<string>',
            'clientIpAddress' => '<string>',
            'cloudAutonomousVmClusterId' => '<string>',
            'cpuCoreCount' => <integer>,
            'dbNodeStorageSizeInGBs' => <integer>,
            'dbServerDisplayName' => '<string>',
            'dbServerId' => '<string>',
            'memorySizeInGBs' => <integer>,
            'ociResourceAnchorName' => '<string>',
            'ocid' => '<string>',
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
            'statusReason' => '<string>',
            'vmName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListCloudAutonomousVmClusters

$result = $client->listCloudAutonomousVmClusters([/* ... */]);
$promise = $client->listCloudAutonomousVmClustersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCloudAutonomousVmClusters([
    'cloudExadataInfrastructureId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'cloudAutonomousVmClusters' => [
        [
            'autonomousDataStoragePercentage' => <float>,
            'autonomousDataStorageSizeInTBs' => <float>,
            'availableAutonomousDataStorageSizeInTBs' => <float>,
            'availableContainerDatabases' => <integer>,
            'availableCpus' => <float>,
            'cloudAutonomousVmClusterArn' => '<string>',
            'cloudAutonomousVmClusterId' => '<string>',
            'cloudExadataInfrastructureArn' => '<string>',
            'cloudExadataInfrastructureId' => '<string>',
            'computeModel' => 'ECPU|OCPU',
            'cpuCoreCount' => <integer>,
            'cpuCoreCountPerNode' => <integer>,
            'cpuPercentage' => <float>,
            'createdAt' => <DateTime>,
            'dataStorageSizeInGBs' => <float>,
            'dataStorageSizeInTBs' => <float>,
            'dbNodeStorageSizeInGBs' => <integer>,
            'dbServers' => ['<string>', ...],
            'description' => '<string>',
            'displayName' => '<string>',
            'domain' => '<string>',
            'exadataStorageInTBsLowestScaledValue' => <float>,
            'hostname' => '<string>',
            'iamRoles' => [
                [
                    'awsIntegration' => 'KmsTde',
                    'iamRoleArn' => '<string>',
                    'status' => 'ASSOCIATING|DISASSOCIATING|FAILED|CONNECTED|DISCONNECTED|PARTIALLY_CONNECTED|UNKNOWN',
                    'statusReason' => '<string>',
                ],
                // ...
            ],
            'isMtlsEnabledVmCluster' => true || false,
            'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
            'maintenanceWindow' => [
                'customActionTimeoutInMins' => <integer>,
                'daysOfWeek' => [
                    [
                        'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
                    ],
                    // ...
                ],
                'hoursOfDay' => [<integer>, ...],
                'isCustomActionTimeoutEnabled' => true || false,
                'leadTimeInWeeks' => <integer>,
                'months' => [
                    [
                        'name' => 'JANUARY|FEBRUARY|MARCH|APRIL|MAY|JUNE|JULY|AUGUST|SEPTEMBER|OCTOBER|NOVEMBER|DECEMBER',
                    ],
                    // ...
                ],
                'patchingMode' => 'ROLLING|NONROLLING',
                'preference' => 'NO_PREFERENCE|CUSTOM_PREFERENCE',
                'skipRu' => true || false,
                'weeksOfMonth' => [<integer>, ...],
            ],
            'maxAcdsLowestScaledValue' => <integer>,
            'memoryPerOracleComputeUnitInGBs' => <integer>,
            'memorySizeInGBs' => <integer>,
            'nodeCount' => <integer>,
            'nonProvisionableAutonomousContainerDatabases' => <integer>,
            'ociResourceAnchorName' => '<string>',
            'ociUrl' => '<string>',
            'ocid' => '<string>',
            'odbNetworkArn' => '<string>',
            'odbNetworkId' => '<string>',
            'percentProgress' => <float>,
            'provisionableAutonomousContainerDatabases' => <integer>,
            'provisionedAutonomousContainerDatabases' => <integer>,
            'provisionedCpus' => <float>,
            'reclaimableCpus' => <float>,
            'reservedCpus' => <float>,
            'scanListenerPortNonTls' => <integer>,
            'scanListenerPortTls' => <integer>,
            'shape' => '<string>',
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
            'statusReason' => '<string>',
            'timeDatabaseSslCertificateExpires' => <DateTime>,
            'timeOrdsCertificateExpires' => <DateTime>,
            'timeZone' => '<string>',
            'totalContainerDatabases' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListCloudExadataInfrastructures

$result = $client->listCloudExadataInfrastructures([/* ... */]);
$promise = $client->listCloudExadataInfrastructuresAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCloudExadataInfrastructures([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'cloudExadataInfrastructures' => [
        [
            'activatedStorageCount' => <integer>,
            'additionalStorageCount' => <integer>,
            'availabilityZone' => '<string>',
            'availabilityZoneId' => '<string>',
            'availableStorageSizeInGBs' => <integer>,
            'cloudExadataInfrastructureArn' => '<string>',
            'cloudExadataInfrastructureId' => '<string>',
            'computeCount' => <integer>,
            'computeModel' => 'ECPU|OCPU',
            'cpuCount' => <integer>,
            'createdAt' => <DateTime>,
            'customerContactsToSendToOCI' => [
                [
                    'email' => '<string>',
                ],
                // ...
            ],
            'dataStorageSizeInTBs' => <float>,
            'databaseServerType' => '<string>',
            'dbNodeStorageSizeInGBs' => <integer>,
            'dbServerVersion' => '<string>',
            'displayName' => '<string>',
            'lastMaintenanceRunId' => '<string>',
            'maintenanceWindow' => [
                'customActionTimeoutInMins' => <integer>,
                'daysOfWeek' => [
                    [
                        'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
                    ],
                    // ...
                ],
                'hoursOfDay' => [<integer>, ...],
                'isCustomActionTimeoutEnabled' => true || false,
                'leadTimeInWeeks' => <integer>,
                'months' => [
                    [
                        'name' => 'JANUARY|FEBRUARY|MARCH|APRIL|MAY|JUNE|JULY|AUGUST|SEPTEMBER|OCTOBER|NOVEMBER|DECEMBER',
                    ],
                    // ...
                ],
                'patchingMode' => 'ROLLING|NONROLLING',
                'preference' => 'NO_PREFERENCE|CUSTOM_PREFERENCE',
                'skipRu' => true || false,
                'weeksOfMonth' => [<integer>, ...],
            ],
            'maxCpuCount' => <integer>,
            'maxDataStorageInTBs' => <float>,
            'maxDbNodeStorageSizeInGBs' => <integer>,
            'maxMemoryInGBs' => <integer>,
            'memorySizeInGBs' => <integer>,
            'monthlyDbServerVersion' => '<string>',
            'monthlyStorageServerVersion' => '<string>',
            'nextMaintenanceRunId' => '<string>',
            'ociResourceAnchorName' => '<string>',
            'ociUrl' => '<string>',
            'ocid' => '<string>',
            'percentProgress' => <float>,
            'shape' => '<string>',
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
            'statusReason' => '<string>',
            'storageCount' => <integer>,
            'storageServerType' => '<string>',
            'storageServerVersion' => '<string>',
            'totalStorageSizeInGBs' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListCloudVmClusters

$result = $client->listCloudVmClusters([/* ... */]);
$promise = $client->listCloudVmClustersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCloudVmClusters([
    'cloudExadataInfrastructureId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'cloudVmClusters' => [
        [
            'cloudExadataInfrastructureArn' => '<string>',
            'cloudExadataInfrastructureId' => '<string>',
            'cloudVmClusterArn' => '<string>',
            'cloudVmClusterId' => '<string>',
            'clusterName' => '<string>',
            'computeModel' => 'ECPU|OCPU',
            'cpuCoreCount' => <integer>,
            'createdAt' => <DateTime>,
            'dataCollectionOptions' => [
                'isDiagnosticsEventsEnabled' => true || false,
                'isHealthMonitoringEnabled' => true || false,
                'isIncidentLogsEnabled' => true || false,
            ],
            'dataStorageSizeInTBs' => <float>,
            'dbNodeStorageSizeInGBs' => <integer>,
            'dbServers' => ['<string>', ...],
            'diskRedundancy' => 'HIGH|NORMAL',
            'displayName' => '<string>',
            'domain' => '<string>',
            'giVersion' => '<string>',
            'hostname' => '<string>',
            'iamRoles' => [
                [
                    'awsIntegration' => 'KmsTde',
                    'iamRoleArn' => '<string>',
                    'status' => 'ASSOCIATING|DISASSOCIATING|FAILED|CONNECTED|DISCONNECTED|PARTIALLY_CONNECTED|UNKNOWN',
                    'statusReason' => '<string>',
                ],
                // ...
            ],
            'iormConfigCache' => [
                'dbPlans' => [
                    [
                        'dbName' => '<string>',
                        'flashCacheLimit' => '<string>',
                        'share' => <integer>,
                    ],
                    // ...
                ],
                'lifecycleDetails' => '<string>',
                'lifecycleState' => 'BOOTSTRAPPING|DISABLED|ENABLED|FAILED|UPDATING',
                'objective' => 'AUTO|BALANCED|BASIC|HIGH_THROUGHPUT|LOW_LATENCY',
            ],
            'isLocalBackupEnabled' => true || false,
            'isSparseDiskgroupEnabled' => true || false,
            'lastUpdateHistoryEntryId' => '<string>',
            'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
            'listenerPort' => <integer>,
            'memorySizeInGBs' => <integer>,
            'nodeCount' => <integer>,
            'ociResourceAnchorName' => '<string>',
            'ociUrl' => '<string>',
            'ocid' => '<string>',
            'odbNetworkArn' => '<string>',
            'odbNetworkId' => '<string>',
            'percentProgress' => <float>,
            'scanDnsName' => '<string>',
            'scanDnsRecordId' => '<string>',
            'scanIpIds' => ['<string>', ...],
            'shape' => '<string>',
            'sshPublicKeys' => ['<string>', ...],
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
            'statusReason' => '<string>',
            'storageSizeInGBs' => <integer>,
            'systemVersion' => '<string>',
            'timeZone' => '<string>',
            'vipIds' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListDbNodes

$result = $client->listDbNodes([/* ... */]);
$promise = $client->listDbNodesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDbNodes([
    'cloudVmClusterId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dbNodes' => [
        [
            'additionalDetails' => '<string>',
            'backupIpId' => '<string>',
            'backupVnic2Id' => '<string>',
            'backupVnicId' => '<string>',
            'cpuCoreCount' => <integer>,
            'createdAt' => <DateTime>,
            'dbNodeArn' => '<string>',
            'dbNodeId' => '<string>',
            'dbNodeStorageSizeInGBs' => <integer>,
            'dbServerId' => '<string>',
            'dbSystemId' => '<string>',
            'faultDomain' => '<string>',
            'hostIpId' => '<string>',
            'hostname' => '<string>',
            'maintenanceType' => 'VMDB_REBOOT_MIGRATION',
            'memorySizeInGBs' => <integer>,
            'ociResourceAnchorName' => '<string>',
            'ocid' => '<string>',
            'softwareStorageSizeInGB' => <integer>,
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|STOPPING|STOPPED|STARTING',
            'statusReason' => '<string>',
            'timeMaintenanceWindowEnd' => '<string>',
            'timeMaintenanceWindowStart' => '<string>',
            'totalCpuCoreCount' => <integer>,
            'vnic2Id' => '<string>',
            'vnicId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListDbServers

$result = $client->listDbServers([/* ... */]);
$promise = $client->listDbServersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDbServers([
    'cloudExadataInfrastructureId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dbServers' => [
        [
            'autonomousVirtualMachineIds' => ['<string>', ...],
            'autonomousVmClusterIds' => ['<string>', ...],
            'computeModel' => 'ECPU|OCPU',
            'cpuCoreCount' => <integer>,
            'createdAt' => <DateTime>,
            'dbNodeStorageSizeInGBs' => <integer>,
            'dbServerId' => '<string>',
            'dbServerPatchingDetails' => [
                'estimatedPatchDuration' => <integer>,
                'patchingStatus' => 'COMPLETE|FAILED|MAINTENANCE_IN_PROGRESS|SCHEDULED',
                'timePatchingEnded' => '<string>',
                'timePatchingStarted' => '<string>',
            ],
            'displayName' => '<string>',
            'exadataInfrastructureId' => '<string>',
            'maxCpuCount' => <integer>,
            'maxDbNodeStorageInGBs' => <integer>,
            'maxMemoryInGBs' => <integer>,
            'memorySizeInGBs' => <integer>,
            'ociResourceAnchorName' => '<string>',
            'ocid' => '<string>',
            'shape' => '<string>',
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
            'statusReason' => '<string>',
            'vmClusterIds' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListDbSystemShapes

$result = $client->listDbSystemShapes([/* ... */]);
$promise = $client->listDbSystemShapesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listDbSystemShapes([
    'availabilityZone' => '<string>',
    'availabilityZoneId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'dbSystemShapes' => [
        [
            'areServerTypesSupported' => true || false,
            'availableCoreCount' => <integer>,
            'availableCoreCountPerNode' => <integer>,
            'availableDataStorageInTBs' => <integer>,
            'availableDataStoragePerServerInTBs' => <integer>,
            'availableDbNodePerNodeInGBs' => <integer>,
            'availableDbNodeStorageInGBs' => <integer>,
            'availableMemoryInGBs' => <integer>,
            'availableMemoryPerNodeInGBs' => <integer>,
            'computeModel' => 'ECPU|OCPU',
            'coreCountIncrement' => <integer>,
            'maxStorageCount' => <integer>,
            'maximumNodeCount' => <integer>,
            'minCoreCountPerNode' => <integer>,
            'minDataStorageInTBs' => <integer>,
            'minDbNodeStoragePerNodeInGBs' => <integer>,
            'minMemoryPerNodeInGBs' => <integer>,
            'minStorageCount' => <integer>,
            'minimumCoreCount' => <integer>,
            'minimumNodeCount' => <integer>,
            'name' => '<string>',
            'runtimeMinimumCoreCount' => <integer>,
            'shapeFamily' => '<string>',
            'shapeType' => 'AMD|INTEL|INTEL_FLEX_X9|AMPERE_FLEX_A1',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListGiVersions

$result = $client->listGiVersions([/* ... */]);
$promise = $client->listGiVersionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listGiVersions([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'shape' => '<string>',
]);

Parameter Details

Result Syntax

[
    'giVersions' => [
        [
            'version' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListOdbNetworks

$result = $client->listOdbNetworks([/* ... */]);
$promise = $client->listOdbNetworksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listOdbNetworks([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'odbNetworks' => [
        [
            'availabilityZone' => '<string>',
            'availabilityZoneId' => '<string>',
            'backupSubnetCidr' => '<string>',
            'clientSubnetCidr' => '<string>',
            'createdAt' => <DateTime>,
            'customDomainName' => '<string>',
            'defaultDnsPrefix' => '<string>',
            'displayName' => '<string>',
            'ec2PlacementGroupIds' => ['<string>', ...],
            'managedServices' => [
                'crossRegionS3RestoreSourcesAccess' => [
                    [
                        'ipv4Addresses' => ['<string>', ...],
                        'region' => '<string>',
                        'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                    ],
                    // ...
                ],
                'kmsAccess' => [
                    'domainName' => '<string>',
                    'ipv4Addresses' => ['<string>', ...],
                    'kmsPolicyDocument' => '<string>',
                    'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                ],
                'managedS3BackupAccess' => [
                    'ipv4Addresses' => ['<string>', ...],
                    'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                ],
                'managedServicesIpv4Cidrs' => ['<string>', ...],
                'resourceGatewayArn' => '<string>',
                's3Access' => [
                    'domainName' => '<string>',
                    'ipv4Addresses' => ['<string>', ...],
                    's3PolicyDocument' => '<string>',
                    'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                ],
                'serviceNetworkArn' => '<string>',
                'serviceNetworkEndpoint' => [
                    'vpcEndpointId' => '<string>',
                    'vpcEndpointType' => 'SERVICENETWORK',
                ],
                'stsAccess' => [
                    'domainName' => '<string>',
                    'ipv4Addresses' => ['<string>', ...],
                    'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                    'stsPolicyDocument' => '<string>',
                ],
                'zeroEtlAccess' => [
                    'cidr' => '<string>',
                    'status' => 'ENABLED|ENABLING|DISABLED|DISABLING',
                ],
            ],
            'ociDnsForwardingConfigs' => [
                [
                    'domainName' => '<string>',
                    'ociDnsListenerIp' => '<string>',
                ],
                // ...
            ],
            'ociNetworkAnchorId' => '<string>',
            'ociNetworkAnchorUrl' => '<string>',
            'ociResourceAnchorName' => '<string>',
            'ociVcnId' => '<string>',
            'ociVcnUrl' => '<string>',
            'odbNetworkArn' => '<string>',
            'odbNetworkId' => '<string>',
            'peeredCidrs' => ['<string>', ...],
            'percentProgress' => <float>,
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
            'statusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ListOdbPeeringConnections

$result = $client->listOdbPeeringConnections([/* ... */]);
$promise = $client->listOdbPeeringConnectionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listOdbPeeringConnections([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'odbNetworkId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'odbPeeringConnections' => [
        [
            'createdAt' => <DateTime>,
            'displayName' => '<string>',
            'odbNetworkArn' => '<string>',
            'odbPeeringConnectionArn' => '<string>',
            'odbPeeringConnectionId' => '<string>',
            'odbPeeringConnectionType' => '<string>',
            'peerNetworkArn' => '<string>',
            'peerNetworkCidrs' => ['<string>', ...],
            'percentProgress' => <float>,
            'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS',
            'statusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListSystemVersions

$result = $client->listSystemVersions([/* ... */]);
$promise = $client->listSystemVersionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listSystemVersions([
    'giVersion' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'shape' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'systemVersions' => [
        [
            'giVersion' => '<string>',
            'shape' => '<string>',
            'systemVersions' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns information about the tags applied to this resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

RebootAutonomousDatabase

$result = $client->rebootAutonomousDatabase([/* ... */]);
$promise = $client->rebootAutonomousDatabaseAsync([/* ... */]);

Reboots the specified Autonomous Database.

Parameter Syntax

$result = $client->rebootAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'isOnlineReboot' => true || false,
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

RebootDbNode

$result = $client->rebootDbNode([/* ... */]);
$promise = $client->rebootDbNodeAsync([/* ... */]);

Reboots the specified DB node in a VM cluster.

Parameter Syntax

$result = $client->rebootDbNode([
    'cloudVmClusterId' => '<string>', // REQUIRED
    'dbNodeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dbNodeId' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|STOPPING|STOPPED|STARTING',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

RestoreAutonomousDatabase

$result = $client->restoreAutonomousDatabase([/* ... */]);
$promise = $client->restoreAutonomousDatabaseAsync([/* ... */]);

Restores the specified Autonomous Database to a point in time.

Parameter Syntax

$result = $client->restoreAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'timestamp' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

ShrinkAutonomousDatabase

$result = $client->shrinkAutonomousDatabase([/* ... */]);
$promise = $client->shrinkAutonomousDatabaseAsync([/* ... */]);

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

Parameter Syntax

$result = $client->shrinkAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

StartAutonomousDatabase

$result = $client->startAutonomousDatabase([/* ... */]);
$promise = $client->startAutonomousDatabaseAsync([/* ... */]);

Starts the specified Autonomous Database.

Parameter Syntax

$result = $client->startAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

StartDbNode

$result = $client->startDbNode([/* ... */]);
$promise = $client->startDbNodeAsync([/* ... */]);

Starts the specified DB node in a VM cluster.

Parameter Syntax

$result = $client->startDbNode([
    'cloudVmClusterId' => '<string>', // REQUIRED
    'dbNodeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dbNodeId' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|STOPPING|STOPPED|STARTING',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

StopAutonomousDatabase

$result = $client->stopAutonomousDatabase([/* ... */]);
$promise = $client->stopAutonomousDatabaseAsync([/* ... */]);

Stops the specified Autonomous Database.

Parameter Syntax

$result = $client->stopAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

StopDbNode

$result = $client->stopDbNode([/* ... */]);
$promise = $client->stopDbNodeAsync([/* ... */]);

Stops the specified DB node in a VM cluster.

Parameter Syntax

$result = $client->stopDbNode([
    'cloudVmClusterId' => '<string>', // REQUIRED
    'dbNodeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'dbNodeId' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|STOPPING|STOPPED|STARTING',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

SwitchoverAutonomousDatabase

$result = $client->switchoverAutonomousDatabase([/* ... */]);
$promise = $client->switchoverAutonomousDatabaseAsync([/* ... */]);

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

Parameter Syntax

$result = $client->switchoverAutonomousDatabase([
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'peerDbArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'autonomousDatabaseId' => '<string>',
    'displayName' => '<string>',
    'status' => 'AVAILABLE|FAILED|PROVISIONING|TERMINATED|TERMINATING|UPDATING|MAINTENANCE_IN_PROGRESS|STOPPING|STOPPED|STARTING|UNAVAILABLE|RESTORE_IN_PROGRESS|RESTORE_FAILED|BACKUP_IN_PROGRESS|SCALE_IN_PROGRESS|AVAILABLE_NEEDS_ATTENTION|RESTARTING|RECREATING|ROLE_CHANGE_IN_PROGRESS|UPGRADING|INACCESSIBLE|STANDBY',
    'statusReason' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

The request has failed validation because it is missing required fields or has invalid inputs.

ConflictException:

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

AccessDeniedException:

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

InternalServerException:

Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Applies tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceQuotaExceededException:

You have exceeded the service quota.

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

UpdateAutonomousDatabase

$result = $client->updateAutonomousDatabase([/* ... */]);
$promise = $client->updateAutonomousDatabaseAsync([/* ... */]);

Updates the properties of an Autonomous Database.

Parameter Syntax

$result = $client->updateAutonomousDatabase([
    'adminPassword' => '<string>',
    'allowlistedIps' => ['<string>', ...],
    'autoRefreshFrequencyInSeconds' => <integer>,
    'autoRefreshPointLagInSeconds' => <integer>,
    'autonomousDatabaseId' => '<string>', // REQUIRED
    'autonomousMaintenanceScheduleType' => 'EARLY|REGULAR',
    'backupRetentionPeriodInDays' => <integer>,
    'byolComputeCountLimit' => <float>,
    'computeCount' => <float>,
    'cpuCoreCount' => <integer>,
    'customerContactsToSendToOCI' => [
        [
            'email' => '<string>',
        ],
        // ...
    ],
    'dataStorageSizeInGBs' => <integer>,
    'dataStorageSizeInTBs' => <integer>,
    'databaseEdition' => 'STANDARD_EDITION|ENTERPRISE_EDITION',
    'dbName' => '<string>',
    'dbToolsDetails' => [
        [
            'computeCount' => <float>,
            'isEnabled' => true || false,
            'maxIdleTimeInMinutes' => <integer>,
            'name' => '<string>',
        ],
        // ...
    ],
    'dbVersion' => '<string>',
    'dbWorkload' => 'OLTP|AJD|APEX|LH',
    'displayName' => '<string>',
    'encryptionKeyConfiguration' => [
        'awsEncryptionKey' => [
            'externalIdType' => 'database_ocid|compartment_ocid|tenant_ocid',
            'iamRoleArn' => '<string>',
            'kmsKeyId' => '<string>',
        ],
    ],
    'encryptionKeyProvider' => 'ORACLE_MANAGED|AWS_KMS',
    'isAutoScalingEnabled' => true || false,
    'isAutoScalingForStorageEnabled' => true || false,
    'isBackupRetentionLocked' => true || false,
    'isDisconnectPeer' => true || false,
    'isLocalDataGuardEnabled' => true || false,
    'isMtlsConnectionRequired' => true || false,
    'isRefreshableClone' => true || false,
    'licenseModel' => 'BRING_YOUR_OWN_LICENSE|LICENSE_INCLUDED',
    'localAdgAutoFailoverMaxDataLossLimit' => <integer>,
    'longTermBackupSchedule' => [
        'isDisabled' => true || false,
        'repeatCadence' => 'ONE_TIME|WEEKLY|MONTHLY|YEARLY',
        'retentionPeriodInDays' => <integer>,
        'timeOfBackup' => <integer || string || DateTime>,
    ],
    'openMode' => 'READ_ONLY|READ_WRITE',
    'peerDbId' => '<string>',
    'permissionLevel' => 'RESTRICTED|UNRESTRICTED',
    'privateEndpointIp' => '<string>',
    'privateEndpointLabel' => '<string>',
    'refreshableMode' => 'AUTOMATIC|MANUAL',
    'resourcePoolLeaderId' => '<string>',
    'resourcePoolSummary' => [
        'availableComputeCapacity' => <integer>,
        'availableStorageCapacityInTBs' => <float>,
        'isDisabled' => true || false,
        'poolSize' => <integer>,
        'poolStorageSizeInTBs' => <integer>,
        'totalComputeCapacity' => <integer>,
    ],
    'scheduledOperations' => [
        [
            'dayOfWeek' => [ // REQUIRED
                'name' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
            ],
            'scheduledStartTime' => '<string>',
            'scheduledStopTime' => '<string>',
        ],
        // ...
    ],
    'standbyAllowlistedIps' => ['<string>', ...],
    'standbyAllowlistedIpsSource' => 'PRIMARY|SEPARATE|NOT_APPLICABLE',
    'timeOfAutoRefreshStart' => <integer || string || DateTime>,
]);

Parameter Details