openapi: 3.2.0
info:
  description: "<b>Microsoft Azure:</b> <br>\n<b>Oracle Azure Connector Resource:</b>:&nbsp;&nbsp;The Oracle Azure Connector Resource is used to install the Azure Arc Server on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster:\n<ul>\n <li>Using a Bearer Access Token</li>\n</ul>\n\n<b>Oracle Azure Blob Container Resource:</b>&nbsp;&nbsp;The Oracle Azure Blob Container Resource is used to capture the details of an Azure Blob Container. \nThis resource can then be reused across multiple Exadata VM clusters in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D) to mount the Azure container.\n\n<b>Oracle Azure Blob Mount Resource:</b>&nbsp;&nbsp;The Oracle Azure Blob Mount Resource is used to mount an Azure Blob Container on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\nIt relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.\n\n<b>Discover Azure Vaults and Keys Resource:</b>&nbsp;&nbsp;The Discover Oracle Azure Vaults and Azure Keys Resource is used to discover Azure Vaults and the associated encryption keys available in your Azure project.\n\n<b>Oracle Azure Vault:</b>&nbsp;&nbsp;The Oracle Azure Vault Resource is used to manage Azure Vaults within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.\n\n<b>Oracle Azure Key:</b>&nbsp;&nbsp;Oracle Azure Key Resource is used to register and manage a Oracle Azure Key Key within Oracle Cloud Infrastructure (OCI) under an associated Azure Vault.\n\n<br>\n\n<b>Google Cloud:</b><br>\n<b>Oracle Google Cloud Connector Resource:</b>&nbsp;&nbsp;The Oracle Google Cloud Connector Resource is used to install the Google Cloud Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n\n<b>Discover Google Key Rings and Keys Resource:</b>&nbsp;&nbsp;The Discover Google Key Rings and Keys Resource is used to discover Google Cloud Key Rings and the associated encryption keys available in your Google Cloud project.\n\n<b>Google Key Rings Resource:</b>&nbsp;&nbsp;The Google Key Rings Resource is used to register and manage Google Cloud Key Rings within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.\n\n<b>Google Key Resource:</b>&nbsp;&nbsp;The Google Key Resource is used to register and manage a Google Cloud Key within Oracle Cloud Infrastructure (OCI) under an associated Google Key Ring.\n<br>\n\n<b>AWS</b>:<br>\n<b>Oracle AWS Connector Resource:</b>&nbsp;&nbsp;The Oracle AWS Connector Resource is used to install the AWS Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n\n<b>Oracle AWS Key Resource:</b>&nbsp;&nbsp;The Oracle AWS Key Resource is used to register and manage a AWS Key within Oracle Cloud Infrastructure (OCI).\n"
  title: Oracle Database MultiCloud Data Plane Integration Db Multicloud Aws Provider API
  version: '20240501'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/70d1a303c64ae25a654e1897690653227087a9daff98ffa409104e364edd293c.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Database MultiCloud Data Plane Integration OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/70d1a303c64ae25a654e1897690653227087a9daff98ffa409104e364edd293c.yaml
    what: the harvested document for Oracle Database MultiCloud Data Plane Integration
servers:
- url: http://127.0.0.1/20240501
- url: https://127.0.0.1/20240501
tags:
- name: DbMulticloudAwsProvider
paths:
  /oracleDbAwsIdentityConnector:
    get:
      description: 'Lists all Oracle DB AWS Identity Connectors based on the specified filters.

        '
      operationId: ListOracleDbAwsIdentityConnectors
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OracleDbAwsIdentityConnectorDisplayNameQueryParam'
      - $ref: '#/components/parameters/OracleDbAwsIdentityConnectorLifecycleStateQueryParam'
      - $ref: '#/components/parameters/OracleDbResourceIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAwsIdentityConnectorSummaryCollection object.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAwsIdentityConnectorSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists all Oracle DB AWS Identity Connectors based on the specified filters.
      tags:
      - DbMulticloudAwsProvider
      x-example: 'GET /20240501/oracleDbAwsIdentityConnector

        Host: dbmulticloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsIdentityConnector'
    post:
      description: 'Creates Oracle DB AWS Identity Connector resource.

        '
      operationId: CreateOracleDbAwsIdentityConnector
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: 'Creates Oracle DB AWS Identity Connector Resource.

            '
          headers:
            content-location:
              description: URI of the resource
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URI of the resource
              schema:
                type: string
                format: uri-reference
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAwsIdentityConnector'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: 'Creates Oracle DB AWS Identity Connector resource.

        '
      tags:
      - DbMulticloudAwsProvider
      x-example: "POST /20240501/oracleDbAwsIdentityConnector\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\",\n  \"displayName\": \"Display Name\",\n  \"oidcScope\": \"oidcScope\",\n  \"issuerUrl\": \"issuerUrl\",\n  \"awsRoleArn\": \"awsRoleArn\",\n  \"awsLocation\": \"global\",\n  \"stsPrivateEndpoint\": \"string\",\n  \"kmsPrivateEndpoint\": \"string\",\n  \"awsAccountId\": \"awsAccountId\"\n}\n"
      x-related-resource: '#/definitions/OracleDbAwsIdentityConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOracleDbAwsIdentityConnectorDetails'
        description: 'Details for to Create Oracle DB AWS Identity Connector resource.

          '
        required: true
  /oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}:
    delete:
      description: 'Deletes a Oracle DB AWS Identity Connector resource.

        '
      operationId: DeleteOracleDbAwsIdentityConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsIdentityConnectorIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB AWS  Identity connector will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a Oracle DB AWS Identity Connector resource.
      tags:
      - DbMulticloudAwsProvider
      x-example: 'DELETE /20250501/oracleDbAwsIdentityConnector/<var>&lt;oracleDbAwsIdentityConnectorId&gt;</var>

        Host: dbmulticloud.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsIdentityConnector'
    get:
      description: 'Retrieves detailed information about a Oracle DB AWS Identity Connector resource by specifying its unique resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).

        '
      operationId: GetOracleDbAwsIdentityConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsIdentityConnectorIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAwsIdentityConnector object.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAwsIdentityConnector'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves detailed information about a Oracle DB AWS Identity Connector resource by specifying its unique resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
      tags:
      - DbMulticloudAwsProvider
      x-example: 'GET /20250501/oracleDbAwsIdentityConnector/<var>&lt;oracleDbAwsIdentityConnectorId&gt;</var>

        Host: dbmulticloud.us-ashburn-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsIdentityConnector'
    put:
      description: 'Modifies the existing Oracle DB AWS Identity Connector resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).

        '
      operationId: UpdateOracleDbAwsIdentityConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsIdentityConnectorIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB AWS Identity Connector will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Modifies the existing Oracle DB AWS Identity Connector resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
      tags:
      - DbMulticloudAwsProvider
      x-example: "PUT /20240501/oracleDbAwsIdentityConnector/<var>&lt;oracleDbAwsIdentityConnectorId&gt;</var>\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"id\": \"ocid1.oracledbawsconnector.oc1..<example_unique_ID>\",\n  \"displayName\": \"Display Name\",\n  \"oidcScope\": \"oidcScope\",\n  \"issuerUrl\": \"issuerUrl\",\n  \"awsRoleArn\": \"awsRoleArn\",\n  \"awsLocation\": \"global\",\n  \"awsStsPrivateEndpoint\": \"string\",\n  \"kmsPrivateEndpoint\": \"string\",\n  \"awsAccountId\": \"awsAccountId\",\n  \"freeformTags\": {\n    \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n  },\n  \"systemTags\": {}\n}\n"
      x-related-resource: '#/definitions/OracleDbAwsIdentityConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOracleDbAwsIdentityConnectorDetails'
        description: Details for to update OracleDbAwsIdentityConnector.
        required: true
  /oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}/actions/changeCompartment:
    post:
      description: Moves the Oracle DB AWS Identity Connector resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeOracleDbAwsIdentityConnectorCompartment
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsIdentityConnectorIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB AWS Identity Connector resource will be moved to the new compartment.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the Oracle DB AWS Identity Connector resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - DbMulticloudAwsProvider
      x-example: "POST /20240501/oracleDbAwsIdentityConnector/<var>&lt;oracleDbAwsIdentityConnectorId&gt;</var>/actions/changeCompartment\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\",\n}\n"
      x-related-resource: '#/definitions/OracleDbAwsIdentityConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeOracleDbAwsIdentityConnectorCompartmentDetails'
        description: Moves the Oracle DB AWS Identity COnnector resource into a different compartment.
        required: true
  /oracleDbAwsIdentityConnector/{oracleDbAwsIdentityConnectorId}/actions/refresh:
    post:
      description: 'Refreshes the Oracle DB AWS Connector resource.

        '
      operationId: RefreshOracleDbAwsIdentityConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsIdentityConnectorIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Accepted the request, The Oracle DB AWS Connector resource object will be synced with AWS Connector.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Refreshes the Oracle DB AWS Connector resource.
      tags:
      - DbMulticloudAwsProvider
      x-example: 'POST /20240501/racleDbAwsIdentityConnector/<var>&lt;oracleDbAwsIdentityConnectorId&gt;</var>

        Host: dbmulticloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsIdentityConnector'
  /oracleDbAwsKey:
    get:
      description: 'Lists all DB AWS Keys based on the specified filters.

        '
      operationId: ListOracleDbAwsKeys
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OracleAwsKeyDisplayNameQueryParam'
      - $ref: '#/components/parameters/OracleDbAwsKeyIdQueryParam'
      - $ref: '#/components/parameters/OracleDbAwsKeyLifecycleStateQueryParam'
      - $ref: '#/components/parameters/OracleDbAwsConnectorIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAwsKeySummaryCollection object.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAwsKeySummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists all DB AWS Keys based on the specified filters.
      tags:
      - DbMulticloudAwsProvider
      x-example: 'GET /20240501/oracleDbAwsKey

        Host: dbmulticloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsKey'
    post:
      description: 'Create DB AWS Key resource.

        '
      operationId: CreateOracleDbAwsKey
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: Create AWS Key resource.
          headers:
            content-location:
              description: URI of the resource
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URI of the resource
              schema:
                type: string
                format: uri-reference
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAwsKey'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: 'Create DB AWS Key resource.

        '
      tags:
      - DbMulticloudAwsProvider
      x-example: "POST /20240501/oracleDbAwsKey\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"TestDbAwsVault\",\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\",\n  \"oracleDbConnectorId\": \"ocid1.oracledbawsconnector.oc1.iad.<example_unique_ID>\",\n  \"awsKeyArn\":\"arn:aws:kms:us-east-1:123456789012:key/abcdefg1-2345-6789-abcd-ef1234567890\",\n  \"awsAccountId\": \"awsAccountId\",\n  \"freeformTags\": {\n    \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n  }\n}\n"
      x-related-resource: '#/definitions/OracleDbAwsKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOracleDbAwsKeyDetails'
        description: Details for to create AWS Key details.
        required: true
  /oracleDbAwsKey/{oracleDbAwsKeyId}:
    delete:
      description: 'Delete AWS Key resource.

        '
      operationId: DeleteOracleDbAwsKey
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsKeyIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Accepted the request, The AWS Key resource object will be deleted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete AWS Key resource.
      tags:
      - DbMulticloudAwsProvider
      x-example: 'DELETE /20240501/oracleDbAwsKey/<var>&lt;oracleDbAwsKeyId&gt;</var>

        Host: dbmulticloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsKey'
    get:
      description: 'Retrieves detailed information about a Oracle AWS Key resource by specifying its unique resource [OCID](/Content/General/Concepts/identifiers.htm).

        '
      operationId: GetOracleDbAwsKey
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsKeyIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAwsKey object.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAwsKey'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves detailed information about a Oracle AWS Key resource by specifying its unique resource [OCID](/Content/General/Concepts/identifiers.htm).
      tags:
      - DbMulticloudAwsProvider
      x-example: 'GET /20240501/oracleDbAwsKey/<var>&lt;OracleDbAwsKeyId&gt;</var>

        Host: dbmulticloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsKey'
    put:
      description: 'Modifies the existing Oracle AWS Key Details for a given [OCID](/Content/General/Concepts/identifiers.htm).

        '
      operationId: UpdateOracleDbAwsKey
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsKeyIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle AWS Key will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Modifies the existing Oracle AWS Key for a given [OCID](/Content/General/Concepts/identifiers.htm).
      tags:
      - DbMulticloudAwsProvider
      x-example: "PUT /20240501/oracleDbAwsKey/<var>&lt;racleDBAwsVaultId&gt;</var>\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"TestDBAwsUpdated\" ,\n  \"freeformTags\": {\n    \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n  }\n}\n"
      x-related-resource: '#/definitions/OracleDbAwsKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOracleDbAwsKeyDetails'
        description: Details for to update OracleDbAwsKey.
        required: true
  /oracleDbAwsKey/{oracleDbAwsKeyId}/actions/changeCompartment:
    post:
      description: Moves the AWS Key resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeOracleDbAwsKeyCompartment
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsKeyIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The AWS Key resource will be moved to the new compartment.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the AWS Key resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - DbMulticloudAwsProvider
      x-example: "POST /20240501/oracleDbAwsKey/<var>&lt;oracleDbAwsKeyId&gt;</var>/actions/changeCompartment\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\",\n}\n"
      x-related-resource: '#/definitions/OracleDbAwsKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeOracleDbAwsKeyCompartmentDetails'
        description: Moves the AWS Key resource into a different compartment.
        required: true
  /oracleDbAwsKey/{oracleDbAwsKeyId}/actions/refresh:
    post:
      description: 'Refreshes Oracle AWS Key resource.

        '
      operationId: RefreshOracleDbAwsKey
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsKeyIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Accepted the request, The Oracle AWS Key resource object will be synced with AWS Key resource.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Refreshes Oracle AWS Key resource.
      tags:
      - DbMulticloudAwsProvider
      x-example: 'POST /20240501/oracleDbAwsKey/<var>&lt;oracleDbAwsKeyId&gt;</var>/actions/refresh

        Host: dbmulticloud.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAwsKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshOracleDbAwsKeyDetails'
        description: Details for to refresh Oracle DB AWS Key.
        required: true
  /oracleDbAwsKey/{oracleDbAwsKeyId}/actions/replicate:
    post:
      description: 'Replicate Oracle AWS Key resource to target region.

        '
      operationId: ReplicateOracleDbAwsKey
      parameters:
      - $ref: '#/components/parameters/OracleDbAwsKeyIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Accepted the request, The Oracle AWS Key resource object will be synced with AWS Key resource.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Replicate Oracle AWS Key resource to target region.
      tags:
      - DbMulticloudAwsProvider
      x-example: "POST /20240501/oracleDbAwsKey/<var>&lt;oracleDbAwsKeyId&gt;</var>/actions/replicate\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n   \"targetRegion\": \"us-ashburn-1\",\n   \"action\": \"CREATE\n}\n"
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/OracleDbAwsKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplicateOracleDbAwsKeyDetails'
        description: Details for to replicate Oracle DB AWS Key to target region.
        required: true
components:
  schemas:
    OracleDbAwsKeySummary:
      description: 'Oracle Oracle DB AWS Key Resource Summary.

        '
      properties:
        awsAccountId:
          description: AWS Account ID.
          type: string
        awsKeyArn:
          description: Amazon resource name of AWS Key.
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment contains Oracle DB AWS Key resource.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB AWS Key resource name.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) for the new Oracle DB AWS Key resource.
          type: string
        isAwsKeyEnabled:
          description: The Oracle AWS Key resource is enabled or disabled at AWS.
          type: boolean
        lifecycleState:
          description: The current lifecycle state of the Oracle DB AWS Key resource.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAwsKey/lifecycleState'
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          type: string
        location:
          description: AWS Key resource location.
          type: string
        oracleDbConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource.
          type: string
        properties:
          additionalProperties:
            type: string
          description: AWS Key resource's properties.
          maxProperties: 20
          type: object
        replicationMetadata:
          $ref: '#/components/schemas/ReplicationMetadata'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'Time when the Oracle Oracle DB AWS Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the Oracle Oracle DB AWS Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''.

            '
          format: date-time
          type: string
        type:
          description: AWS Key resource type.
          type: string
      type: object
    AwsNodes:
      description: 'AWS Identity Connector Node Details.

        '
      properties:
        hostId:
          description: AWS host ID.
          maxLength: 255
          minLength: 1
          type: string
        hostName:
          description: AWS Host name or Identity Connector name.
          maxLength: 255
          minLength: 1
          type: string
        status:
          description: The current status of the AWS Identity Connector resource.
          enum:
          - CONNECTED
          - DISCONNECTED
          - UNKNOWN
          type: string
        timeLastChecked:
          description: 'Time when the AWS Identity Connector''s status was checked [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''.

            '
          format: date-time
          type: string
      type: object
    ServiceRoleDetails:
      description: Service Role details object.
      properties:
        assumeRoleStatus:
          description: Assume role  status.
          enum:
          - CONNECTED
          - DISCONNECTED
          - PARTIALLY_CONNECTED
          - UNKNOWN
          type: string
        awsNodes:
          description: List of all VMs where AWS Identity Connector is configured for Oracle DB Cloud VM Cluster.
          items:
            $ref: '#/components/schemas/AwsNodes'
          maxItems: 20
          minItems: 0
          type: array
        roleArn:
          description: Amazon resource name AWSof the IAM role.
          maxLength: 1024
          minLength: 1
          type: string
        servicePrivateEndpoint:
          description: Private endpoint of the AWS service.
          maxLength: 1024
          minLength: 1
          type: string
        serviceType:
          description: Type of service.
          enum:
          - KMS
          type: string
      required:
      - roleArn
      - servicePrivateEndpoint
      - serviceType
      type: object
    ServiceRoleDetail:
      description: Service Role details object.
      properties:
        roleArn:
          description: Amazon resource name AWSof the IAM role.
          maxLength: 1024
          minLength: 1
          type: string
        servicePrivateEndpoint:
          description: Private endpoint of the AWS service.
          maxLength: 1024
          minLength: 1
          type: string
        serviceType:
          description: Type of service.
          enum:
          - KMS
          type: string
      required:
      - roleArn
      - servicePrivateEndpoint
      - serviceType
      type: object
    Error:
      description: Error information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error message.
          type: string
      required:
      - code
      - message
    CreateOracleDbAwsKeyDetails:
      description: 'Create Oracle DB AWS Key object.

        '
      properties:
        awsAccountId:
          description: AWS Account ID.
          maxLength: 2048
          minLength: 1
          type: string
        awsKeyArn:
          description: Amazon resource name of AWS Key.
          maxLength: 2048
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB AWS Key resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB AWS Key resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        isAwsKeyEnabled:
          description: The Oracle AWS Key resource is enabled or disabled at AWS.
          type: boolean
        location:
          description: AWS Key resource Location.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            type: string
          description: AWS Key resource's properties.
          maxProperties: 20
          type: object
        type:
          description: AWS Key resource type.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - displayName
      - oracleDbConnectorId
      type: object
    OracleDbAwsKeySummaryCollection:
      description: List of OracleDbAwsKeySummary resources.
      properties:
        items:
          description: This list contains the summary of Oracle DB AWS Key resources.
          items:
            $ref: '#/components/schemas/OracleDbAwsKeySummary'
          type: array
      required:
      - items
      type: object
    OracleDbAwsIdentityConnectorSummary:
      description: 'Oracle DB AWS Identity Connector resource summary.

        '
      properties:
        awsAccountId:
          description: AWS Account ID.
          type: string
        awsLocation:
          description: AWS resource location.
          type: string
        awsStsPrivateEndpoint:
          description: Private endpoint of AWS Security Token Service.
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB Identity Connector resource.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB AWS Identity Connector resource name.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Identity Connector resource.
          type: string
        issuerUrl:
          description: OIDC token issuer Url.
          type: string
        lifecycleState:
          description: The current lifecycle state of the AWS Identity Connector resource.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAwsIdentityConnector/lifecycleState'
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          type: string
        oidcScope:
          description: OCI IAM Domain scope for issuer URL.
          type: string
        resourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AWS VM Cluster resource.
          type: string
        serviceRoleDetails:
          description: 'Service role details and respective Amazon resource nam of Role.

            '
          items:
            $ref: '#/components/schemas/ServiceRoleDetails'
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'Time when the Oracle DB AWS Identity Connector resource was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the Oracle DB AWS Identity Connector resource was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''.

            '
          format: date-time
          type: string
      type: object
    RefreshOracleDbAwsKeyDetails:
      description: Details for to refresh Oracle DB AWS Key resource.
      properties:
        oracleDbAwsConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Connector resource.
          maxLength: 255
          minLength: 1
          type: string
    ChangeOracleDbAwsKeyCompartmentDetails:
      description: Details of the new compartment to contain the Oracle DB AWS Key resource.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the new compartment to contain the Oracle DB AWS Key resource.
          maxLength: 255
          minLength: 1
          type: string
    UpdateOracleDbAwsKeyDetails:
      description: 'Update Oracle DB AWS Key resource object.

        '
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB AWS Key resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
      type: object
    ChangeOracleDbAwsIdentityConnectorCompartmentDetails:
      description: Details of the new compartment to contain the Oracle DB AWS Identity Connector resource.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the new compartment to contain the Oracle DB AWS Identity Connector resource.
          maxLength: 255
          minLength: 1
          type: string
    CreateOracleDbAwsIdentityConnectorDetails:
      description: 'Create Oracle DB AWS Identity Connector resource object.

        '
      properties:
        awsAccountId:
          description: AWS Account ID.
          maxLength: 1024
          minLength: 1
          type: string
        awsLocation:
          description: AWS resource location.
          maxLength: 1024
          minLength: 1
          type: string
        awsStsPrivateEndpoint:
          description: Private endpoint of AWS Security Token Service.
          maxLength: 1024
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB AWS Identity Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB Google AWS Identity Connector resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        issuerUrl:
          description: OIDC token issuer Url.
          maxLength: 1024
          minLength: 1
          type: string
        oidcScope:
          description: OCI IAM Domain scope for issuer URL.
          maxLength: 255
          minLength: 1
          type: string
        resourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AWS VM Cluster resource.
          maxLength: 255
          minLength: 1
          type: string
        serviceRoleDetails:
          description: 'Service role details and respective Amazon resource nam of Role.

            '
          items:
            $ref: '#/components/schemas/ServiceRoleDetail'
          type: array
      required:
      - compartmentId
      - resourceId
      - displayName
      - oidcScope
      - issuerUrl
      - serviceRoleDetails
      - awsLocation
      type: object
    OracleDbAwsIdentityConnectorSummaryCollection:
      description: List of OracleDbAwsIdentityConnectorSummary resources.
      properties:
        items:
          description: This list contains the summary of Oracle DB AWS Identity Connector resources.
          items:
            $ref: '#/components/schemas/OracleDbAwsIdentityConnectorSummary'
          type: array
      required:
      - items
      type: object
    UpdateOracleDbAwsIdentityConnectorDetails:
      description: 'This object is about to provide input params to create Oracle DB AWS Identity Connector Resource.

        '
      properties:
        awsAccountId:
          description: AWS Account ID.
          maxLength: 1024
          minLength: 1
          type: string
        awsLocation:
          description: AWS resource Location.
          maxLength: 1024
          minLength: 1
          type: string
        awsStsPrivateEndpoint:
          description: Private endpoint of AWS Security Token Service.
          maxLength: 1024
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB Google AWS Identity Connector resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        issuerUrl:
          description: OIDC token issuer Url.
          maxLength: 1024
          minLength: 1
          type: string
        oidcScope:
          description: IAM Domain scope for issuer URL.
          maxLength: 255
          minLength: 1
          type: string
        resourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AWS VM Cluster resource.
          maxLength: 255
          minLength: 1
          type: string
        serviceRoleDetails:
          description: 'Service role details and respective Amazon resource nam of Role.

            '
          items:
            $ref: '#/components/schemas/ServiceRoleDetail'
          type: array
      type: object
    ReplicateOracleDbAwsKeyDetails:
      description: 'Replicate Oracle AWS Key resource.

        '
      properties:
        action:
          description: Action for replicate Resource.
          enum:
          - CREATE
          - DELETE
          type: string
          x-obmcs-top-level-enum: '#/definitions/ReplicationActions'
        targetRegion:
          description: The Destination region where Oracle AWS Key resource will replicate.
          type: string
      required:
      - targetRegion
      - action
      type: object
    ReplicationMetadata:
      description: 'Replication metadata, it has information about replication and target region.

        '
      properties:
        replicationDetails:
          description: List of all regions and their respective resource ID.
          items:
            $ref: '#/components/schemas/ReplicationDetails'
          maxItems: 20
          minItems: 0
          type: array
      type: object
    ReplicationDetails:
      description: 'Replication metadata details, targeted regions and respective replication state, time created or time when it was updated.

        '
      properties:
        replicationState:
          description: The lifecycle state of the Oracle DB Azure Vault resource.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          type: string
        targetRegion:
          description: The target region, where resource is replicated.
          maxLength: 255
          minLength: 0
          type: string
        timeCreated:
          description: 'Time when the Replication was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the Replication was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
      type: object
    OracleDbAwsKey:
      description: 'Oracle DB AWS Key Resource object.

        '
      properties:
        awsAccountId:
          description: AWS Account ID.
          maxLength: 2048
          minLength: 1
          type: string
        awsKeyArn:
          description: Amazon resource name of AWS Key.
          maxLength: 2048
          minLength: 1
          type: string
        compartmentId:
          description: The Compartment [OCID](/Content/General/Concepts/identifiers.htm) that contains this Oracle DB AWS Key resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB AWS Key Ring resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the DB AWS Key Ring resource.
          maxLength: 255
          minLength: 1
          type: string
        isAwsKeyEnabled:
          description: The Oracle AWS Key resource is enabled or disabled at AWS.
          type: boolean
        lifecycleState:
          description: The lifecycle state of the Oracle DB AWS Key resource.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          type: string
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          maxLength: 1024
          minLength: 1
          type: string
        location:
          description: AWS Key resource location.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            type: string
          description: AWS Key resource's properties.
          maxProperties: 20
          type: object
        replicationMetadata:
          $ref: '#/components/schemas/ReplicationMetadata'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'Time when the DB AWS Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the DB AWS Key resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''.

            '
          format: date-time
          type: string
        type:
          description: Key resource type.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - compartmentId
      type: object
    OracleDbAwsIdentityConnector:
      description: 'Oracle DB AWS Connector resource object.

        '
      properties:
        awsAccountId:
          description: AWS Account ID.
          maxLength: 1024
          minLength: 1
          type: string
        awsLocation:
          description: AWS resource location.
          maxLength: 1024
          minLength: 1
          type: string
        awsStsPrivateEndpoint:
          description: Private endpoint of AWS Security Token Service.
          maxLength: 1024
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB AWS Identity Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB AWS Identity Connector resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Identity Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        issuerUrl:
          description: OIDC token issuer Url.
          maxLength: 1024
          minLength: 1
          type: string
        lifecycleState:
          description: The current lifecycle state of the AWS Identity Connector resource.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          type: string
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          maxLength: 1024
          minLength: 1
          type: string
        oidcScope:
          description: OCI IAM Domain scope for issuer URL.
          maxLength: 255
          minLength: 1
          type: string
        resourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AWS VM Cluster resource.
          maxLength: 255
          minLength: 1
          type: string
        serviceRoleDetails:
          description: 'Service role details and respective Amazon resource nam of Role.

            '
          items:
            $ref: '#/components/schemas/ServiceRoleDetails'
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'Time when the Oracle DB AWS Identity Connector resource was created expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the Oracle DB AWS Identity Connector resource was last modified expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - resourceId
      - issuerUrl
      - serviceRoleDetails
      - awsLocation
      type: object
  parameters:
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, default is timeCreated.

        '
      in: query
      name: sortBy
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    OracleAwsKeyDisplayNameQueryParam:
      description: A filter to return Oracle DB AWS Key Resource that match the given display name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDbAwsIdentityConnectorIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm)  of the Oracle DB AWS Identity Connector resource.
      in: path
      name: oracleDbAwsIdentityConnectorId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDbAwsConnectorIdQueryParam:
      description: A filter to return Oracle DB AWS Identity Connector resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Identity Connector resource.
      in: query
      name: oracleDbAwsConnectorId
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    CompartmentIdQueryParam:
      description: The [ID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
      in: query
      name: compartmentId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      x-default-description: 'null'
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    OracleDbAwsKeyIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Key resource.
      in: path
      name: oracleDbAwsKeyId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDbAwsKeyIdQueryParam:
      description: A filter to return Oracle DB AWS Identity Connector Resource that match the given OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB AWS Key resource.
      in: query
      name: oracleDbAwsKeyId
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDbAwsKeyLifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/OracleDbAwsKey/lifecycleState'
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.


        Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.


        For example, if a resource has been deleted and permanently purged from the system, a retry of the original creation request may be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    OracleDbAwsIdentityConnectorLifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/OracleDbAwsIdentityConnector/lifecycleState'
      schema:
        type: string
    OracleDbAwsIdentityConnectorDisplayNameQueryParam:
      description: A filter to return Oracle DB AWS Identity Connector Resource that match the given display name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDbResourceIdQueryParam:
      description: A filter to return Oracle DB Identity Connector resource that match the given resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
      in: query
      name: resourceId
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

        important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

        Use GetWorkRequest with this ID to track the status of the request.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    content-location:
      description: URI of the resource
      format: uri-reference
      type: string
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


          Example: `{"CostCenter": "42"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Department": "Finance"}`

        '
      type: object
    location:
      description: URI of the resource
      format: uri-reference
      type: string
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


          Example: `{"free-tier-retained": "true"}`

          '
        type: object
      description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.db.mci.azure.identity