openapi: 3.2.0
info:
  description: Manage Oracle Cloud Infrastructure console announcements.
  title: Announcements Service Announcement Subscription API
  version: 0.0.1
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/ad81e510c25e589a2fdfbfe0fb957253a658175b2922b7951ddb17b4910c849b.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Announcements Service API 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/ad81e510c25e589a2fdfbfe0fb957253a658175b2922b7951ddb17b4910c849b.yaml
    what: the harvested document for Announcements Service API
servers:
- url: http://127.0.0.1/20180904
- url: https://127.0.0.1/20180904
tags:
- name: announcementSubscription
paths:
  /announcementSubscriptions:
    get:
      description: 'Gets a list of all announcement subscriptions in the specified compartment.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: ListAnnouncementSubscriptions
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/LifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The list of announcement subscription summary objects for the specified compartment.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              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/AnnouncementSubscriptionCollection'
        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: Gets a list of announcement subscriptions.
      tags:
      - announcementSubscription
      x-example: 'GET /20180904/announcementSubscriptions?compartmentId=<var>&lt;compartmentId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/AnnouncementSubscriptionCollection'
    post:
      description: 'Creates a new announcement subscription.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: CreateAnnouncementSubscription
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The announcement subscription has been created.
          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/AnnouncementSubscription'
        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 a new announcement subscription.
      tags:
      - announcementSubscription
      x-example: "POST /20180904/announcementSubscriptions\nHost: announcements.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n  \"definedTags\": {},\n  \"description\": \"announcements for Brazil region required and recommended actions\",\n  \"displayName\": \"subscription-brazilactions\",\n  \"filterGroups\": {\n    \"filterbybrazilactions\": {\n      \"filters\": [\n        {\n          \"type\": \"REGION\",\n          \"value\": \"Brazil East (Sao Paulo)\"\n        },\n        {\n          \"type\": \"REGION\",\n          \"value\": \"Brazil Southeast (Vinhedo)\"\n        },\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_RECOMMENDED\"\n        },\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_REQUIRED\"\n        }\n      ]\n    }\n  }\n  \"freeformTags\": {},\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.examplea4s4glpxfc22s7tmcvbitc7yiyjpft2faux3yb2oya2hihkyzieia\"\n}\n"
      x-related-resource: '#/definitions/AnnouncementSubscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAnnouncementSubscriptionDetails'
        description: Details of the new announcement subscription.
        required: true
  /announcementSubscriptions/{announcementSubscriptionId}:
    delete:
      description: 'Deletes the specified announcement subscription.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: DeleteAnnouncementSubscription
      parameters:
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The announcement subscription has been 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
        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 provisioned announcement subscription.
      tags:
      - announcementSubscription
      x-example: 'DELETE /20180904/announcementSubscriptions/<var>&lt;subscriptionId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/AnnouncementSubscription'
    get:
      description: 'Gets the specified announcement subscription.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: GetAnnouncementSubscription
      parameters:
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The announcement subscription with the given identifier.
          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/AnnouncementSubscription'
        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: Gets an announcement subscription.
      tags:
      - announcementSubscription
      x-example: 'GET /20180904/announcementSubscriptions/<var>&lt;subscriptionId&gt;</var>

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

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

        '
    put:
      description: 'Updates the specified announcement subscription.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: UpdateAnnouncementSubscription
      parameters:
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The announcement subscription has been updated.
          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/AnnouncementSubscription'
        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: Updates an announcement subscription.
      tags:
      - announcementSubscription
      x-example: "POST /20180904/announcementSubscriptions\nHost: announcements.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"definedTags\": {},\n  \"description\": \"announcements for Brazil region (required and recommended actions)\",\n  \"displayName\": \"subscription-brazilactions\",\n  \"freeformTags\": {},\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.examplea4s4glpxfc22s7tmcvbitc7yiyjpft2faux3yb2oya2hihkyzieia\",\n  \"preferredTimeZone\": \"America/Los_Angeles\"\n}\n"
      x-related-resource: '#/definitions/AnnouncementSubscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAnnouncementSubscriptionDetails'
        description: The subscription information to update.
        required: true
  /announcementSubscriptions/{announcementSubscriptionId}/actions/changeCompartment:
    post:
      description: 'Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: ChangeAnnouncementSubscriptionCompartment
      parameters:
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: The announcement subscription has been moved to a different compartment.
          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
        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'
      summary: Moves an announcement subscription to a different compartment.
      tags:
      - announcementSubscription
      x-example: "POST /20180904/announcementSubscriptions/<var>&lt;subscriptionId&gt;</var>/actions/changeCompartme\nHost: announcements.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\"\n}\n"
      x-related-resource: '#/definitions/AnnouncementSubscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeAnnouncementSubscriptionCompartmentDetails'
        description: The compartment information to update.
        required: true
  /announcementSubscriptions/{announcementSubscriptionId}/filterGroups:
    post:
      description: 'Creates a new filter group in the specified announcement subscription.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: CreateFilterGroup
      parameters:
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The filter group has been created.
          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/FilterGroup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new filter group in an announcement subscription.
      tags:
      - announcementSubscription
      x-example: "POST /20180904/announcementSubscriptions/<var>&lt;subscriptionId&gt;</var>/filterGroups\nHost: announcements.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"name\": \"filterbycomputerequiredactions\",\n  \"filters\": [\n    {\n      \"type\": \"ANNOUNCEMENT_TYPE\",\n      \"value\": \"ACTION_REQUIRED\"\n    },\n    {\n      \"type\": \"SERVICE\",\n      \"value\": \"Oracle Cloud Infrastructure Compute\"\n    }\n  ]\n}\n"
      x-related-resource: '#/definitions/AnnouncementSubscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFilterGroupDetails'
        description: Details of the new filter group.
        required: true
  /announcementSubscriptions/{announcementSubscriptionId}/filterGroups/{filterGroupName}:
    delete:
      description: 'Deletes a filter group in the specified announcement subscription.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: DeleteFilterGroup
      parameters:
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierPathParam'
      - $ref: '#/components/parameters/FilterGroupNamePathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: The filter group has been deleted.
          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
        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: Deletes a filter group in an announcement subscription.
      tags:
      - announcementSubscription
      x-related-resource: '#/definitions/AnnouncementSubscription'
    put:
      description: 'Updates a filter group in the specified announcement subscription.


        This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

        '
      operationId: UpdateFilterGroup
      parameters:
      - $ref: '#/components/parameters/AnnouncementSubscriptionIdentifierPathParam'
      - $ref: '#/components/parameters/FilterGroupNamePathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The filter group has been updated.
          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/FilterGroup'
        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: Updates a filter group in an announcement subscription.
      tags:
      - announcementSubscription
      x-example: "POST /20180904/announcementSubscriptions/<var>&lt;subscriptionId&gt;</var>/filterGroups/<var>&lt;filtergroupname&gt;</var>\nHost: announcements.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"name\": \"filterbyiaasus\",\n  \"filters\": [\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US East (Ashburn)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (Phoenix)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (San Jose)\"\n    },\n    {\n      \"type\": \"PLATFORM_TYPE\",\n      \"value\": \"IAAS\"\n  ]\n}\n"
      x-related-resource: '#/definitions/AnnouncementSubscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFilterGroupDetails'
        description: The filter group information to update.
        required: true
components:
  parameters:
    PaginationTokenQueryParam:
      description: The value of the `opc-next-page` response header from the previous "List" call.
      in: query
      name: page
      schema:
        type: string
        maxLength: 3000
        minLength: 1
    SortByQueryParam:
      description: 'The criteria to sort by. You can specify only one sort order. The default sort order for the creation date of resources is descending. The default sort order for display names is ascending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    AnnouncementSubscriptionIdentifierPathParam:
      description: The OCID of the announcement subscription.
      in: path
      name: announcementSubscriptionId
      required: true
      schema:
        type: string
    CompartmentIdQueryParam:
      description: 'The OCID of the compartment.

        '
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 512
        minLength: 1
    IfMatchHeader:
      description: The locking version, used for optimistic concurrency control.
      in: header
      name: if-match
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return in a paginated "List" call.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    AnnouncementSubscriptionIdentifierQueryParam:
      description: The OCID of the announcement subscription.
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, whether ascending ('ASC') or descending ('DESC').
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is ''DESC'' when sorting by time and ''ASC'' otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    FilterGroupNamePathParam:
      description: The name of the filter group.
      in: path
      name: filterGroupName
      required: true
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire display name given.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about

        a particular request, please provide the complete request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    LifecycleStateQueryParam:
      description: A filter to return only announcement subscriptions that match the given lifecycle state.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/AnnouncementSubscription/lifecycleState'
      schema:
        type: string
  schemas:
    CreateAnnouncementSubscriptionDetails:
      description: The details for creating a new announcement subscription.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the announcement subscription.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: A description of the announcement subscription. Avoid entering confidential information.
          maxLength: 400
          type: string
        displayName:
          description: A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        filterGroups:
          additionalProperties:
            $ref: '#/components/schemas/FilterGroupDetails'
          description: 'A list of filter groups for the announcement subscription. A filter group combines one or more filters that the Announcements service applies to announcements for matching purposes.

            '
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        onsTopicId:
          description: 'The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see [Details for Notifications](/Content/Identity/policyreference/notificationpolicyreference.htm).

            '
          type: string
        preferredLanguage:
          default: en-US
          description: (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
          example: fr-FR
          format: x-obmcs-human-language
          type: string
        preferredTimeZone:
          default: UTC
          description: The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
          example: America/Los_Angeles
          format: x-obmcs-time-zone
          type: string
      required:
      - compartmentId
      - displayName
      - onsTopicId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n  \"definedTags\": {},\n  \"description\": \"announcements for Brazil region required and recommended actions\",\n  \"displayName\": \"subscription-brazilactions\",\n  \"filterGroups\": {\n    \"filterbybrazilactions\": {\n      \"filters\": [\n        {\n          \"type\": \"REGION\",\n          \"value\": \"Brazil East (Sao Paulo)\"\n        },\n        {\n          \"type\": \"REGION\",\n          \"value\": \"Brazil Southeast (Vinhedo)\"\n        },\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_RECOMMENDED\"\n        },\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_REQUIRED\"\n        }\n      ]\n    }\n  }\n  \"freeformTags\": {},\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.examplea4s4glpxfc22s7tmcvbitc7yiyjpft2faux3yb2oya2hihkyzieia\"\n}\n"
    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 string.
          type: string
      required:
      - code
      - message
    UpdateAnnouncementSubscriptionDetails:
      description: The details for updating an announcement subscription.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: A description of the announcement subscription. Avoid entering confidential information.
          maxLength: 400
          type: string
        displayName:
          description: A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        onsTopicId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription. The caller of the operation needs the ONS_TOPIC_PUBLISH permission for the targeted Notifications service topic. For more information about Notifications permissions, see [Details for Notifications](/Content/Identity/policyreference/notificationpolicyreference.htm).

            '
          type: string
        preferredLanguage:
          default: en-US
          description: (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
          example: fr-FR
          format: x-obmcs-human-language
          type: string
        preferredTimeZone:
          default: UTC
          description: The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
          example: America/Los_Angeles
          format: x-obmcs-time-zone
          type: string
      type: object
      x-example: "{\n  \"definedTags\": {},\n  \"description\": \"announcements for Brazil region (required and recommended actions)\",\n  \"displayName\": \"subscription-brazilactions\",\n  \"freeformTags\": {},\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.examplea4s4glpxfc22s7tmcvbitc7yiyjpft2faux3yb2oya2hihkyzieia\",\n  \"preferredTimeZone\": \"America/Los_Angeles\"\n}\n"
    AnnouncementSubscriptionCollection:
      description: The results of a search for announcement subscriptions. This object contains both announcement subscription summary objects and other information, such as metadata.
      properties:
        items:
          description: A list of announcement subscriptions.
          items:
            $ref: '#/components/schemas/AnnouncementSubscriptionSummary'
          type: array
      required:
      - items
      type: object
      x-example: "{\n  \"items\": [\n    {\n      \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaial3u5l6cvbwelj37dbuxl5fauxv3ux54jbn2mewx3ddna\",\n      \"displayName\": \"announcement-subscription-5\",\n      \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n      \"timeCreated\": \"2023-09-18T22:45:27.948Z\",\n      \"timeUpdated\": \"2023-01-06T23:19:27.948Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"lifecycleDetails\": null,\n      \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleagbx3or53zcvboatv24o5k4yyvnrph2fauxpekkwgovs7ue7mtixa\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    },\n    {\n      \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaiam2cvbefolukref6a3f323ffauxixzktfy37nmjf37nvq\",\n      \"displayName\": \"announcement-subscription-2\",\n      \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n      \"timeCreated\": \"2022-09-18T23:14:05.756Z\",\n      \"timeUpdated\": \"2022-09-18T23:14:05.756Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"lifecycleDetails\": null,\n      \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleay4zq6zpisulo6cvb4hy3cjaljxo2e35fauxkamd7jnwkhalztpkq\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    },\n    {\n      \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaiacfq6oa5cvbt2csvefzddrex4kcoezc2yzekjufauxmha\",\n      \"displayName\": \"announcement-subscription-1\",\n      \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n      \"timeCreated\": \"2022-09-16T23:55:33.329Z\",\n      \"timeUpdated\": \"2023-01-06T23:22:32.956Z\",\n      \"lifecycleState\": \"ACTIVE\",\n      \"lifecycleDetails\": null,\n      \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleahxrbayxljicvb2hkny3el5gvj7hru3ubqfauxxt3zw3krmgbsh7a\",\n      \"freeformTags\": {},\n      \"definedTags\": {},\n      \"systemTags\": {}\n    }\n  ]\n}\n"
    Filter:
      description: Criteria that the Announcements service uses to match announcements so it can provide only desired announcements to subscribers.
      properties:
        type:
          description: The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
          enum:
          - COMPARTMENT_ID
          - PLATFORM_TYPE
          - REGION
          - SERVICE
          - RESOURCE_ID
          - ANNOUNCEMENT_TYPE
          type: string
        value:
          description: The value of the filter.
          type: string
      required:
      - type
      - value
      type: object
      x-example: "{\n  \"type\": \"ANNOUNCEMENT_TYPE\",\n  \"value\": \"ACTION_REQUIRED\"\n}\n"
    AnnouncementSubscriptionSummary:
      description: A summary representation of an announcement subscription.
      properties:
        compartmentId:
          description: The OCID of the compartment that contains the announcement subscription.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name for the announcement subscription. Does not have to be unique, and it''s changeable. Avoid entering confidential information.

            '
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the announcement subscription.
          type: string
        lifecycleDetails:
          description: A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.
          type: string
        lifecycleState:
          description: The current lifecycle state of the announcement subscription.
          type: string
          x-obmcs-enumref: '#/definitions/AnnouncementSubscription/lifecycleState'
        onsTopicId:
          description: The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        timeCreated:
          description: 'The date and time that the announcement subscription was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time that the announcement subscription was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - lifecycleState
      - timeCreated
      - displayName
      - freeformTags
      - definedTags
      - onsTopicId
      type: object
      x-example: "{\n  \"id\": \"ocid1.announcementsubscription.oc1.phx.examplea37fvnaiacfq6oa5cvbt2csvefzddrex4kcoezc2yzekjufauxmha\",\n  \"displayName\": \"announcement-subscription-1\",\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\",\n  \"timeCreated\": \"2022-09-16T23:55:33.329Z\",\n  \"timeUpdated\": \"2023-01-06T23:22:32.956Z\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleDetails\": null,\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleahxrbayxljicvb2hkny3el5gvj7hru3ubqfauxxt3zw3krmgbsh7a\",\n  \"freeformTags\": {},\n  \"definedTags\": {},\n  \"systemTags\": {}\n}\n"
    UpdateFilterGroupDetails:
      description: The details for updating a filter group in an announcement subscription.
      properties:
        filters:
          description: A list of filters against which the Announcements service will match announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
          items:
            $ref: '#/components/schemas/Filter'
          minItems: 1
          type: array
      required:
      - filters
      type: object
      x-example: "{\n  \"name\": \"filterbyiaasus\",\n  \"filters\": [\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US East (Ashburn)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (Phoenix)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (San Jose)\"\n    },\n    {\n      \"type\": \"PLATFORM_TYPE\",\n      \"value\": \"IAAS\"\n  ]\n}\n"
    FilterGroupDetails:
      description: The details of a group of filters to match announcements against. A filter group combines one or more individual filters.
      properties:
        filters:
          description: A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
          items:
            $ref: '#/components/schemas/Filter'
          type: array
      required:
      - filters
      type: object
      x-example: "{\n  \"name\": \"filterbyiaasus\",\n  \"filters\": [\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US East (Ashburn)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (Phoenix)\"\n    },\n    {\n      \"type\": \"PLATFORM_TYPE\",\n      \"value\": \"IAAS\"\n  ]\n}\n"
    ChangeAnnouncementSubscriptionCompartmentDetails:
      description: The details of the request to change the compartment of the announcement subscription.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment

            into which you want to move the announcement subscription.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.compartment.oc1..exampleaoeapbnmopz4mi63cvbywa5h5vsr52ewvxwl6fauxcakeprhzmw2q\"\n}\n"
    FilterGroup:
      description: A group of filters to match announcements against.
      properties:
        filters:
          description: A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.
          items:
            $ref: '#/components/schemas/Filter'
          type: array
        name:
          description: The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.
          type: string
      required:
      - name
      - filters
      type: object
      x-example: "{\n  \"name\": \"filterbycomputeactions\",\n    \"filters\": [\n      {\n        \"type\": \"ANNOUNCEMENT_TYPE\",\n        \"value\": \"ACTION_REQUIRED\"\n      },\n      {\n        \"type\": \"ANNOUNCEMENT_TYPE\",\n        \"value\": \"ACTION_RECOMMENDED\"\n      },\n      {\n        \"type\": \"SERVICE\",\n        \"value\": \"Oracle Cloud Infrastructure Compute\"\n      }\n    ]\n}\n"
    AnnouncementSubscription:
      description: 'A subscription with the Announcements service to receive selected announcements in the format and delivery mechanisms supported by a corresponding topic endpoint configured in the Oracle Cloud Infrastructure Notifications service.

        '
      properties:
        compartmentId:
          description: The OCID of the compartment that contains the announcement subscription.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

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

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        description:
          description: A description of the announcement subscription. Avoid entering confidential information.
          type: string
        displayName:
          description: 'A user-friendly name for the announcement subscription. Does not have to be unique, and it''s changeable. Avoid entering confidential information.

            '
          type: string
        filterGroups:
          additionalProperties:
            $ref: '#/components/schemas/FilterGroup'
          description: 'A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.

            '
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the announcement subscription.
          type: string
        lifecycleDetails:
          description: 'A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.

            '
          type: string
        lifecycleState:
          description: The current lifecycle state of the announcement subscription.
          enum:
          - ACTIVE
          - DELETED
          - FAILED
          type: string
        onsTopicId:
          description: 'The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.

            '
          type: string
        preferredLanguage:
          default: en-US
          description: (For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
          example: fr-FR
          format: x-obmcs-human-language
          type: string
        preferredTimeZone:
          default: UTC
          description: The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
          example: America/Los_Angeles
          format: x-obmcs-time-zone
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        timeCreated:
          description: 'The date and time that the announcement subscription was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time that the announcement subscription was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - lifecycleState
      - timeCreated
      - displayName
      - freeformTags
      - definedTags
      - onsTopicId
      type: object
      x-example: "{\n  \"id\": \"ocid1.announcementsubscription.oc1.phx.exampleaqisx3ryazu44rhjcvbwasbdkv3tmurqkqri6yd3p6wzfauxdqmqa\",\n  \"displayName\": \"actionrequired-subscription\",\n  \"description\": \"subscription for required actions\",\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleauingds4uwkcvbxv4ijs7zxuqnoewldef4fauxs7vaax2fab4gcsq\",\n  \"timeCreated\": \"2022-03-01T23:55:57.672Z\",\n  \"timeUpdated\": \"2022-03-01T23:55:57.672Z\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleDetails\": null,\n  \"onsTopicId\": \"ocid1.onstopic.oc1.phx.exampleac37suzoqdnp3hg3jmopb32zcvbitupvwvovlufauxsirkjveeqsa\",\n  \"filterGroups\": {\n    \"filterbytype\": {\n      \"name\": \"filterbytype\",\n      \"filters\": [\n        {\n          \"type\": \"ANNOUNCEMENT_TYPE\",\n          \"value\": \"ACTION_REQUIRED\"\n        }\n      ]\n    }\n  },\n  \"freeformTags\": {},\n  \"definedTags\": {},\n  \"systemTags\": {}\n}\n"
    CreateFilterGroupDetails:
      description: The details for creating a new filter group for an announcement subscription.
      properties:
        filters:
          description: A list of filters against which the Announcements service will match announcements. You cannot have more than one of any given filter type within a filter group.
          items:
            $ref: '#/components/schemas/Filter'
          minItems: 1
          type: array
        name:
          description: The name of the filter group. The name must be unique and it cannot be changed. Avoid entering confidential information.
          type: string
      required:
      - name
      - filters
      type: object
      x-example: "{\n  \"name\": \"filterbyregion-us\",\n  \"filters\": [\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US East (Ashburn)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (Phoenix)\"\n    },\n    {\n      \"type\": \"REGION\",\n      \"value\": \"US West (San Jose)\"\n    }\n  ]\n}\n"
  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 pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-previous-page:
      description: 'For pagination of a list of items. Include this value as the `page` parameter for the

        subsequent GET request to get the previous batch of items.

        '
      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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

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

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

        '
      type: object
x-obmcs-client-retries-enabled: false
x-oracle-package: com.oracle.pic.announcements.announcements-api