# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [AcceptMarketplaceRegistration](API_AcceptMarketplaceRegistration.md) 
+  [AssociateIamRoleToResource](API_AssociateIamRoleToResource.md) 
+  [CreateCloudAutonomousVmCluster](API_CreateCloudAutonomousVmCluster.md) 
+  [CreateCloudExadataInfrastructure](API_CreateCloudExadataInfrastructure.md) 
+  [CreateCloudVmCluster](API_CreateCloudVmCluster.md) 
+  [CreateOdbNetwork](API_CreateOdbNetwork.md) 
+  [CreateOdbPeeringConnection](API_CreateOdbPeeringConnection.md) 
+  [DeleteCloudAutonomousVmCluster](API_DeleteCloudAutonomousVmCluster.md) 
+  [DeleteCloudExadataInfrastructure](API_DeleteCloudExadataInfrastructure.md) 
+  [DeleteCloudVmCluster](API_DeleteCloudVmCluster.md) 
+  [DeleteOdbNetwork](API_DeleteOdbNetwork.md) 
+  [DeleteOdbPeeringConnection](API_DeleteOdbPeeringConnection.md) 
+  [DisassociateIamRoleFromResource](API_DisassociateIamRoleFromResource.md) 
+  [GetCloudAutonomousVmCluster](API_GetCloudAutonomousVmCluster.md) 
+  [GetCloudExadataInfrastructure](API_GetCloudExadataInfrastructure.md) 
+  [GetCloudExadataInfrastructureUnallocatedResources](API_GetCloudExadataInfrastructureUnallocatedResources.md) 
+  [GetCloudVmCluster](API_GetCloudVmCluster.md) 
+  [GetDbNode](API_GetDbNode.md) 
+  [GetDbServer](API_GetDbServer.md) 
+  [GetOciOnboardingStatus](API_GetOciOnboardingStatus.md) 
+  [GetOdbNetwork](API_GetOdbNetwork.md) 
+  [GetOdbPeeringConnection](API_GetOdbPeeringConnection.md) 
+  [InitializeService](API_InitializeService.md) 
+  [ListAutonomousVirtualMachines](API_ListAutonomousVirtualMachines.md) 
+  [ListCloudAutonomousVmClusters](API_ListCloudAutonomousVmClusters.md) 
+  [ListCloudExadataInfrastructures](API_ListCloudExadataInfrastructures.md) 
+  [ListCloudVmClusters](API_ListCloudVmClusters.md) 
+  [ListDbNodes](API_ListDbNodes.md) 
+  [ListDbServers](API_ListDbServers.md) 
+  [ListDbSystemShapes](API_ListDbSystemShapes.md) 
+  [ListGiVersions](API_ListGiVersions.md) 
+  [ListOdbNetworks](API_ListOdbNetworks.md) 
+  [ListOdbPeeringConnections](API_ListOdbPeeringConnections.md) 
+  [ListSystemVersions](API_ListSystemVersions.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [RebootDbNode](API_RebootDbNode.md) 
+  [StartDbNode](API_StartDbNode.md) 
+  [StopDbNode](API_StopDbNode.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateCloudExadataInfrastructure](API_UpdateCloudExadataInfrastructure.md) 
+  [UpdateOdbNetwork](API_UpdateOdbNetwork.md) 
+  [UpdateOdbPeeringConnection](API_UpdateOdbPeeringConnection.md) 

# AcceptMarketplaceRegistration
<a name="API_AcceptMarketplaceRegistration"></a>

Registers the AWS Marketplace token for your AWS account to activate your Oracle Database@AWS subscription.

## Request Syntax
<a name="API_AcceptMarketplaceRegistration_RequestSyntax"></a>

```
{
   "marketplaceRegistrationToken": "string"
}
```

## Request Parameters
<a name="API_AcceptMarketplaceRegistration_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [marketplaceRegistrationToken](#API_AcceptMarketplaceRegistration_RequestSyntax) **   <a name="odb-AcceptMarketplaceRegistration-request-marketplaceRegistrationToken"></a>
The registration token that's generated by AWS Marketplace and sent to Oracle Database@AWS.  
Type: String  
Required: Yes

## Response Elements
<a name="API_AcceptMarketplaceRegistration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AcceptMarketplaceRegistration_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_AcceptMarketplaceRegistration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/AcceptMarketplaceRegistration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/AcceptMarketplaceRegistration) 

# AssociateIamRoleToResource
<a name="API_AssociateIamRoleToResource"></a>

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

## Request Syntax
<a name="API_AssociateIamRoleToResource_RequestSyntax"></a>

```
{
   "awsIntegration": "string",
   "iamRoleArn": "string",
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_AssociateIamRoleToResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [awsIntegration](#API_AssociateIamRoleToResource_RequestSyntax) **   <a name="odb-AssociateIamRoleToResource-request-awsIntegration"></a>
The AWS integration configuration settings for the AWS Identity and Access Management (IAM) service role association.  
Type: String  
Valid Values: `KmsTde`   
Required: Yes

 ** [iamRoleArn](#API_AssociateIamRoleToResource_RequestSyntax) **   <a name="odb-AssociateIamRoleToResource-request-iamRoleArn"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to associate with the resource.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{12}:role/.+`   
Required: Yes

 ** [resourceArn](#API_AssociateIamRoleToResource_RequestSyntax) **   <a name="odb-AssociateIamRoleToResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the target resource to associate with the AWS Identity and Access Management (IAM) service role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-[a-z]?|aws-iso):odb:[a-z0-9-]+:\d{12}:(?:cloud-vm-cluster|cloud-autonomous-vm-cluster)/[a-z0-9-_]+`   
Required: Yes

## Response Elements
<a name="API_AssociateIamRoleToResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateIamRoleToResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_AssociateIamRoleToResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/AssociateIamRoleToResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/AssociateIamRoleToResource) 

# CreateCloudAutonomousVmCluster
<a name="API_CreateCloudAutonomousVmCluster"></a>

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

## Request Syntax
<a name="API_CreateCloudAutonomousVmCluster_RequestSyntax"></a>

```
{
   "autonomousDataStorageSizeInTBs": number,
   "clientToken": "string",
   "cloudExadataInfrastructureId": "string",
   "cpuCoreCountPerNode": number,
   "dbServers": [ "string" ],
   "description": "string",
   "displayName": "string",
   "isMtlsEnabledVmCluster": boolean,
   "licenseModel": "string",
   "maintenanceWindow": { 
      "customActionTimeoutInMins": number,
      "daysOfWeek": [ 
         { 
            "name": "string"
         }
      ],
      "hoursOfDay": [ number ],
      "isCustomActionTimeoutEnabled": boolean,
      "leadTimeInWeeks": number,
      "months": [ 
         { 
            "name": "string"
         }
      ],
      "patchingMode": "string",
      "preference": "string",
      "skipRu": boolean,
      "weeksOfMonth": [ number ]
   },
   "memoryPerOracleComputeUnitInGBs": number,
   "odbNetworkId": "string",
   "scanListenerPortNonTls": number,
   "scanListenerPortTls": number,
   "tags": { 
      "string" : "string" 
   },
   "timeZone": "string",
   "totalContainerDatabases": number
}
```

## Request Parameters
<a name="API_CreateCloudAutonomousVmCluster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [autonomousDataStorageSizeInTBs](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-autonomousDataStorageSizeInTBs"></a>
The data disk group size to be allocated for Autonomous Databases, in terabytes (TB).  
Type: Double  
Valid Range: Minimum value of 0.  
Required: Yes

 ** [clientToken](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-clientToken"></a>
A client-provided token to ensure idempotency of the request.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: No

 ** [cloudExadataInfrastructureId](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Exadata infrastructure where the VM cluster will be created.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [cpuCoreCountPerNode](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-cpuCoreCountPerNode"></a>
The number of CPU cores to be enabled per VM cluster node.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** [dbServers](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-dbServers"></a>
The list of database servers to be used for the Autonomous VM cluster.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

 ** [description](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-description"></a>
A user-provided description of the Autonomous VM cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 400.  
Required: No

 ** [displayName](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-displayName"></a>
The display name for the Autonomous VM cluster. The name does not need to be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*`   
Required: Yes

 ** [isMtlsEnabledVmCluster](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-isMtlsEnabledVmCluster"></a>
Specifies whether to enable mutual TLS (mTLS) authentication for the Autonomous VM cluster.  
Type: Boolean  
Required: No

 ** [licenseModel](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-licenseModel"></a>
The Oracle license model to apply to the Autonomous VM cluster.  
Type: String  
Valid Values: `BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED`   
Required: No

 ** [maintenanceWindow](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-maintenanceWindow"></a>
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.  
Type: [MaintenanceWindow](API_MaintenanceWindow.md) object  
Required: No

 ** [memoryPerOracleComputeUnitInGBs](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-memoryPerOracleComputeUnitInGBs"></a>
The amount of memory to be allocated per OCPU, in GB.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** [odbNetworkId](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-odbNetworkId"></a>
The unique identifier of the ODB network to be used for the VM cluster.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [scanListenerPortNonTls](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-scanListenerPortNonTls"></a>
The SCAN listener port for non-TLS (TCP) protocol.  
Type: Integer  
Valid Range: Minimum value of 1024. Maximum value of 8999.  
Required: No

 ** [scanListenerPortTls](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-scanListenerPortTls"></a>
The SCAN listener port for TLS (TCP) protocol.  
Type: Integer  
Valid Range: Minimum value of 1024. Maximum value of 8999.  
Required: No

 ** [tags](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-tags"></a>
Free-form tags for this resource. Each tag is a key-value pair with no predefined name, type, or namespace.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [timeZone](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-timeZone"></a>
The time zone to use for the Autonomous VM cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [totalContainerDatabases](#API_CreateCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-request-totalContainerDatabases"></a>
The total number of Autonomous CDBs that you can create in the Autonomous VM cluster.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

## Response Syntax
<a name="API_CreateCloudAutonomousVmCluster_ResponseSyntax"></a>

```
{
   "cloudAutonomousVmClusterId": "string",
   "displayName": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_CreateCloudAutonomousVmCluster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudAutonomousVmClusterId](#API_CreateCloudAutonomousVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-response-cloudAutonomousVmClusterId"></a>
The unique identifier of the created Autonomous VM cluster.  
Type: String

 ** [displayName](#API_CreateCloudAutonomousVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-response-displayName"></a>
The display name of the created Autonomous VM cluster.  
Type: String

 ** [status](#API_CreateCloudAutonomousVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-response-status"></a>
The current status of the Autonomous VM cluster creation process.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_CreateCloudAutonomousVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudAutonomousVmCluster-response-statusReason"></a>
Additional information about the current status of the Autonomous VM cluster creation process, if applicable.  
Type: String

## Errors
<a name="API_CreateCloudAutonomousVmCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
You have exceeded the service quota.    
 ** quotaCode **   
The unqiue identifier of the service quota that was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded the service quota.  
 ** resourceType **   
The type of resource that exceeded the service quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateCloudAutonomousVmCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/CreateCloudAutonomousVmCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/CreateCloudAutonomousVmCluster) 

# CreateCloudExadataInfrastructure
<a name="API_CreateCloudExadataInfrastructure"></a>

Creates an Exadata infrastructure.

## Request Syntax
<a name="API_CreateCloudExadataInfrastructure_RequestSyntax"></a>

```
{
   "availabilityZone": "string",
   "availabilityZoneId": "string",
   "clientToken": "string",
   "computeCount": number,
   "customerContactsToSendToOCI": [ 
      { 
         "email": "string"
      }
   ],
   "databaseServerType": "string",
   "displayName": "string",
   "maintenanceWindow": { 
      "customActionTimeoutInMins": number,
      "daysOfWeek": [ 
         { 
            "name": "string"
         }
      ],
      "hoursOfDay": [ number ],
      "isCustomActionTimeoutEnabled": boolean,
      "leadTimeInWeeks": number,
      "months": [ 
         { 
            "name": "string"
         }
      ],
      "patchingMode": "string",
      "preference": "string",
      "skipRu": boolean,
      "weeksOfMonth": [ number ]
   },
   "shape": "string",
   "storageCount": number,
   "storageServerType": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_CreateCloudExadataInfrastructure_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [availabilityZone](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-availabilityZone"></a>
The name of the Availability Zone (AZ) where the Exadata infrastructure is located.  
This operation requires that you specify a value for either `availabilityZone` or `availabilityZoneId`.  
Example: `us-east-1a`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [availabilityZoneId](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-availabilityZoneId"></a>
The AZ ID of the AZ where the Exadata infrastructure is located.  
This operation requires that you specify a value for either `availabilityZone` or `availabilityZoneId`.  
Example: `use1-az1`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [clientToken](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: No

 ** [computeCount](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-computeCount"></a>
The number of database servers for the Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the `ListDbSystemShapes` operation.  
Type: Integer  
Required: Yes

 ** [customerContactsToSendToOCI](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-customerContactsToSendToOCI"></a>
The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.  
Type: Array of [CustomerContact](API_CustomerContact.md) objects  
Required: No

 ** [databaseServerType](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-databaseServerType"></a>
The database server model type of the Exadata infrastructure. For the list of valid model names, use the `ListDbSystemShapes` operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: No

 ** [displayName](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-displayName"></a>
A user-friendly name for the Exadata infrastructure.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*`   
Required: Yes

 ** [maintenanceWindow](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-maintenanceWindow"></a>
The maintenance window configuration for the Exadata Cloud infrastructure.  
This allows you to define when maintenance operations such as patching and updates can be performed on the infrastructure.  
Type: [MaintenanceWindow](API_MaintenanceWindow.md) object  
Required: No

 ** [shape](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-shape"></a>
The model name of the Exadata infrastructure. For the list of valid model names, use the `ListDbSystemShapes` operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: Yes

 ** [storageCount](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-storageCount"></a>
The number of storage servers to activate for this Exadata infrastructure. Valid values for this parameter depend on the shape. To get information about the minimum and maximum values, use the `ListDbSystemShapes` operation.  
Type: Integer  
Required: Yes

 ** [storageServerType](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-storageServerType"></a>
The storage server model type of the Exadata infrastructure. For the list of valid model names, use the `ListDbSystemShapes` operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: No

 ** [tags](#API_CreateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-request-tags"></a>
The list of resource tags to apply to the Exadata infrastructure.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateCloudExadataInfrastructure_ResponseSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "displayName": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_CreateCloudExadataInfrastructure_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudExadataInfrastructureId](#API_CreateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-response-cloudExadataInfrastructureId"></a>
The unique identifier of the Exadata infrastructure.  
Type: String

 ** [displayName](#API_CreateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-response-displayName"></a>
The user-friendly name for the Exadata infrastructure.  
Type: String

 ** [status](#API_CreateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-response-status"></a>
The current status of the Exadata infrastructure.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_CreateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-CreateCloudExadataInfrastructure-response-statusReason"></a>
Additional information about the status of the Exadata infrastructure.  
Type: String

## Errors
<a name="API_CreateCloudExadataInfrastructure_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
You have exceeded the service quota.    
 ** quotaCode **   
The unqiue identifier of the service quota that was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded the service quota.  
 ** resourceType **   
The type of resource that exceeded the service quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateCloudExadataInfrastructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/CreateCloudExadataInfrastructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/CreateCloudExadataInfrastructure) 

# CreateCloudVmCluster
<a name="API_CreateCloudVmCluster"></a>

Creates a VM cluster on the specified Exadata infrastructure.

## Request Syntax
<a name="API_CreateCloudVmCluster_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "cloudExadataInfrastructureId": "string",
   "clusterName": "string",
   "cpuCoreCount": number,
   "dataCollectionOptions": { 
      "isDiagnosticsEventsEnabled": boolean,
      "isHealthMonitoringEnabled": boolean,
      "isIncidentLogsEnabled": boolean
   },
   "dataStorageSizeInTBs": number,
   "dbNodeStorageSizeInGBs": number,
   "dbServers": [ "string" ],
   "displayName": "string",
   "giVersion": "string",
   "hostname": "string",
   "isLocalBackupEnabled": boolean,
   "isSparseDiskgroupEnabled": boolean,
   "licenseModel": "string",
   "memorySizeInGBs": number,
   "odbNetworkId": "string",
   "scanListenerPortTcp": number,
   "sshPublicKeys": [ "string" ],
   "systemVersion": "string",
   "tags": { 
      "string" : "string" 
   },
   "timeZone": "string"
}
```

## Request Parameters
<a name="API_CreateCloudVmCluster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: No

 ** [cloudExadataInfrastructureId](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Exadata infrastructure for this VM cluster.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [clusterName](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-clusterName"></a>
A name for the Grid Infrastructure cluster. The name isn't case sensitive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 11.  
Pattern: `[a-zA-Z][a-zA-Z0-9-]*`   
Required: No

 ** [cpuCoreCount](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-cpuCoreCount"></a>
The number of CPU cores to enable on the VM cluster.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 10000.  
Required: Yes

 ** [dataCollectionOptions](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-dataCollectionOptions"></a>
The set of preferences for the various diagnostic collection options for the VM cluster.  
Type: [DataCollectionOptions](API_DataCollectionOptions.md) object  
Required: No

 ** [dataStorageSizeInTBs](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-dataStorageSizeInTBs"></a>
The size of the data disk group, in terabytes (TBs), to allocate for the VM cluster.  
Type: Double  
Required: No

 ** [dbNodeStorageSizeInGBs](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-dbNodeStorageSizeInGBs"></a>
The amount of local node storage, in gigabytes (GBs), to allocate for the VM cluster.  
Type: Integer  
Required: No

 ** [dbServers](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-dbServers"></a>
The list of database servers for the VM cluster.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

 ** [displayName](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-displayName"></a>
A user-friendly name for the VM cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*`   
Required: Yes

 ** [giVersion](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-giVersion"></a>
A valid software version of Oracle Grid Infrastructure (GI). To get the list of valid values, use the `ListGiVersions` operation and specify the shape of the Exadata infrastructure.  
Example: `19.0.0.0`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [hostname](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-hostname"></a>
The host name for the VM cluster.  
Constraints:  
+ Can't be "localhost" or "hostname".
+ Can't contain "-version".
+ The maximum length of the combined hostname and domain is 63 characters.
+ The hostname must be unique within the subnet.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[a-zA-Z][a-zA-Z0-9-]*[a-zA-Z0-9]`   
Required: Yes

 ** [isLocalBackupEnabled](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-isLocalBackupEnabled"></a>
Specifies whether to enable database backups to local Exadata storage for the VM cluster.  
Type: Boolean  
Required: No

 ** [isSparseDiskgroupEnabled](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-isSparseDiskgroupEnabled"></a>
Specifies whether to create a sparse disk group for the VM cluster.  
Type: Boolean  
Required: No

 ** [licenseModel](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-licenseModel"></a>
The Oracle license model to apply to the VM cluster.  
Default: `LICENSE_INCLUDED`   
Type: String  
Valid Values: `BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED`   
Required: No

 ** [memorySizeInGBs](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-memorySizeInGBs"></a>
The amount of memory, in gigabytes (GBs), to allocate for the VM cluster.  
Type: Integer  
Required: No

 ** [odbNetworkId](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-odbNetworkId"></a>
The unique identifier of the ODB network for the VM cluster.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [scanListenerPortTcp](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-scanListenerPortTcp"></a>
The port number for TCP connections to the single client access name (SCAN) listener.   
Valid values: `1024–8999` with the following exceptions: `2484`, `6100`, `6200`, `7060`, `7070`, `7085`, and `7879`   
Default: `1521`   
Type: Integer  
Valid Range: Minimum value of 1024. Maximum value of 8999.  
Required: No

 ** [sshPublicKeys](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-sshPublicKeys"></a>
The public key portion of one or more key pairs used for SSH access to the VM cluster.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: Yes

 ** [systemVersion](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-systemVersion"></a>
The version of the operating system of the image for the VM cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [tags](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-tags"></a>
The list of resource tags to apply to the VM cluster.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [timeZone](#API_CreateCloudVmCluster_RequestSyntax) **   <a name="odb-CreateCloudVmCluster-request-timeZone"></a>
The time zone for the VM cluster. For a list of valid values for time zone, you can check the options in the console.  
Default: UTC  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## Response Syntax
<a name="API_CreateCloudVmCluster_ResponseSyntax"></a>

```
{
   "cloudVmClusterId": "string",
   "displayName": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_CreateCloudVmCluster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudVmClusterId](#API_CreateCloudVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudVmCluster-response-cloudVmClusterId"></a>
The unique identifier for the VM cluster.  
Type: String

 ** [displayName](#API_CreateCloudVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudVmCluster-response-displayName"></a>
The user-friendly name for the VM cluster.  
Type: String

 ** [status](#API_CreateCloudVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudVmCluster-response-status"></a>
The current status of the VM cluster.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_CreateCloudVmCluster_ResponseSyntax) **   <a name="odb-CreateCloudVmCluster-response-statusReason"></a>
Additional information about the status of the VM cluster.  
Type: String

## Errors
<a name="API_CreateCloudVmCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
You have exceeded the service quota.    
 ** quotaCode **   
The unqiue identifier of the service quota that was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded the service quota.  
 ** resourceType **   
The type of resource that exceeded the service quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateCloudVmCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/CreateCloudVmCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/CreateCloudVmCluster) 

# CreateOdbNetwork
<a name="API_CreateOdbNetwork"></a>

Creates an ODB network.

## Request Syntax
<a name="API_CreateOdbNetwork_RequestSyntax"></a>

```
{
   "availabilityZone": "string",
   "availabilityZoneId": "string",
   "backupSubnetCidr": "string",
   "clientSubnetCidr": "string",
   "clientToken": "string",
   "crossRegionS3RestoreSourcesToEnable": [ "string" ],
   "customDomainName": "string",
   "defaultDnsPrefix": "string",
   "displayName": "string",
   "kmsAccess": "string",
   "kmsPolicyDocument": "string",
   "s3Access": "string",
   "s3PolicyDocument": "string",
   "stsAccess": "string",
   "stsPolicyDocument": "string",
   "tags": { 
      "string" : "string" 
   },
   "zeroEtlAccess": "string"
}
```

## Request Parameters
<a name="API_CreateOdbNetwork_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [availabilityZone](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-availabilityZone"></a>
The AWS Availability Zone (AZ) where the ODB network is located.  
This operation requires that you specify a value for either `availabilityZone` or `availabilityZoneId`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [availabilityZoneId](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-availabilityZoneId"></a>
The AZ ID of the AZ where the ODB network is located.  
This operation requires that you specify a value for either `availabilityZone` or `availabilityZoneId`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [backupSubnetCidr](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-backupSubnetCidr"></a>
The CIDR range of the backup subnet for the ODB network.  
Constraints:  
+ Must not overlap with the CIDR range of the client subnet.
+ Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
+ Must not use the following CIDR ranges that are reserved by OCI:
  +  `100.106.0.0/16` and `100.107.0.0/16` 
  +  `169.254.0.0/16` 
  +  `224.0.0.0 - 239.255.255.255` 
  +  `240.0.0.0 - 255.255.255.255` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 43.  
Required: No

 ** [clientSubnetCidr](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-clientSubnetCidr"></a>
The CIDR range of the client subnet for the ODB network.  
Constraints:  
+ Must not overlap with the CIDR range of the backup subnet.
+ Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
+ Must not use the following CIDR ranges that are reserved by OCI:
  +  `100.106.0.0/16` and `100.107.0.0/16` 
  +  `169.254.0.0/16` 
  +  `224.0.0.0 - 239.255.255.255` 
  +  `240.0.0.0 - 255.255.255.255` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 43.  
Required: Yes

 ** [clientToken](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: No

 ** [crossRegionS3RestoreSourcesToEnable](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-crossRegionS3RestoreSourcesToEnable"></a>
The cross-Region Amazon S3 restore sources to enable for the ODB network.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

 ** [customDomainName](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-customDomainName"></a>
The domain name to use for the resources in the ODB network.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [defaultDnsPrefix](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-defaultDnsPrefix"></a>
The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 15.  
Pattern: `[a-zA-Z][a-zA-Z0-9]*`   
Required: No

 ** [displayName](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-displayName"></a>
A user-friendly name for the ODB network.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*`   
Required: Yes

 ** [kmsAccess](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-kmsAccess"></a>
The AWS Key Management Service (KMS) access configuration for the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [kmsPolicyDocument](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-kmsPolicyDocument"></a>
The AWS Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 20480.  
Required: No

 ** [s3Access](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-s3Access"></a>
Specifies the configuration for Amazon S3 access from the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [s3PolicyDocument](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-s3PolicyDocument"></a>
Specifies the endpoint policy for Amazon S3 access from the ODB network.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 20480.  
Required: No

 ** [stsAccess](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-stsAccess"></a>
The AWS Security Token Service (STS) access configuration for the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [stsPolicyDocument](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-stsPolicyDocument"></a>
The AWS Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 20480.  
Required: No

 ** [tags](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-tags"></a>
The list of resource tags to apply to the ODB network.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [zeroEtlAccess](#API_CreateOdbNetwork_RequestSyntax) **   <a name="odb-CreateOdbNetwork-request-zeroEtlAccess"></a>
Specifies the configuration for Zero-ETL access from the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Syntax
<a name="API_CreateOdbNetwork_ResponseSyntax"></a>

```
{
   "displayName": "string",
   "odbNetworkId": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_CreateOdbNetwork_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [displayName](#API_CreateOdbNetwork_ResponseSyntax) **   <a name="odb-CreateOdbNetwork-response-displayName"></a>
The user-friendly name of the ODB network.  
Type: String

 ** [odbNetworkId](#API_CreateOdbNetwork_ResponseSyntax) **   <a name="odb-CreateOdbNetwork-response-odbNetworkId"></a>
The unique identifier of the ODB network.  
Type: String

 ** [status](#API_CreateOdbNetwork_ResponseSyntax) **   <a name="odb-CreateOdbNetwork-response-status"></a>
The current status of the ODB network.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_CreateOdbNetwork_ResponseSyntax) **   <a name="odb-CreateOdbNetwork-response-statusReason"></a>
Additional information about the status of the ODB network.  
Type: String

## Errors
<a name="API_CreateOdbNetwork_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
You have exceeded the service quota.    
 ** quotaCode **   
The unqiue identifier of the service quota that was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded the service quota.  
 ** resourceType **   
The type of resource that exceeded the service quota.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateOdbNetwork_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/CreateOdbNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/CreateOdbNetwork) 

# CreateOdbPeeringConnection
<a name="API_CreateOdbPeeringConnection"></a>

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

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

## Request Syntax
<a name="API_CreateOdbPeeringConnection_RequestSyntax"></a>

```
{
   "clientToken": "string",
   "displayName": "string",
   "odbNetworkId": "string",
   "peerNetworkCidrsToBeAdded": [ "string" ],
   "peerNetworkId": "string",
   "peerNetworkRouteTableIds": [ "string" ],
   "tags": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_CreateOdbPeeringConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [clientToken](#API_CreateOdbPeeringConnection_RequestSyntax) **   <a name="odb-CreateOdbPeeringConnection-request-clientToken"></a>
The client token for the ODB peering connection request.  
Constraints:  
+ Must be unique for each request.
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_\/.=-]+`   
Required: No

 ** [displayName](#API_CreateOdbPeeringConnection_RequestSyntax) **   <a name="odb-CreateOdbPeeringConnection-request-displayName"></a>
The display name for the ODB peering connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*`   
Required: No

 ** [odbNetworkId](#API_CreateOdbPeeringConnection_RequestSyntax) **   <a name="odb-CreateOdbPeeringConnection-request-odbNetworkId"></a>
The unique identifier of the ODB network that initiates the peering connection.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [peerNetworkCidrsToBeAdded](#API_CreateOdbPeeringConnection_RequestSyntax) **   <a name="odb-CreateOdbPeeringConnection-request-peerNetworkCidrsToBeAdded"></a>
A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `(?:(?:\d|[01]?\d\d|2[0-4]\d|25[0-5])\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d|\d)\/(?:[1-2][0-9]|3[0-2]|[1-9])`   
Required: No

 ** [peerNetworkId](#API_CreateOdbPeeringConnection_RequestSyntax) **   <a name="odb-CreateOdbPeeringConnection-request-peerNetworkId"></a>
The unique identifier of the peer network. This can be either a VPC ID or another ODB network ID.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [peerNetworkRouteTableIds](#API_CreateOdbPeeringConnection_RequestSyntax) **   <a name="odb-CreateOdbPeeringConnection-request-peerNetworkRouteTableIds"></a>
The unique identifier of the VPC route table for which a route to the ODB network is automatically created during peering connection establishment.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Pattern: `rtb-[a-z0-9]{8,17}`   
Required: No

 ** [tags](#API_CreateOdbPeeringConnection_RequestSyntax) **   <a name="odb-CreateOdbPeeringConnection-request-tags"></a>
The tags to assign to the ODB peering connection.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateOdbPeeringConnection_ResponseSyntax"></a>

```
{
   "displayName": "string",
   "odbPeeringConnectionId": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_CreateOdbPeeringConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [displayName](#API_CreateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-CreateOdbPeeringConnection-response-displayName"></a>
The display name of the ODB peering connection.  
Type: String

 ** [odbPeeringConnectionId](#API_CreateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-CreateOdbPeeringConnection-response-odbPeeringConnectionId"></a>
The unique identifier of the ODB peering connection.  
Type: String

 ** [status](#API_CreateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-CreateOdbPeeringConnection-response-status"></a>
The status of the ODB peering connection.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_CreateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-CreateOdbPeeringConnection-response-statusReason"></a>
The reason for the current status of the ODB peering connection.  
Type: String

## Errors
<a name="API_CreateOdbPeeringConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_CreateOdbPeeringConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/CreateOdbPeeringConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/CreateOdbPeeringConnection) 

# DeleteCloudAutonomousVmCluster
<a name="API_DeleteCloudAutonomousVmCluster"></a>

Deletes an Autonomous VM cluster.

## Request Syntax
<a name="API_DeleteCloudAutonomousVmCluster_RequestSyntax"></a>

```
{
   "cloudAutonomousVmClusterId": "string"
}
```

## Request Parameters
<a name="API_DeleteCloudAutonomousVmCluster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudAutonomousVmClusterId](#API_DeleteCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-DeleteCloudAutonomousVmCluster-request-cloudAutonomousVmClusterId"></a>
The unique identifier of the Autonomous VM cluster to delete.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Elements
<a name="API_DeleteCloudAutonomousVmCluster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteCloudAutonomousVmCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeleteCloudAutonomousVmCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/DeleteCloudAutonomousVmCluster) 

# DeleteCloudExadataInfrastructure
<a name="API_DeleteCloudExadataInfrastructure"></a>

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.

## Request Syntax
<a name="API_DeleteCloudExadataInfrastructure_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string"
}
```

## Request Parameters
<a name="API_DeleteCloudExadataInfrastructure_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_DeleteCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-DeleteCloudExadataInfrastructure-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Exadata infrastructure to delete.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

## Response Elements
<a name="API_DeleteCloudExadataInfrastructure_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteCloudExadataInfrastructure_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeleteCloudExadataInfrastructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/DeleteCloudExadataInfrastructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/DeleteCloudExadataInfrastructure) 

# DeleteCloudVmCluster
<a name="API_DeleteCloudVmCluster"></a>

Deletes the specified VM cluster.

## Request Syntax
<a name="API_DeleteCloudVmCluster_RequestSyntax"></a>

```
{
   "cloudVmClusterId": "string"
}
```

## Request Parameters
<a name="API_DeleteCloudVmCluster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_DeleteCloudVmCluster_RequestSyntax) **   <a name="odb-DeleteCloudVmCluster-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster to delete.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Elements
<a name="API_DeleteCloudVmCluster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteCloudVmCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeleteCloudVmCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/DeleteCloudVmCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/DeleteCloudVmCluster) 

# DeleteOdbNetwork
<a name="API_DeleteOdbNetwork"></a>

Deletes the specified ODB network.

## Request Syntax
<a name="API_DeleteOdbNetwork_RequestSyntax"></a>

```
{
   "deleteAssociatedResources": boolean,
   "odbNetworkId": "string"
}
```

## Request Parameters
<a name="API_DeleteOdbNetwork_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [deleteAssociatedResources](#API_DeleteOdbNetwork_RequestSyntax) **   <a name="odb-DeleteOdbNetwork-request-deleteAssociatedResources"></a>
Specifies whether to delete associated OCI networking resources along with the ODB network.  
Type: Boolean  
Required: Yes

 ** [odbNetworkId](#API_DeleteOdbNetwork_RequestSyntax) **   <a name="odb-DeleteOdbNetwork-request-odbNetworkId"></a>
The unique identifier of the ODB network to delete.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

## Response Elements
<a name="API_DeleteOdbNetwork_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteOdbNetwork_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeleteOdbNetwork_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/DeleteOdbNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/DeleteOdbNetwork) 

# DeleteOdbPeeringConnection
<a name="API_DeleteOdbPeeringConnection"></a>

Deletes an ODB peering connection.

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

## Request Syntax
<a name="API_DeleteOdbPeeringConnection_RequestSyntax"></a>

```
{
   "odbPeeringConnectionId": "string"
}
```

## Request Parameters
<a name="API_DeleteOdbPeeringConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [odbPeeringConnectionId](#API_DeleteOdbPeeringConnection_RequestSyntax) **   <a name="odb-DeleteOdbPeeringConnection-request-odbPeeringConnectionId"></a>
The unique identifier of the ODB peering connection to delete.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

## Response Elements
<a name="API_DeleteOdbPeeringConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteOdbPeeringConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DeleteOdbPeeringConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/DeleteOdbPeeringConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/DeleteOdbPeeringConnection) 

# DisassociateIamRoleFromResource
<a name="API_DisassociateIamRoleFromResource"></a>

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

## Request Syntax
<a name="API_DisassociateIamRoleFromResource_RequestSyntax"></a>

```
{
   "awsIntegration": "string",
   "iamRoleArn": "string",
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_DisassociateIamRoleFromResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [awsIntegration](#API_DisassociateIamRoleFromResource_RequestSyntax) **   <a name="odb-DisassociateIamRoleFromResource-request-awsIntegration"></a>
The AWS integration configuration settings for the AWS Identity and Access Management (IAM) service role disassociation.  
Type: String  
Valid Values: `KmsTde`   
Required: Yes

 ** [iamRoleArn](#API_DisassociateIamRoleFromResource_RequestSyntax) **   <a name="odb-DisassociateIamRoleFromResource-request-iamRoleArn"></a>
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to disassociate from the resource.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam::[0-9]{12}:role/.+`   
Required: Yes

 ** [resourceArn](#API_DisassociateIamRoleFromResource_RequestSyntax) **   <a name="odb-DisassociateIamRoleFromResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the target resource to disassociate from the AWS Identity and Access Management (IAM) service role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-[a-z]?|aws-iso):odb:[a-z0-9-]+:\d{12}:(?:cloud-vm-cluster|cloud-autonomous-vm-cluster)/[a-z0-9-_]+`   
Required: Yes

## Response Elements
<a name="API_DisassociateIamRoleFromResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateIamRoleFromResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_DisassociateIamRoleFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/DisassociateIamRoleFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/DisassociateIamRoleFromResource) 

# GetCloudAutonomousVmCluster
<a name="API_GetCloudAutonomousVmCluster"></a>

Gets information about a specific Autonomous VM cluster.

## Request Syntax
<a name="API_GetCloudAutonomousVmCluster_RequestSyntax"></a>

```
{
   "cloudAutonomousVmClusterId": "string"
}
```

## Request Parameters
<a name="API_GetCloudAutonomousVmCluster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudAutonomousVmClusterId](#API_GetCloudAutonomousVmCluster_RequestSyntax) **   <a name="odb-GetCloudAutonomousVmCluster-request-cloudAutonomousVmClusterId"></a>
The unique identifier of the Autonomous VM cluster to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax
<a name="API_GetCloudAutonomousVmCluster_ResponseSyntax"></a>

```
{
   "cloudAutonomousVmCluster": { 
      "autonomousDataStoragePercentage": number,
      "autonomousDataStorageSizeInTBs": number,
      "availableAutonomousDataStorageSizeInTBs": number,
      "availableContainerDatabases": number,
      "availableCpus": number,
      "cloudAutonomousVmClusterArn": "string",
      "cloudAutonomousVmClusterId": "string",
      "cloudExadataInfrastructureArn": "string",
      "cloudExadataInfrastructureId": "string",
      "computeModel": "string",
      "cpuCoreCount": number,
      "cpuCoreCountPerNode": number,
      "cpuPercentage": number,
      "createdAt": "string",
      "dataStorageSizeInGBs": number,
      "dataStorageSizeInTBs": number,
      "dbNodeStorageSizeInGBs": number,
      "dbServers": [ "string" ],
      "description": "string",
      "displayName": "string",
      "domain": "string",
      "exadataStorageInTBsLowestScaledValue": number,
      "hostname": "string",
      "iamRoles": [ 
         { 
            "awsIntegration": "string",
            "iamRoleArn": "string",
            "status": "string",
            "statusReason": "string"
         }
      ],
      "isMtlsEnabledVmCluster": boolean,
      "licenseModel": "string",
      "maintenanceWindow": { 
         "customActionTimeoutInMins": number,
         "daysOfWeek": [ 
            { 
               "name": "string"
            }
         ],
         "hoursOfDay": [ number ],
         "isCustomActionTimeoutEnabled": boolean,
         "leadTimeInWeeks": number,
         "months": [ 
            { 
               "name": "string"
            }
         ],
         "patchingMode": "string",
         "preference": "string",
         "skipRu": boolean,
         "weeksOfMonth": [ number ]
      },
      "maxAcdsLowestScaledValue": number,
      "memoryPerOracleComputeUnitInGBs": number,
      "memorySizeInGBs": number,
      "nodeCount": number,
      "nonProvisionableAutonomousContainerDatabases": number,
      "ocid": "string",
      "ociResourceAnchorName": "string",
      "ociUrl": "string",
      "odbNetworkArn": "string",
      "odbNetworkId": "string",
      "percentProgress": number,
      "provisionableAutonomousContainerDatabases": number,
      "provisionedAutonomousContainerDatabases": number,
      "provisionedCpus": number,
      "reclaimableCpus": number,
      "reservedCpus": number,
      "scanListenerPortNonTls": number,
      "scanListenerPortTls": number,
      "shape": "string",
      "status": "string",
      "statusReason": "string",
      "timeDatabaseSslCertificateExpires": "string",
      "timeOrdsCertificateExpires": "string",
      "timeZone": "string",
      "totalContainerDatabases": number
   }
}
```

## Response Elements
<a name="API_GetCloudAutonomousVmCluster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudAutonomousVmCluster](#API_GetCloudAutonomousVmCluster_ResponseSyntax) **   <a name="odb-GetCloudAutonomousVmCluster-response-cloudAutonomousVmCluster"></a>
The details of the requested Autonomous VM cluster.  
Type: [CloudAutonomousVmCluster](API_CloudAutonomousVmCluster.md) object

## Errors
<a name="API_GetCloudAutonomousVmCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetCloudAutonomousVmCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetCloudAutonomousVmCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetCloudAutonomousVmCluster) 

# GetCloudExadataInfrastructure
<a name="API_GetCloudExadataInfrastructure"></a>

Returns information about the specified Exadata infrastructure.

## Request Syntax
<a name="API_GetCloudExadataInfrastructure_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string"
}
```

## Request Parameters
<a name="API_GetCloudExadataInfrastructure_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_GetCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-GetCloudExadataInfrastructure-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Exadata infrastructure.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

## Response Syntax
<a name="API_GetCloudExadataInfrastructure_ResponseSyntax"></a>

```
{
   "cloudExadataInfrastructure": { 
      "activatedStorageCount": number,
      "additionalStorageCount": number,
      "availabilityZone": "string",
      "availabilityZoneId": "string",
      "availableStorageSizeInGBs": number,
      "cloudExadataInfrastructureArn": "string",
      "cloudExadataInfrastructureId": "string",
      "computeCount": number,
      "computeModel": "string",
      "cpuCount": number,
      "createdAt": "string",
      "customerContactsToSendToOCI": [ 
         { 
            "email": "string"
         }
      ],
      "databaseServerType": "string",
      "dataStorageSizeInTBs": number,
      "dbNodeStorageSizeInGBs": number,
      "dbServerVersion": "string",
      "displayName": "string",
      "lastMaintenanceRunId": "string",
      "maintenanceWindow": { 
         "customActionTimeoutInMins": number,
         "daysOfWeek": [ 
            { 
               "name": "string"
            }
         ],
         "hoursOfDay": [ number ],
         "isCustomActionTimeoutEnabled": boolean,
         "leadTimeInWeeks": number,
         "months": [ 
            { 
               "name": "string"
            }
         ],
         "patchingMode": "string",
         "preference": "string",
         "skipRu": boolean,
         "weeksOfMonth": [ number ]
      },
      "maxCpuCount": number,
      "maxDataStorageInTBs": number,
      "maxDbNodeStorageSizeInGBs": number,
      "maxMemoryInGBs": number,
      "memorySizeInGBs": number,
      "monthlyDbServerVersion": "string",
      "monthlyStorageServerVersion": "string",
      "nextMaintenanceRunId": "string",
      "ocid": "string",
      "ociResourceAnchorName": "string",
      "ociUrl": "string",
      "percentProgress": number,
      "shape": "string",
      "status": "string",
      "statusReason": "string",
      "storageCount": number,
      "storageServerType": "string",
      "storageServerVersion": "string",
      "totalStorageSizeInGBs": number
   }
}
```

## Response Elements
<a name="API_GetCloudExadataInfrastructure_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudExadataInfrastructure](#API_GetCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-GetCloudExadataInfrastructure-response-cloudExadataInfrastructure"></a>
The Exadata infrastructure.  
Type: [CloudExadataInfrastructure](API_CloudExadataInfrastructure.md) object

## Errors
<a name="API_GetCloudExadataInfrastructure_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetCloudExadataInfrastructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetCloudExadataInfrastructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetCloudExadataInfrastructure) 

# GetCloudExadataInfrastructureUnallocatedResources
<a name="API_GetCloudExadataInfrastructureUnallocatedResources"></a>

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

## Request Syntax
<a name="API_GetCloudExadataInfrastructureUnallocatedResources_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "dbServers": [ "string" ]
}
```

## Request Parameters
<a name="API_GetCloudExadataInfrastructureUnallocatedResources_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_GetCloudExadataInfrastructureUnallocatedResources_RequestSyntax) **   <a name="odb-GetCloudExadataInfrastructureUnallocatedResources-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Cloud Exadata infrastructure for which to retrieve unallocated resources.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [dbServers](#API_GetCloudExadataInfrastructureUnallocatedResources_RequestSyntax) **   <a name="odb-GetCloudExadataInfrastructureUnallocatedResources-request-dbServers"></a>
The database servers to include in the unallocated resources query.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

## Response Syntax
<a name="API_GetCloudExadataInfrastructureUnallocatedResources_ResponseSyntax"></a>

```
{
   "cloudExadataInfrastructureUnallocatedResources": { 
      "cloudAutonomousVmClusters": [ 
         { 
            "cloudAutonomousVmClusterId": "string",
            "unallocatedAdbStorageInTBs": number
         }
      ],
      "cloudExadataInfrastructureDisplayName": "string",
      "cloudExadataInfrastructureId": "string",
      "exadataStorageInTBs": number,
      "localStorageInGBs": number,
      "memoryInGBs": number,
      "ocpus": number
   }
}
```

## Response Elements
<a name="API_GetCloudExadataInfrastructureUnallocatedResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudExadataInfrastructureUnallocatedResources](#API_GetCloudExadataInfrastructureUnallocatedResources_ResponseSyntax) **   <a name="odb-GetCloudExadataInfrastructureUnallocatedResources-response-cloudExadataInfrastructureUnallocatedResources"></a>
Details about the unallocated resources in the specified Cloud Exadata infrastructure.  
Type: [CloudExadataInfrastructureUnallocatedResources](API_CloudExadataInfrastructureUnallocatedResources.md) object

## Errors
<a name="API_GetCloudExadataInfrastructureUnallocatedResources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetCloudExadataInfrastructureUnallocatedResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetCloudExadataInfrastructureUnallocatedResources) 

# GetCloudVmCluster
<a name="API_GetCloudVmCluster"></a>

Returns information about the specified VM cluster.

## Request Syntax
<a name="API_GetCloudVmCluster_RequestSyntax"></a>

```
{
   "cloudVmClusterId": "string"
}
```

## Request Parameters
<a name="API_GetCloudVmCluster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_GetCloudVmCluster_RequestSyntax) **   <a name="odb-GetCloudVmCluster-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax
<a name="API_GetCloudVmCluster_ResponseSyntax"></a>

```
{
   "cloudVmCluster": { 
      "cloudExadataInfrastructureArn": "string",
      "cloudExadataInfrastructureId": "string",
      "cloudVmClusterArn": "string",
      "cloudVmClusterId": "string",
      "clusterName": "string",
      "computeModel": "string",
      "cpuCoreCount": number,
      "createdAt": "string",
      "dataCollectionOptions": { 
         "isDiagnosticsEventsEnabled": boolean,
         "isHealthMonitoringEnabled": boolean,
         "isIncidentLogsEnabled": boolean
      },
      "dataStorageSizeInTBs": number,
      "dbNodeStorageSizeInGBs": number,
      "dbServers": [ "string" ],
      "diskRedundancy": "string",
      "displayName": "string",
      "domain": "string",
      "giVersion": "string",
      "hostname": "string",
      "iamRoles": [ 
         { 
            "awsIntegration": "string",
            "iamRoleArn": "string",
            "status": "string",
            "statusReason": "string"
         }
      ],
      "iormConfigCache": { 
         "dbPlans": [ 
            { 
               "dbName": "string",
               "flashCacheLimit": "string",
               "share": number
            }
         ],
         "lifecycleDetails": "string",
         "lifecycleState": "string",
         "objective": "string"
      },
      "isLocalBackupEnabled": boolean,
      "isSparseDiskgroupEnabled": boolean,
      "lastUpdateHistoryEntryId": "string",
      "licenseModel": "string",
      "listenerPort": number,
      "memorySizeInGBs": number,
      "nodeCount": number,
      "ocid": "string",
      "ociResourceAnchorName": "string",
      "ociUrl": "string",
      "odbNetworkArn": "string",
      "odbNetworkId": "string",
      "percentProgress": number,
      "scanDnsName": "string",
      "scanDnsRecordId": "string",
      "scanIpIds": [ "string" ],
      "shape": "string",
      "sshPublicKeys": [ "string" ],
      "status": "string",
      "statusReason": "string",
      "storageSizeInGBs": number,
      "systemVersion": "string",
      "timeZone": "string",
      "vipIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_GetCloudVmCluster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudVmCluster](#API_GetCloudVmCluster_ResponseSyntax) **   <a name="odb-GetCloudVmCluster-response-cloudVmCluster"></a>
The VM cluster.  
Type: [CloudVmCluster](API_CloudVmCluster.md) object

## Errors
<a name="API_GetCloudVmCluster_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetCloudVmCluster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetCloudVmCluster) 

# GetDbNode
<a name="API_GetDbNode"></a>

Returns information about the specified DB node.

## Request Syntax
<a name="API_GetDbNode_RequestSyntax"></a>

```
{
   "cloudVmClusterId": "string",
   "dbNodeId": "string"
}
```

## Request Parameters
<a name="API_GetDbNode_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_GetDbNode_RequestSyntax) **   <a name="odb-GetDbNode-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster that contains the DB node.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

 ** [dbNodeId](#API_GetDbNode_RequestSyntax) **   <a name="odb-GetDbNode-request-dbNodeId"></a>
The unique identifier of the DB node to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax
<a name="API_GetDbNode_ResponseSyntax"></a>

```
{
   "dbNode": { 
      "additionalDetails": "string",
      "backupIpId": "string",
      "backupVnic2Id": "string",
      "backupVnicId": "string",
      "cpuCoreCount": number,
      "createdAt": "string",
      "dbNodeArn": "string",
      "dbNodeId": "string",
      "dbNodeStorageSizeInGBs": number,
      "dbServerId": "string",
      "dbSystemId": "string",
      "faultDomain": "string",
      "floatingIpAddress": "string",
      "hostIpId": "string",
      "hostname": "string",
      "maintenanceType": "string",
      "memorySizeInGBs": number,
      "ocid": "string",
      "ociResourceAnchorName": "string",
      "privateIpAddress": "string",
      "softwareStorageSizeInGB": number,
      "status": "string",
      "statusReason": "string",
      "timeMaintenanceWindowEnd": "string",
      "timeMaintenanceWindowStart": "string",
      "totalCpuCoreCount": number,
      "vnic2Id": "string",
      "vnicId": "string"
   }
}
```

## Response Elements
<a name="API_GetDbNode_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbNode](#API_GetDbNode_ResponseSyntax) **   <a name="odb-GetDbNode-response-dbNode"></a>
Information about a DB node.  
Type: [DbNode](API_DbNode.md) object

## Errors
<a name="API_GetDbNode_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetDbNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetDbNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetDbNode) 

# GetDbServer
<a name="API_GetDbServer"></a>

Returns information about the specified database server.

## Request Syntax
<a name="API_GetDbServer_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "dbServerId": "string"
}
```

## Request Parameters
<a name="API_GetDbServer_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_GetDbServer_RequestSyntax) **   <a name="odb-GetDbServer-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Oracle Exadata infrastructure that contains the database server.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [dbServerId](#API_GetDbServer_RequestSyntax) **   <a name="odb-GetDbServer-request-dbServerId"></a>
The unique identifier of the database server to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax
<a name="API_GetDbServer_ResponseSyntax"></a>

```
{
   "dbServer": { 
      "autonomousVirtualMachineIds": [ "string" ],
      "autonomousVmClusterIds": [ "string" ],
      "computeModel": "string",
      "cpuCoreCount": number,
      "createdAt": "string",
      "dbNodeStorageSizeInGBs": number,
      "dbServerId": "string",
      "dbServerPatchingDetails": { 
         "estimatedPatchDuration": number,
         "patchingStatus": "string",
         "timePatchingEnded": "string",
         "timePatchingStarted": "string"
      },
      "displayName": "string",
      "exadataInfrastructureId": "string",
      "maxCpuCount": number,
      "maxDbNodeStorageInGBs": number,
      "maxMemoryInGBs": number,
      "memorySizeInGBs": number,
      "ocid": "string",
      "ociResourceAnchorName": "string",
      "shape": "string",
      "status": "string",
      "statusReason": "string",
      "vmClusterIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_GetDbServer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbServer](#API_GetDbServer_ResponseSyntax) **   <a name="odb-GetDbServer-response-dbServer"></a>
The details of the requested database server.  
Type: [DbServer](API_DbServer.md) object

## Errors
<a name="API_GetDbServer_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetDbServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetDbServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetDbServer) 

# GetOciOnboardingStatus
<a name="API_GetOciOnboardingStatus"></a>

Returns the tenancy activation link and onboarding status for your AWS account.

## Response Syntax
<a name="API_GetOciOnboardingStatus_ResponseSyntax"></a>

```
{
   "existingTenancyActivationLink": "string",
   "newTenancyActivationLink": "string",
   "ociIdentityDomain": { 
      "accountSetupCloudFormationUrl": "string",
      "ociIdentityDomainId": "string",
      "ociIdentityDomainResourceUrl": "string",
      "ociIdentityDomainUrl": "string",
      "status": "string",
      "statusReason": "string"
   },
   "status": "string"
}
```

## Response Elements
<a name="API_GetOciOnboardingStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [existingTenancyActivationLink](#API_GetOciOnboardingStatus_ResponseSyntax) **   <a name="odb-GetOciOnboardingStatus-response-existingTenancyActivationLink"></a>
The existing OCI tenancy activation link for your AWS account.  
Type: String

 ** [newTenancyActivationLink](#API_GetOciOnboardingStatus_ResponseSyntax) **   <a name="odb-GetOciOnboardingStatus-response-newTenancyActivationLink"></a>
A new OCI tenancy activation link for your AWS account.  
Type: String

 ** [ociIdentityDomain](#API_GetOciOnboardingStatus_ResponseSyntax) **   <a name="odb-GetOciOnboardingStatus-response-ociIdentityDomain"></a>
The Oracle Cloud Infrastructure (OCI) identity domain information in the onboarding status response.  
Type: [OciIdentityDomain](API_OciIdentityDomain.md) object

 ** [status](#API_GetOciOnboardingStatus_ResponseSyntax) **   <a name="odb-GetOciOnboardingStatus-response-status"></a>
  
Type: String  
Valid Values: `NOT_STARTED | PENDING_LINK_GENERATION | PENDING_CUSTOMER_ACTION | PENDING_INITIALIZATION | ACTIVATING | ACTIVE_IN_HOME_REGION | ACTIVE | ACTIVE_LIMITED | FAILED | PUBLIC_OFFER_UNSUPPORTED | SUSPENDED | CANCELED` 

## Errors
<a name="API_GetOciOnboardingStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetOciOnboardingStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetOciOnboardingStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetOciOnboardingStatus) 

# GetOdbNetwork
<a name="API_GetOdbNetwork"></a>

Returns information about the specified ODB network.

## Request Syntax
<a name="API_GetOdbNetwork_RequestSyntax"></a>

```
{
   "odbNetworkId": "string"
}
```

## Request Parameters
<a name="API_GetOdbNetwork_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [odbNetworkId](#API_GetOdbNetwork_RequestSyntax) **   <a name="odb-GetOdbNetwork-request-odbNetworkId"></a>
The unique identifier of the ODB network.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

## Response Syntax
<a name="API_GetOdbNetwork_ResponseSyntax"></a>

```
{
   "odbNetwork": { 
      "availabilityZone": "string",
      "availabilityZoneId": "string",
      "backupSubnetCidr": "string",
      "clientSubnetCidr": "string",
      "createdAt": "string",
      "customDomainName": "string",
      "defaultDnsPrefix": "string",
      "displayName": "string",
      "ec2PlacementGroupIds": [ "string" ],
      "managedServices": { 
         "crossRegionS3RestoreSourcesAccess": [ 
            { 
               "ipv4Addresses": [ "string" ],
               "region": "string",
               "status": "string"
            }
         ],
         "kmsAccess": { 
            "domainName": "string",
            "ipv4Addresses": [ "string" ],
            "kmsPolicyDocument": "string",
            "status": "string"
         },
         "managedS3BackupAccess": { 
            "ipv4Addresses": [ "string" ],
            "status": "string"
         },
         "managedServicesIpv4Cidrs": [ "string" ],
         "resourceGatewayArn": "string",
         "s3Access": { 
            "domainName": "string",
            "ipv4Addresses": [ "string" ],
            "s3PolicyDocument": "string",
            "status": "string"
         },
         "serviceNetworkArn": "string",
         "serviceNetworkEndpoint": { 
            "vpcEndpointId": "string",
            "vpcEndpointType": "string"
         },
         "stsAccess": { 
            "domainName": "string",
            "ipv4Addresses": [ "string" ],
            "status": "string",
            "stsPolicyDocument": "string"
         },
         "zeroEtlAccess": { 
            "cidr": "string",
            "status": "string"
         }
      },
      "ociDnsForwardingConfigs": [ 
         { 
            "domainName": "string",
            "ociDnsListenerIp": "string"
         }
      ],
      "ociNetworkAnchorId": "string",
      "ociNetworkAnchorUrl": "string",
      "ociResourceAnchorName": "string",
      "ociVcnId": "string",
      "ociVcnUrl": "string",
      "odbNetworkArn": "string",
      "odbNetworkId": "string",
      "peeredCidrs": [ "string" ],
      "percentProgress": number,
      "status": "string",
      "statusReason": "string"
   }
}
```

## Response Elements
<a name="API_GetOdbNetwork_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [odbNetwork](#API_GetOdbNetwork_ResponseSyntax) **   <a name="odb-GetOdbNetwork-response-odbNetwork"></a>
The ODB network.  
Type: [OdbNetwork](API_OdbNetwork.md) object

## Errors
<a name="API_GetOdbNetwork_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetOdbNetwork_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetOdbNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetOdbNetwork) 

# GetOdbPeeringConnection
<a name="API_GetOdbPeeringConnection"></a>

Retrieves information about an ODB peering connection.

## Request Syntax
<a name="API_GetOdbPeeringConnection_RequestSyntax"></a>

```
{
   "odbPeeringConnectionId": "string"
}
```

## Request Parameters
<a name="API_GetOdbPeeringConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [odbPeeringConnectionId](#API_GetOdbPeeringConnection_RequestSyntax) **   <a name="odb-GetOdbPeeringConnection-request-odbPeeringConnectionId"></a>
The unique identifier of the ODB peering connection to retrieve information about.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

## Response Syntax
<a name="API_GetOdbPeeringConnection_ResponseSyntax"></a>

```
{
   "odbPeeringConnection": { 
      "createdAt": "string",
      "displayName": "string",
      "odbNetworkArn": "string",
      "odbPeeringConnectionArn": "string",
      "odbPeeringConnectionId": "string",
      "odbPeeringConnectionType": "string",
      "peerNetworkArn": "string",
      "peerNetworkCidrs": [ "string" ],
      "percentProgress": number,
      "status": "string",
      "statusReason": "string"
   }
}
```

## Response Elements
<a name="API_GetOdbPeeringConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [odbPeeringConnection](#API_GetOdbPeeringConnection_ResponseSyntax) **   <a name="odb-GetOdbPeeringConnection-response-odbPeeringConnection"></a>
A peering connection between an ODB network and either another ODB network or a customer-owned VPC.  
Type: [OdbPeeringConnection](API_OdbPeeringConnection.md) object

## Errors
<a name="API_GetOdbPeeringConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_GetOdbPeeringConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetOdbPeeringConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetOdbPeeringConnection) 

# InitializeService
<a name="API_InitializeService"></a>

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

## Request Syntax
<a name="API_InitializeService_RequestSyntax"></a>

```
{
   "ociIdentityDomain": boolean
}
```

## Request Parameters
<a name="API_InitializeService_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ociIdentityDomain](#API_InitializeService_RequestSyntax) **   <a name="odb-InitializeService-request-ociIdentityDomain"></a>
The Oracle Cloud Infrastructure (OCI) identity domain configuration for service initialization.  
Type: Boolean  
Required: No

## Response Elements
<a name="API_InitializeService_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_InitializeService_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_InitializeService_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/InitializeService) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/InitializeService) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/InitializeService) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/InitializeService) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/InitializeService) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/InitializeService) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/InitializeService) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/InitializeService) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/InitializeService) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/InitializeService) 

# ListAutonomousVirtualMachines
<a name="API_ListAutonomousVirtualMachines"></a>

Lists all Autonomous VMs in an Autonomous VM cluster.

## Request Syntax
<a name="API_ListAutonomousVirtualMachines_RequestSyntax"></a>

```
{
   "cloudAutonomousVmClusterId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListAutonomousVirtualMachines_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudAutonomousVmClusterId](#API_ListAutonomousVirtualMachines_RequestSyntax) **   <a name="odb-ListAutonomousVirtualMachines-request-cloudAutonomousVmClusterId"></a>
The unique identifier of the Autonomous VM cluster whose virtual machines you're listing.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

 ** [maxResults](#API_ListAutonomousVirtualMachines_RequestSyntax) **   <a name="odb-ListAutonomousVirtualMachines-request-maxResults"></a>
The maximum number of items to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListAutonomousVirtualMachines_RequestSyntax) **   <a name="odb-ListAutonomousVirtualMachines-request-nextToken"></a>
The pagination token to continue listing from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListAutonomousVirtualMachines_ResponseSyntax"></a>

```
{
   "autonomousVirtualMachines": [ 
      { 
         "autonomousVirtualMachineId": "string",
         "clientIpAddress": "string",
         "cloudAutonomousVmClusterId": "string",
         "cpuCoreCount": number,
         "dbNodeStorageSizeInGBs": number,
         "dbServerDisplayName": "string",
         "dbServerId": "string",
         "memorySizeInGBs": number,
         "ocid": "string",
         "ociResourceAnchorName": "string",
         "status": "string",
         "statusReason": "string",
         "vmName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListAutonomousVirtualMachines_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [autonomousVirtualMachines](#API_ListAutonomousVirtualMachines_ResponseSyntax) **   <a name="odb-ListAutonomousVirtualMachines-response-autonomousVirtualMachines"></a>
The list of Autonomous VMs in the specified Autonomous VM cluster.  
Type: Array of [AutonomousVirtualMachineSummary](API_AutonomousVirtualMachineSummary.md) objects

 ** [nextToken](#API_ListAutonomousVirtualMachines_ResponseSyntax) **   <a name="odb-ListAutonomousVirtualMachines-response-nextToken"></a>
The pagination token from which to continue listing.  
Type: String

## Errors
<a name="API_ListAutonomousVirtualMachines_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListAutonomousVirtualMachines_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListAutonomousVirtualMachines) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListAutonomousVirtualMachines) 

# ListCloudAutonomousVmClusters
<a name="API_ListCloudAutonomousVmClusters"></a>

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

## Request Syntax
<a name="API_ListCloudAutonomousVmClusters_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListCloudAutonomousVmClusters_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_ListCloudAutonomousVmClusters_RequestSyntax) **   <a name="odb-ListCloudAutonomousVmClusters-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Cloud Exadata Infrastructure that hosts the Autonomous VM clusters to be listed.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: No

 ** [maxResults](#API_ListCloudAutonomousVmClusters_RequestSyntax) **   <a name="odb-ListCloudAutonomousVmClusters-request-maxResults"></a>
The maximum number of items to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListCloudAutonomousVmClusters_RequestSyntax) **   <a name="odb-ListCloudAutonomousVmClusters-request-nextToken"></a>
The pagination token to continue listing from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListCloudAutonomousVmClusters_ResponseSyntax"></a>

```
{
   "cloudAutonomousVmClusters": [ 
      { 
         "autonomousDataStoragePercentage": number,
         "autonomousDataStorageSizeInTBs": number,
         "availableAutonomousDataStorageSizeInTBs": number,
         "availableContainerDatabases": number,
         "availableCpus": number,
         "cloudAutonomousVmClusterArn": "string",
         "cloudAutonomousVmClusterId": "string",
         "cloudExadataInfrastructureArn": "string",
         "cloudExadataInfrastructureId": "string",
         "computeModel": "string",
         "cpuCoreCount": number,
         "cpuCoreCountPerNode": number,
         "cpuPercentage": number,
         "createdAt": "string",
         "dataStorageSizeInGBs": number,
         "dataStorageSizeInTBs": number,
         "dbNodeStorageSizeInGBs": number,
         "dbServers": [ "string" ],
         "description": "string",
         "displayName": "string",
         "domain": "string",
         "exadataStorageInTBsLowestScaledValue": number,
         "hostname": "string",
         "iamRoles": [ 
            { 
               "awsIntegration": "string",
               "iamRoleArn": "string",
               "status": "string",
               "statusReason": "string"
            }
         ],
         "isMtlsEnabledVmCluster": boolean,
         "licenseModel": "string",
         "maintenanceWindow": { 
            "customActionTimeoutInMins": number,
            "daysOfWeek": [ 
               { 
                  "name": "string"
               }
            ],
            "hoursOfDay": [ number ],
            "isCustomActionTimeoutEnabled": boolean,
            "leadTimeInWeeks": number,
            "months": [ 
               { 
                  "name": "string"
               }
            ],
            "patchingMode": "string",
            "preference": "string",
            "skipRu": boolean,
            "weeksOfMonth": [ number ]
         },
         "maxAcdsLowestScaledValue": number,
         "memoryPerOracleComputeUnitInGBs": number,
         "memorySizeInGBs": number,
         "nodeCount": number,
         "nonProvisionableAutonomousContainerDatabases": number,
         "ocid": "string",
         "ociResourceAnchorName": "string",
         "ociUrl": "string",
         "odbNetworkArn": "string",
         "odbNetworkId": "string",
         "percentProgress": number,
         "provisionableAutonomousContainerDatabases": number,
         "provisionedAutonomousContainerDatabases": number,
         "provisionedCpus": number,
         "reclaimableCpus": number,
         "reservedCpus": number,
         "scanListenerPortNonTls": number,
         "scanListenerPortTls": number,
         "shape": "string",
         "status": "string",
         "statusReason": "string",
         "timeDatabaseSslCertificateExpires": "string",
         "timeOrdsCertificateExpires": "string",
         "timeZone": "string",
         "totalContainerDatabases": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListCloudAutonomousVmClusters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudAutonomousVmClusters](#API_ListCloudAutonomousVmClusters_ResponseSyntax) **   <a name="odb-ListCloudAutonomousVmClusters-response-cloudAutonomousVmClusters"></a>
The list of Autonomous VM clusters in the specified Cloud Exadata Infrastructure.  
Type: Array of [CloudAutonomousVmClusterSummary](API_CloudAutonomousVmClusterSummary.md) objects

 ** [nextToken](#API_ListCloudAutonomousVmClusters_ResponseSyntax) **   <a name="odb-ListCloudAutonomousVmClusters-response-nextToken"></a>
The pagination token to continue listing from.  
Type: String

## Errors
<a name="API_ListCloudAutonomousVmClusters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListCloudAutonomousVmClusters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListCloudAutonomousVmClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListCloudAutonomousVmClusters) 

# ListCloudExadataInfrastructures
<a name="API_ListCloudExadataInfrastructures"></a>

Returns information about the Exadata infrastructures owned by your AWS account.

## Request Syntax
<a name="API_ListCloudExadataInfrastructures_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListCloudExadataInfrastructures_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListCloudExadataInfrastructures_RequestSyntax) **   <a name="odb-ListCloudExadataInfrastructures-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListCloudExadataInfrastructures_RequestSyntax) **   <a name="odb-ListCloudExadataInfrastructures-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListCloudExadataInfrastructures_ResponseSyntax"></a>

```
{
   "cloudExadataInfrastructures": [ 
      { 
         "activatedStorageCount": number,
         "additionalStorageCount": number,
         "availabilityZone": "string",
         "availabilityZoneId": "string",
         "availableStorageSizeInGBs": number,
         "cloudExadataInfrastructureArn": "string",
         "cloudExadataInfrastructureId": "string",
         "computeCount": number,
         "computeModel": "string",
         "cpuCount": number,
         "createdAt": "string",
         "customerContactsToSendToOCI": [ 
            { 
               "email": "string"
            }
         ],
         "databaseServerType": "string",
         "dataStorageSizeInTBs": number,
         "dbNodeStorageSizeInGBs": number,
         "dbServerVersion": "string",
         "displayName": "string",
         "lastMaintenanceRunId": "string",
         "maintenanceWindow": { 
            "customActionTimeoutInMins": number,
            "daysOfWeek": [ 
               { 
                  "name": "string"
               }
            ],
            "hoursOfDay": [ number ],
            "isCustomActionTimeoutEnabled": boolean,
            "leadTimeInWeeks": number,
            "months": [ 
               { 
                  "name": "string"
               }
            ],
            "patchingMode": "string",
            "preference": "string",
            "skipRu": boolean,
            "weeksOfMonth": [ number ]
         },
         "maxCpuCount": number,
         "maxDataStorageInTBs": number,
         "maxDbNodeStorageSizeInGBs": number,
         "maxMemoryInGBs": number,
         "memorySizeInGBs": number,
         "monthlyDbServerVersion": "string",
         "monthlyStorageServerVersion": "string",
         "nextMaintenanceRunId": "string",
         "ocid": "string",
         "ociResourceAnchorName": "string",
         "ociUrl": "string",
         "percentProgress": number,
         "shape": "string",
         "status": "string",
         "statusReason": "string",
         "storageCount": number,
         "storageServerType": "string",
         "storageServerVersion": "string",
         "totalStorageSizeInGBs": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListCloudExadataInfrastructures_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudExadataInfrastructures](#API_ListCloudExadataInfrastructures_ResponseSyntax) **   <a name="odb-ListCloudExadataInfrastructures-response-cloudExadataInfrastructures"></a>
The list of Exadata infrastructures along with their properties.  
Type: Array of [CloudExadataInfrastructureSummary](API_CloudExadataInfrastructureSummary.md) objects

 ** [nextToken](#API_ListCloudExadataInfrastructures_ResponseSyntax) **   <a name="odb-ListCloudExadataInfrastructures-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

## Errors
<a name="API_ListCloudExadataInfrastructures_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListCloudExadataInfrastructures_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListCloudExadataInfrastructures) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListCloudExadataInfrastructures) 

# ListCloudVmClusters
<a name="API_ListCloudVmClusters"></a>

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

## Request Syntax
<a name="API_ListCloudVmClusters_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListCloudVmClusters_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_ListCloudVmClusters_RequestSyntax) **   <a name="odb-ListCloudVmClusters-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Oracle Exadata infrastructure.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: No

 ** [maxResults](#API_ListCloudVmClusters_RequestSyntax) **   <a name="odb-ListCloudVmClusters-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListCloudVmClusters_RequestSyntax) **   <a name="odb-ListCloudVmClusters-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListCloudVmClusters_ResponseSyntax"></a>

```
{
   "cloudVmClusters": [ 
      { 
         "cloudExadataInfrastructureArn": "string",
         "cloudExadataInfrastructureId": "string",
         "cloudVmClusterArn": "string",
         "cloudVmClusterId": "string",
         "clusterName": "string",
         "computeModel": "string",
         "cpuCoreCount": number,
         "createdAt": "string",
         "dataCollectionOptions": { 
            "isDiagnosticsEventsEnabled": boolean,
            "isHealthMonitoringEnabled": boolean,
            "isIncidentLogsEnabled": boolean
         },
         "dataStorageSizeInTBs": number,
         "dbNodeStorageSizeInGBs": number,
         "dbServers": [ "string" ],
         "diskRedundancy": "string",
         "displayName": "string",
         "domain": "string",
         "giVersion": "string",
         "hostname": "string",
         "iamRoles": [ 
            { 
               "awsIntegration": "string",
               "iamRoleArn": "string",
               "status": "string",
               "statusReason": "string"
            }
         ],
         "iormConfigCache": { 
            "dbPlans": [ 
               { 
                  "dbName": "string",
                  "flashCacheLimit": "string",
                  "share": number
               }
            ],
            "lifecycleDetails": "string",
            "lifecycleState": "string",
            "objective": "string"
         },
         "isLocalBackupEnabled": boolean,
         "isSparseDiskgroupEnabled": boolean,
         "lastUpdateHistoryEntryId": "string",
         "licenseModel": "string",
         "listenerPort": number,
         "memorySizeInGBs": number,
         "nodeCount": number,
         "ocid": "string",
         "ociResourceAnchorName": "string",
         "ociUrl": "string",
         "odbNetworkArn": "string",
         "odbNetworkId": "string",
         "percentProgress": number,
         "scanDnsName": "string",
         "scanDnsRecordId": "string",
         "scanIpIds": [ "string" ],
         "shape": "string",
         "sshPublicKeys": [ "string" ],
         "status": "string",
         "statusReason": "string",
         "storageSizeInGBs": number,
         "systemVersion": "string",
         "timeZone": "string",
         "vipIds": [ "string" ]
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListCloudVmClusters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudVmClusters](#API_ListCloudVmClusters_ResponseSyntax) **   <a name="odb-ListCloudVmClusters-response-cloudVmClusters"></a>
The list of VM clusters along with their properties.  
Type: Array of [CloudVmClusterSummary](API_CloudVmClusterSummary.md) objects

 ** [nextToken](#API_ListCloudVmClusters_ResponseSyntax) **   <a name="odb-ListCloudVmClusters-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

## Errors
<a name="API_ListCloudVmClusters_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListCloudVmClusters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListCloudVmClusters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListCloudVmClusters) 

# ListDbNodes
<a name="API_ListDbNodes"></a>

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

## Request Syntax
<a name="API_ListDbNodes_RequestSyntax"></a>

```
{
   "cloudVmClusterId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListDbNodes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_ListDbNodes_RequestSyntax) **   <a name="odb-ListDbNodes-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

 ** [maxResults](#API_ListDbNodes_RequestSyntax) **   <a name="odb-ListDbNodes-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListDbNodes_RequestSyntax) **   <a name="odb-ListDbNodes-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListDbNodes_ResponseSyntax"></a>

```
{
   "dbNodes": [ 
      { 
         "additionalDetails": "string",
         "backupIpId": "string",
         "backupVnic2Id": "string",
         "backupVnicId": "string",
         "cpuCoreCount": number,
         "createdAt": "string",
         "dbNodeArn": "string",
         "dbNodeId": "string",
         "dbNodeStorageSizeInGBs": number,
         "dbServerId": "string",
         "dbSystemId": "string",
         "faultDomain": "string",
         "hostIpId": "string",
         "hostname": "string",
         "maintenanceType": "string",
         "memorySizeInGBs": number,
         "ocid": "string",
         "ociResourceAnchorName": "string",
         "softwareStorageSizeInGB": number,
         "status": "string",
         "statusReason": "string",
         "timeMaintenanceWindowEnd": "string",
         "timeMaintenanceWindowStart": "string",
         "totalCpuCoreCount": number,
         "vnic2Id": "string",
         "vnicId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDbNodes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbNodes](#API_ListDbNodes_ResponseSyntax) **   <a name="odb-ListDbNodes-response-dbNodes"></a>
The list of DB nodes along with their properties.  
Type: Array of [DbNodeSummary](API_DbNodeSummary.md) objects

 ** [nextToken](#API_ListDbNodes_ResponseSyntax) **   <a name="odb-ListDbNodes-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

## Errors
<a name="API_ListDbNodes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListDbNodes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListDbNodes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListDbNodes) 

# ListDbServers
<a name="API_ListDbServers"></a>

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

## Request Syntax
<a name="API_ListDbServers_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListDbServers_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_ListDbServers_RequestSyntax) **   <a name="odb-ListDbServers-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Oracle Exadata infrastructure.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [maxResults](#API_ListDbServers_RequestSyntax) **   <a name="odb-ListDbServers-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListDbServers_RequestSyntax) **   <a name="odb-ListDbServers-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListDbServers_ResponseSyntax"></a>

```
{
   "dbServers": [ 
      { 
         "autonomousVirtualMachineIds": [ "string" ],
         "autonomousVmClusterIds": [ "string" ],
         "computeModel": "string",
         "cpuCoreCount": number,
         "createdAt": "string",
         "dbNodeStorageSizeInGBs": number,
         "dbServerId": "string",
         "dbServerPatchingDetails": { 
            "estimatedPatchDuration": number,
            "patchingStatus": "string",
            "timePatchingEnded": "string",
            "timePatchingStarted": "string"
         },
         "displayName": "string",
         "exadataInfrastructureId": "string",
         "maxCpuCount": number,
         "maxDbNodeStorageInGBs": number,
         "maxMemoryInGBs": number,
         "memorySizeInGBs": number,
         "ocid": "string",
         "ociResourceAnchorName": "string",
         "shape": "string",
         "status": "string",
         "statusReason": "string",
         "vmClusterIds": [ "string" ]
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDbServers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbServers](#API_ListDbServers_ResponseSyntax) **   <a name="odb-ListDbServers-response-dbServers"></a>
The list of database servers along with their properties.  
Type: Array of [DbServerSummary](API_DbServerSummary.md) objects

 ** [nextToken](#API_ListDbServers_ResponseSyntax) **   <a name="odb-ListDbServers-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

## Errors
<a name="API_ListDbServers_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListDbServers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListDbServers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListDbServers) 

# ListDbSystemShapes
<a name="API_ListDbSystemShapes"></a>

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

## Request Syntax
<a name="API_ListDbSystemShapes_RequestSyntax"></a>

```
{
   "availabilityZone": "string",
   "availabilityZoneId": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListDbSystemShapes_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [availabilityZone](#API_ListDbSystemShapes_RequestSyntax) **   <a name="odb-ListDbSystemShapes-request-availabilityZone"></a>
The logical name of the AZ, for example, us-east-1a. This name varies depending on the account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [availabilityZoneId](#API_ListDbSystemShapes_RequestSyntax) **   <a name="odb-ListDbSystemShapes-request-availabilityZoneId"></a>
The physical ID of the AZ, for example, use1-az4. This ID persists across accounts.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [maxResults](#API_ListDbSystemShapes_RequestSyntax) **   <a name="odb-ListDbSystemShapes-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListDbSystemShapes_RequestSyntax) **   <a name="odb-ListDbSystemShapes-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListDbSystemShapes_ResponseSyntax"></a>

```
{
   "dbSystemShapes": [ 
      { 
         "areServerTypesSupported": boolean,
         "availableCoreCount": number,
         "availableCoreCountPerNode": number,
         "availableDataStorageInTBs": number,
         "availableDataStoragePerServerInTBs": number,
         "availableDbNodePerNodeInGBs": number,
         "availableDbNodeStorageInGBs": number,
         "availableMemoryInGBs": number,
         "availableMemoryPerNodeInGBs": number,
         "computeModel": "string",
         "coreCountIncrement": number,
         "maximumNodeCount": number,
         "maxStorageCount": number,
         "minCoreCountPerNode": number,
         "minDataStorageInTBs": number,
         "minDbNodeStoragePerNodeInGBs": number,
         "minimumCoreCount": number,
         "minimumNodeCount": number,
         "minMemoryPerNodeInGBs": number,
         "minStorageCount": number,
         "name": "string",
         "runtimeMinimumCoreCount": number,
         "shapeFamily": "string",
         "shapeType": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListDbSystemShapes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbSystemShapes](#API_ListDbSystemShapes_ResponseSyntax) **   <a name="odb-ListDbSystemShapes-response-dbSystemShapes"></a>
The list of shapes and their properties.  
Type: Array of [DbSystemShapeSummary](API_DbSystemShapeSummary.md) objects

 ** [nextToken](#API_ListDbSystemShapes_ResponseSyntax) **   <a name="odb-ListDbSystemShapes-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

## Errors
<a name="API_ListDbSystemShapes_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListDbSystemShapes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListDbSystemShapes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListDbSystemShapes) 

# ListGiVersions
<a name="API_ListGiVersions"></a>

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

## Request Syntax
<a name="API_ListGiVersions_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "shape": "string"
}
```

## Request Parameters
<a name="API_ListGiVersions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListGiVersions_RequestSyntax) **   <a name="odb-ListGiVersions-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListGiVersions_RequestSyntax) **   <a name="odb-ListGiVersions-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [shape](#API_ListGiVersions_RequestSyntax) **   <a name="odb-ListGiVersions-request-shape"></a>
The shape to return GI versions for. For a list of valid shapes, use the `ListDbSystemShapes` operation..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## Response Syntax
<a name="API_ListGiVersions_ResponseSyntax"></a>

```
{
   "giVersions": [ 
      { 
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListGiVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [giVersions](#API_ListGiVersions_ResponseSyntax) **   <a name="odb-ListGiVersions-response-giVersions"></a>
The list of GI versions and their properties.  
Type: Array of [GiVersionSummary](API_GiVersionSummary.md) objects

 ** [nextToken](#API_ListGiVersions_ResponseSyntax) **   <a name="odb-ListGiVersions-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

## Errors
<a name="API_ListGiVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListGiVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListGiVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListGiVersions) 

# ListOdbNetworks
<a name="API_ListOdbNetworks"></a>

Returns information about the ODB networks owned by your AWS account.

## Request Syntax
<a name="API_ListOdbNetworks_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string"
}
```

## Request Parameters
<a name="API_ListOdbNetworks_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListOdbNetworks_RequestSyntax) **   <a name="odb-ListOdbNetworks-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListOdbNetworks_RequestSyntax) **   <a name="odb-ListOdbNetworks-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_ListOdbNetworks_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "odbNetworks": [ 
      { 
         "availabilityZone": "string",
         "availabilityZoneId": "string",
         "backupSubnetCidr": "string",
         "clientSubnetCidr": "string",
         "createdAt": "string",
         "customDomainName": "string",
         "defaultDnsPrefix": "string",
         "displayName": "string",
         "ec2PlacementGroupIds": [ "string" ],
         "managedServices": { 
            "crossRegionS3RestoreSourcesAccess": [ 
               { 
                  "ipv4Addresses": [ "string" ],
                  "region": "string",
                  "status": "string"
               }
            ],
            "kmsAccess": { 
               "domainName": "string",
               "ipv4Addresses": [ "string" ],
               "kmsPolicyDocument": "string",
               "status": "string"
            },
            "managedS3BackupAccess": { 
               "ipv4Addresses": [ "string" ],
               "status": "string"
            },
            "managedServicesIpv4Cidrs": [ "string" ],
            "resourceGatewayArn": "string",
            "s3Access": { 
               "domainName": "string",
               "ipv4Addresses": [ "string" ],
               "s3PolicyDocument": "string",
               "status": "string"
            },
            "serviceNetworkArn": "string",
            "serviceNetworkEndpoint": { 
               "vpcEndpointId": "string",
               "vpcEndpointType": "string"
            },
            "stsAccess": { 
               "domainName": "string",
               "ipv4Addresses": [ "string" ],
               "status": "string",
               "stsPolicyDocument": "string"
            },
            "zeroEtlAccess": { 
               "cidr": "string",
               "status": "string"
            }
         },
         "ociDnsForwardingConfigs": [ 
            { 
               "domainName": "string",
               "ociDnsListenerIp": "string"
            }
         ],
         "ociNetworkAnchorId": "string",
         "ociNetworkAnchorUrl": "string",
         "ociResourceAnchorName": "string",
         "ociVcnId": "string",
         "ociVcnUrl": "string",
         "odbNetworkArn": "string",
         "odbNetworkId": "string",
         "peeredCidrs": [ "string" ],
         "percentProgress": number,
         "status": "string",
         "statusReason": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOdbNetworks_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListOdbNetworks_ResponseSyntax) **   <a name="odb-ListOdbNetworks-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

 ** [odbNetworks](#API_ListOdbNetworks_ResponseSyntax) **   <a name="odb-ListOdbNetworks-response-odbNetworks"></a>
The list of ODB networks.  
Type: Array of [OdbNetworkSummary](API_OdbNetworkSummary.md) objects

## Errors
<a name="API_ListOdbNetworks_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListOdbNetworks_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListOdbNetworks) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListOdbNetworks) 

# ListOdbPeeringConnections
<a name="API_ListOdbPeeringConnections"></a>

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

## Request Syntax
<a name="API_ListOdbPeeringConnections_RequestSyntax"></a>

```
{
   "maxResults": number,
   "nextToken": "string",
   "odbNetworkId": "string"
}
```

## Request Parameters
<a name="API_ListOdbPeeringConnections_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [maxResults](#API_ListOdbPeeringConnections_RequestSyntax) **   <a name="odb-ListOdbPeeringConnections-request-maxResults"></a>
The maximum number of ODB peering connections to return in the response.  
Default: `20`   
Constraints:  
+ Must be between 1 and 100.
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListOdbPeeringConnections_RequestSyntax) **   <a name="odb-ListOdbPeeringConnections-request-nextToken"></a>
The pagination token for the next page of ODB peering connections.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [odbNetworkId](#API_ListOdbPeeringConnections_RequestSyntax) **   <a name="odb-ListOdbPeeringConnections-request-odbNetworkId"></a>
The identifier of the ODB network to list peering connections for.  
If not specified, lists all ODB peering connections in the account.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: No

## Response Syntax
<a name="API_ListOdbPeeringConnections_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "odbPeeringConnections": [ 
      { 
         "createdAt": "string",
         "displayName": "string",
         "odbNetworkArn": "string",
         "odbPeeringConnectionArn": "string",
         "odbPeeringConnectionId": "string",
         "odbPeeringConnectionType": "string",
         "peerNetworkArn": "string",
         "peerNetworkCidrs": [ "string" ],
         "percentProgress": number,
         "status": "string",
         "statusReason": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOdbPeeringConnections_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListOdbPeeringConnections_ResponseSyntax) **   <a name="odb-ListOdbPeeringConnections-response-nextToken"></a>
The pagination token for the next page of ODB peering connections.  
Type: String

 ** [odbPeeringConnections](#API_ListOdbPeeringConnections_ResponseSyntax) **   <a name="odb-ListOdbPeeringConnections-response-odbPeeringConnections"></a>
The list of ODB peering connections.  
Type: Array of [OdbPeeringConnectionSummary](API_OdbPeeringConnectionSummary.md) objects

## Errors
<a name="API_ListOdbPeeringConnections_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListOdbPeeringConnections_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListOdbPeeringConnections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListOdbPeeringConnections) 

# ListSystemVersions
<a name="API_ListSystemVersions"></a>

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

## Request Syntax
<a name="API_ListSystemVersions_RequestSyntax"></a>

```
{
   "giVersion": "string",
   "maxResults": number,
   "nextToken": "string",
   "shape": "string"
}
```

## Request Parameters
<a name="API_ListSystemVersions_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [giVersion](#API_ListSystemVersions_RequestSyntax) **   <a name="odb-ListSystemVersions-request-giVersion"></a>
The software version of the Exadata Grid Infrastructure (GI).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Required: Yes

 ** [maxResults](#API_ListSystemVersions_RequestSyntax) **   <a name="odb-ListSystemVersions-request-maxResults"></a>
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.  
Default: `10`   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [nextToken](#API_ListSystemVersions_RequestSyntax) **   <a name="odb-ListSystemVersions-request-nextToken"></a>
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8192.  
Required: No

 ** [shape](#API_ListSystemVersions_RequestSyntax) **   <a name="odb-ListSystemVersions-request-shape"></a>
The Exadata hardware system model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_ListSystemVersions_ResponseSyntax"></a>

```
{
   "nextToken": "string",
   "systemVersions": [ 
      { 
         "giVersion": "string",
         "shape": "string",
         "systemVersions": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_ListSystemVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_ListSystemVersions_ResponseSyntax) **   <a name="odb-ListSystemVersions-response-nextToken"></a>
The token to include in another request to get the next page of items. This value is `null` when there are no more items to return.  
Type: String

 ** [systemVersions](#API_ListSystemVersions_ResponseSyntax) **   <a name="odb-ListSystemVersions-response-systemVersions"></a>
The list of system versions.  
Type: Array of [SystemVersionSummary](API_SystemVersionSummary.md) objects

## Errors
<a name="API_ListSystemVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_ListSystemVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListSystemVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListSystemVersions) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Returns information about the tags applied to this resource.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "resourceArn": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="odb-ListTagsForResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to list tags for.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`   
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="odb-ListTagsForResource-response-tags"></a>
The list of tags applied to the resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/ListTagsForResource) 

# RebootDbNode
<a name="API_RebootDbNode"></a>

Reboots the specified DB node in a VM cluster.

## Request Syntax
<a name="API_RebootDbNode_RequestSyntax"></a>

```
{
   "cloudVmClusterId": "string",
   "dbNodeId": "string"
}
```

## Request Parameters
<a name="API_RebootDbNode_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_RebootDbNode_RequestSyntax) **   <a name="odb-RebootDbNode-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster that contains the DB node to reboot.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

 ** [dbNodeId](#API_RebootDbNode_RequestSyntax) **   <a name="odb-RebootDbNode-request-dbNodeId"></a>
The unique identifier of the DB node to reboot.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax
<a name="API_RebootDbNode_ResponseSyntax"></a>

```
{
   "dbNodeId": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_RebootDbNode_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbNodeId](#API_RebootDbNode_ResponseSyntax) **   <a name="odb-RebootDbNode-response-dbNodeId"></a>
The unique identifier of the DB node that was rebooted.  
Type: String

 ** [status](#API_RebootDbNode_ResponseSyntax) **   <a name="odb-RebootDbNode-response-status"></a>
The current status of the DB node after the reboot operation.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | STOPPING | STOPPED | STARTING` 

 ** [statusReason](#API_RebootDbNode_ResponseSyntax) **   <a name="odb-RebootDbNode-response-statusReason"></a>
Additional information about the status of the DB node after the reboot operation.  
Type: String

## Errors
<a name="API_RebootDbNode_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_RebootDbNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/RebootDbNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/RebootDbNode) 

# StartDbNode
<a name="API_StartDbNode"></a>

Starts the specified DB node in a VM cluster.

## Request Syntax
<a name="API_StartDbNode_RequestSyntax"></a>

```
{
   "cloudVmClusterId": "string",
   "dbNodeId": "string"
}
```

## Request Parameters
<a name="API_StartDbNode_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_StartDbNode_RequestSyntax) **   <a name="odb-StartDbNode-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster that contains the DB node to start.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

 ** [dbNodeId](#API_StartDbNode_RequestSyntax) **   <a name="odb-StartDbNode-request-dbNodeId"></a>
The unique identifier of the DB node to start.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax
<a name="API_StartDbNode_ResponseSyntax"></a>

```
{
   "dbNodeId": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_StartDbNode_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbNodeId](#API_StartDbNode_ResponseSyntax) **   <a name="odb-StartDbNode-response-dbNodeId"></a>
The unique identifier of the DB node that was started.  
Type: String

 ** [status](#API_StartDbNode_ResponseSyntax) **   <a name="odb-StartDbNode-response-status"></a>
The current status of the DB node after the start operation.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | STOPPING | STOPPED | STARTING` 

 ** [statusReason](#API_StartDbNode_ResponseSyntax) **   <a name="odb-StartDbNode-response-statusReason"></a>
Additional information about the status of the DB node after the start operation.  
Type: String

## Errors
<a name="API_StartDbNode_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_StartDbNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/StartDbNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/StartDbNode) 

# StopDbNode
<a name="API_StopDbNode"></a>

Stops the specified DB node in a VM cluster.

## Request Syntax
<a name="API_StopDbNode_RequestSyntax"></a>

```
{
   "cloudVmClusterId": "string",
   "dbNodeId": "string"
}
```

## Request Parameters
<a name="API_StopDbNode_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_StopDbNode_RequestSyntax) **   <a name="odb-StopDbNode-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster that contains the DB node to stop.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

 ** [dbNodeId](#API_StopDbNode_RequestSyntax) **   <a name="odb-StopDbNode-request-dbNodeId"></a>
The unique identifier of the DB node to stop.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax
<a name="API_StopDbNode_ResponseSyntax"></a>

```
{
   "dbNodeId": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_StopDbNode_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [dbNodeId](#API_StopDbNode_ResponseSyntax) **   <a name="odb-StopDbNode-response-dbNodeId"></a>
The unique identifier of the DB node that was stopped.  
Type: String

 ** [status](#API_StopDbNode_ResponseSyntax) **   <a name="odb-StopDbNode-response-status"></a>
The current status of the DB node after the stop operation.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | STOPPING | STOPPED | STARTING` 

 ** [statusReason](#API_StopDbNode_ResponseSyntax) **   <a name="odb-StopDbNode-response-statusReason"></a>
Additional information about the status of the DB node after the stop operation.  
Type: String

## Errors
<a name="API_StopDbNode_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_StopDbNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/StopDbNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/StopDbNode) 

# TagResource
<a name="API_TagResource"></a>

Applies tags to the specified resource.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="odb-TagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to apply tags to.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`   
Required: Yes

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="odb-TagResource-request-tags"></a>
The list of tags to apply to the resource.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
You have exceeded the service quota.    
 ** quotaCode **   
The unqiue identifier of the service quota that was exceeded.  
 ** resourceId **   
The identifier of the resource that exceeded the service quota.  
 ** resourceType **   
The type of resource that exceeded the service quota.
HTTP Status Code: 400

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Removes tags from the specified resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "resourceArn": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="odb-UntagResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource to remove tags from.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-z0-9-_]{6,64}`   
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="odb-UntagResource-request-tagKeys"></a>
The names (keys) of the tags to remove from the resource.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/UntagResource) 

# UpdateCloudExadataInfrastructure
<a name="API_UpdateCloudExadataInfrastructure"></a>

Updates the properties of an Exadata infrastructure resource.

## Request Syntax
<a name="API_UpdateCloudExadataInfrastructure_RequestSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "maintenanceWindow": { 
      "customActionTimeoutInMins": number,
      "daysOfWeek": [ 
         { 
            "name": "string"
         }
      ],
      "hoursOfDay": [ number ],
      "isCustomActionTimeoutEnabled": boolean,
      "leadTimeInWeeks": number,
      "months": [ 
         { 
            "name": "string"
         }
      ],
      "patchingMode": "string",
      "preference": "string",
      "skipRu": boolean,
      "weeksOfMonth": [ number ]
   }
}
```

## Request Parameters
<a name="API_UpdateCloudExadataInfrastructure_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudExadataInfrastructureId](#API_UpdateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-UpdateCloudExadataInfrastructure-request-cloudExadataInfrastructureId"></a>
The unique identifier of the Exadata infrastructure to update.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [maintenanceWindow](#API_UpdateCloudExadataInfrastructure_RequestSyntax) **   <a name="odb-UpdateCloudExadataInfrastructure-request-maintenanceWindow"></a>
The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.  
Type: [MaintenanceWindow](API_MaintenanceWindow.md) object  
Required: No

## Response Syntax
<a name="API_UpdateCloudExadataInfrastructure_ResponseSyntax"></a>

```
{
   "cloudExadataInfrastructureId": "string",
   "displayName": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_UpdateCloudExadataInfrastructure_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cloudExadataInfrastructureId](#API_UpdateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-UpdateCloudExadataInfrastructure-response-cloudExadataInfrastructureId"></a>
The unique identifier of the updated Exadata infrastructure.  
Type: String

 ** [displayName](#API_UpdateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-UpdateCloudExadataInfrastructure-response-displayName"></a>
The user-friendly name of the updated Exadata infrastructure.  
Type: String

 ** [status](#API_UpdateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-UpdateCloudExadataInfrastructure-response-status"></a>
The current status of the Exadata infrastructure after the update operation.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_UpdateCloudExadataInfrastructure_ResponseSyntax) **   <a name="odb-UpdateCloudExadataInfrastructure-response-statusReason"></a>
Additional information about the status of the Exadata infrastructure after the update operation.  
Type: String

## Errors
<a name="API_UpdateCloudExadataInfrastructure_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_UpdateCloudExadataInfrastructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/UpdateCloudExadataInfrastructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/UpdateCloudExadataInfrastructure) 

# UpdateOdbNetwork
<a name="API_UpdateOdbNetwork"></a>

Updates properties of a specified ODB network.

## Request Syntax
<a name="API_UpdateOdbNetwork_RequestSyntax"></a>

```
{
   "crossRegionS3RestoreSourcesToDisable": [ "string" ],
   "crossRegionS3RestoreSourcesToEnable": [ "string" ],
   "displayName": "string",
   "kmsAccess": "string",
   "kmsPolicyDocument": "string",
   "odbNetworkId": "string",
   "peeredCidrsToBeAdded": [ "string" ],
   "peeredCidrsToBeRemoved": [ "string" ],
   "s3Access": "string",
   "s3PolicyDocument": "string",
   "stsAccess": "string",
   "stsPolicyDocument": "string",
   "zeroEtlAccess": "string"
}
```

## Request Parameters
<a name="API_UpdateOdbNetwork_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [crossRegionS3RestoreSourcesToDisable](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-crossRegionS3RestoreSourcesToDisable"></a>
The cross-Region Amazon S3 restore sources to disable for the ODB network.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

 ** [crossRegionS3RestoreSourcesToEnable](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-crossRegionS3RestoreSourcesToEnable"></a>
The cross-Region Amazon S3 restore sources to enable for the ODB network.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

 ** [displayName](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-displayName"></a>
The new user-friendly name of the ODB network.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*`   
Required: No

 ** [kmsAccess](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-kmsAccess"></a>
The AWS Key Management Service (KMS) access configuration for the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [kmsPolicyDocument](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-kmsPolicyDocument"></a>
The AWS Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 20480.  
Required: No

 ** [odbNetworkId](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-odbNetworkId"></a>
The unique identifier of the ODB network to update.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [peeredCidrsToBeAdded](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-peeredCidrsToBeAdded"></a>
The list of CIDR ranges from the peered VPC that allow access to the ODB network.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

 ** [peeredCidrsToBeRemoved](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-peeredCidrsToBeRemoved"></a>
The list of CIDR ranges from the peered VPC to remove from the ODB network.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 1024 items.  
Required: No

 ** [s3Access](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-s3Access"></a>
Specifies the updated configuration for Amazon S3 access from the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [s3PolicyDocument](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-s3PolicyDocument"></a>
Specifies the updated endpoint policy for Amazon S3 access from the ODB network.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 20480.  
Required: No

 ** [stsAccess](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-stsAccess"></a>
The AWS Security Token Service (STS) access configuration for the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** [stsPolicyDocument](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-stsPolicyDocument"></a>
The AWS Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 20480.  
Required: No

 ** [zeroEtlAccess](#API_UpdateOdbNetwork_RequestSyntax) **   <a name="odb-UpdateOdbNetwork-request-zeroEtlAccess"></a>
Specifies the updated configuration for Zero-ETL access from the ODB network.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Syntax
<a name="API_UpdateOdbNetwork_ResponseSyntax"></a>

```
{
   "displayName": "string",
   "odbNetworkId": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_UpdateOdbNetwork_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [displayName](#API_UpdateOdbNetwork_ResponseSyntax) **   <a name="odb-UpdateOdbNetwork-response-displayName"></a>
The user-friendly name of the ODB network.  
Type: String

 ** [odbNetworkId](#API_UpdateOdbNetwork_ResponseSyntax) **   <a name="odb-UpdateOdbNetwork-response-odbNetworkId"></a>
The unique identifier of the ODB network.  
Type: String

 ** [status](#API_UpdateOdbNetwork_ResponseSyntax) **   <a name="odb-UpdateOdbNetwork-response-status"></a>
The current status of the ODB network.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_UpdateOdbNetwork_ResponseSyntax) **   <a name="odb-UpdateOdbNetwork-response-statusReason"></a>
Additional information about the status of the ODB network.  
Type: String

## Errors
<a name="API_UpdateOdbNetwork_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_UpdateOdbNetwork_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/UpdateOdbNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/UpdateOdbNetwork) 

# UpdateOdbPeeringConnection
<a name="API_UpdateOdbPeeringConnection"></a>

Modifies the settings of an Oracle Database@AWS peering connection. You can update the display name and add or remove CIDR blocks from the peering connection.

## Request Syntax
<a name="API_UpdateOdbPeeringConnection_RequestSyntax"></a>

```
{
   "displayName": "string",
   "odbPeeringConnectionId": "string",
   "peerNetworkCidrsToBeAdded": [ "string" ],
   "peerNetworkCidrsToBeRemoved": [ "string" ]
}
```

## Request Parameters
<a name="API_UpdateOdbPeeringConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [displayName](#API_UpdateOdbPeeringConnection_RequestSyntax) **   <a name="odb-UpdateOdbPeeringConnection-request-displayName"></a>
A new display name for the peering connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*`   
Required: No

 ** [odbPeeringConnectionId](#API_UpdateOdbPeeringConnection_RequestSyntax) **   <a name="odb-UpdateOdbPeeringConnection-request-odbPeeringConnectionId"></a>
The identifier of the Oracle Database@AWS peering connection to update.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 2048.  
Pattern: `(arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})`   
Required: Yes

 ** [peerNetworkCidrsToBeAdded](#API_UpdateOdbPeeringConnection_RequestSyntax) **   <a name="odb-UpdateOdbPeeringConnection-request-peerNetworkCidrsToBeAdded"></a>
A list of CIDR blocks to add to the peering connection. These CIDR blocks define the IP address ranges that can communicate through the peering connection. The CIDR blocks must not overlap with existing CIDR blocks in the Oracle Database@AWS network.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `(?:(?:\d|[01]?\d\d|2[0-4]\d|25[0-5])\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d|\d)\/(?:[1-2][0-9]|3[0-2]|[1-9])`   
Required: No

 ** [peerNetworkCidrsToBeRemoved](#API_UpdateOdbPeeringConnection_RequestSyntax) **   <a name="odb-UpdateOdbPeeringConnection-request-peerNetworkCidrsToBeRemoved"></a>
A list of CIDR blocks to remove from the peering connection. The CIDR blocks must currently exist in the peering connection.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 18.  
Pattern: `(?:(?:\d|[01]?\d\d|2[0-4]\d|25[0-5])\.){3}(?:25[0-5]|2[0-4]\d|[01]?\d\d|\d)\/(?:[1-2][0-9]|3[0-2]|[1-9])`   
Required: No

## Response Syntax
<a name="API_UpdateOdbPeeringConnection_ResponseSyntax"></a>

```
{
   "displayName": "string",
   "odbPeeringConnectionId": "string",
   "status": "string",
   "statusReason": "string"
}
```

## Response Elements
<a name="API_UpdateOdbPeeringConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [displayName](#API_UpdateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-UpdateOdbPeeringConnection-response-displayName"></a>
The display name of the peering connection.  
Type: String

 ** [odbPeeringConnectionId](#API_UpdateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-UpdateOdbPeeringConnection-response-odbPeeringConnectionId"></a>
The identifier of the Oracle Database@AWS peering connection that was updated.  
Type: String

 ** [status](#API_UpdateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-UpdateOdbPeeringConnection-response-status"></a>
The status of the peering connection update operation.  
Type: String  
Valid Values: `AVAILABLE | FAILED | PROVISIONING | TERMINATED | TERMINATING | UPDATING | MAINTENANCE_IN_PROGRESS` 

 ** [statusReason](#API_UpdateOdbPeeringConnection_ResponseSyntax) **   <a name="odb-UpdateOdbPeeringConnection-response-statusReason"></a>
Additional information about the status of the peering connection update operation.  
Type: String

## Errors
<a name="API_UpdateOdbPeeringConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.  
HTTP Status Code: 400

 ** ConflictException **   
Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.    
 ** resourceId **   
The identifier of the resource that caused the conflict.  
 ** resourceType **   
The type of resource that caused the conflict.
HTTP Status Code: 400

 ** InternalServerException **   
Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after an internal server error.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.    
 ** resourceId **   
The identifier of the resource that was not found.  
 ** resourceType **   
The type of resource that was not found.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request after being throttled.
HTTP Status Code: 400

 ** ValidationException **   
The request has failed validation because it is missing required fields or has invalid inputs.    
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason why the validation failed.
HTTP Status Code: 400

## See Also
<a name="API_UpdateOdbPeeringConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/UpdateOdbPeeringConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/UpdateOdbPeeringConnection)