Amazon CloudWatch Cloudwatch Integration API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Integration API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://logs.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DeleteIntegration:
    post:
      operationId: DeleteIntegration
      summary: Delete Integration
      description: Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active
        vended logs dashboards, you must specify true for the force parameter, otherwise the operation will fail. If you delete
        the integration by setting force to true, all your vended logs dashboards powered by OpenSearch Service will be deleted
        and the data that was on them will no longer be accessible.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteIntegrationResponse'
        '400':
          description: InvalidParameterException; ResourceNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Logs_20140328.DeleteIntegration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteIntegrationRequest'
      tags:
      - Integration
  /#GetIntegration:
    post:
      operationId: GetIntegration
      summary: Get Integration
      description: Returns information about one integration between CloudWatch Logs and OpenSearch Service.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetIntegrationResponse'
        '400':
          description: InvalidParameterException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Logs_20140328.GetIntegration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetIntegrationRequest'
      tags:
      - Integration
  /#ListIntegrations:
    post:
      operationId: ListIntegrations
      summary: List Integrations
      description: Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only
        one integration can be created in an account, and this integration must be with OpenSearch Service.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListIntegrationsResponse'
        '400':
          description: InvalidParameterException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Logs_20140328.ListIntegrations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListIntegrationsRequest'
      tags:
      - Integration
  /#PutIntegration:
    post:
      operationId: PutIntegration
      summary: Put Integration
      description: Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations
        with OpenSearch Service are supported, and currently you can have only one integration in your account. Integrating
        with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch
        Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service. You can use
        this operation only to create a new integration. You can't modify an existing integration.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutIntegrationResponse'
        '400':
          description: InvalidParameterException; LimitExceededException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Logs_20140328.PutIntegration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutIntegrationRequest'
      tags:
      - Integration
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: logs
  schemas:
    DeleteIntegrationRequest:
      type: object
      properties:
        integrationName:
          type: string
          description: The name of the integration to delete. To find the name of your integration, use ListIntegrations.
        force:
          type: boolean
          description: Specify true to force the deletion of the integration even if vended logs dashboards currently exist.
            The default is false.
      required:
      - integrationName
    DeleteIntegrationResponse:
      type: object
      properties: {}
    GetIntegrationRequest:
      type: object
      properties:
        integrationName:
          type: string
          description: The name of the integration that you want to find information about. To find the name of your integration,
            use ListIntegrations
      required:
      - integrationName
    GetIntegrationResponse:
      type: object
      properties:
        integrationName:
          type: string
          description: The name of the integration.
        integrationType:
          type: string
          enum:
          - OPENSEARCH
          description: The type of integration. Integrations with OpenSearch Service have the type OPENSEARCH.
        integrationStatus:
          type: string
          enum:
          - PROVISIONING
          - ACTIVE
          - FAILED
          description: The current status of this integration.
        integrationDetails:
          $ref: '#/components/schemas/IntegrationDetails'
    IntegrationDetails:
      type: object
      properties:
        openSearchIntegrationDetails:
          $ref: '#/components/schemas/OpenSearchIntegrationDetails'
      description: Exactly one member is set.
    IntegrationSummary:
      type: object
      properties:
        integrationName:
          type: string
          description: The name of this integration.
        integrationType:
          type: string
          enum:
          - OPENSEARCH
          description: The type of integration. Integrations with OpenSearch Service have the type OPENSEARCH.
        integrationStatus:
          type: string
          enum:
          - PROVISIONING
          - ACTIVE
          - FAILED
          description: The current status of this integration.
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    ListIntegrationsRequest:
      type: object
      properties:
        integrationNamePrefix:
          type: string
          description: To limit the results to integrations that start with a certain name prefix, specify that name prefix
            here.
        integrationType:
          type: string
          enum:
          - OPENSEARCH
          description: To limit the results to integrations of a certain type, specify that type here.
        integrationStatus:
          type: string
          enum:
          - PROVISIONING
          - ACTIVE
          - FAILED
          description: To limit the results to integrations with a certain status, specify that status here.
    ListIntegrationsResponse:
      type: object
      properties:
        integrationSummaries:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationSummary'
          description: An array, where each object in the array contains information about one CloudWatch Logs integration
            in this account.
    OpenSearchApplication:
      type: object
      properties:
        applicationEndpoint:
          type: string
          description: The endpoint of the application.
        applicationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the application.
        applicationId:
          type: string
          description: The ID of the application.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    OpenSearchCollection:
      type: object
      properties:
        collectionEndpoint:
          type: string
          description: The endpoint of the collection.
        collectionArn:
          type: string
          description: The ARN of the collection.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    OpenSearchDataAccessPolicy:
      type: object
      properties:
        policyName:
          type: string
          description: The name of the data access policy.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    OpenSearchDataSource:
      type: object
      properties:
        dataSourceName:
          type: string
          description: The name of the OpenSearch Service data source.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    OpenSearchEncryptionPolicy:
      type: object
      properties:
        policyName:
          type: string
          description: The name of the encryption policy.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    OpenSearchIntegrationDetails:
      type: object
      properties:
        dataSource:
          $ref: '#/components/schemas/OpenSearchDataSource'
        application:
          $ref: '#/components/schemas/OpenSearchApplication'
        collection:
          $ref: '#/components/schemas/OpenSearchCollection'
        workspace:
          $ref: '#/components/schemas/OpenSearchWorkspace'
        encryptionPolicy:
          $ref: '#/components/schemas/OpenSearchEncryptionPolicy'
        networkPolicy:
          $ref: '#/components/schemas/OpenSearchNetworkPolicy'
        accessPolicy:
          $ref: '#/components/schemas/OpenSearchDataAccessPolicy'
        lifecyclePolicy:
          $ref: '#/components/schemas/OpenSearchLifecyclePolicy'
    OpenSearchLifecyclePolicy:
      type: object
      properties:
        policyName:
          type: string
          description: The name of the lifecycle policy.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    OpenSearchNetworkPolicy:
      type: object
      properties:
        policyName:
          type: string
          description: The name of the network policy.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    OpenSearchResourceConfig:
      type: object
      properties:
        kmsKeyArn:
          type: string
          description: To have the vended dashboard data encrypted with KMS instead of the CloudWatch Logs default encryption
            method, specify the ARN of the KMS key that you want to use.
        dataSourceRoleArn:
          type: string
          description: Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must
            have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards.
            For more information about the permissions needed, see Permissions that the integration needs in the CloudWatch
            Logs User Guide.
        dashboardViewerPrincipals:
          type: array
          items:
            type: string
          description: Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.
            In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess IAM
            policy. For more information, see IAM policies for users.
        applicationArn:
          type: string
          description: If you want to use an existing OpenSearch Service application for your integration with OpenSearch
            Service, specify it here. If you omit this, a new application will be created.
        retentionDays:
          type: integer
          description: Specify how many days that you want the data derived by OpenSearch Service to be retained in the index
            that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in
            the dashboard. Choosing a longer time frame will incur additional costs.
      required:
      - dataSourceRoleArn
      - dashboardViewerPrincipals
      - retentionDays
    OpenSearchResourceStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - NOT_FOUND
          - ERROR
          description: The current status of this resource.
        statusMessage:
          type: string
          description: A message with additional information about the status of this resource.
    OpenSearchWorkspace:
      type: object
      properties:
        workspaceId:
          type: string
          description: The ID of this workspace.
        status:
          $ref: '#/components/schemas/OpenSearchResourceStatus'
    PutIntegrationRequest:
      type: object
      properties:
        integrationName:
          type: string
          description: A name for the integration.
        resourceConfig:
          $ref: '#/components/schemas/ResourceConfig'
        integrationType:
          type: string
          enum:
          - OPENSEARCH
          description: The type of integration. Currently, the only supported type is OPENSEARCH.
      required:
      - integrationName
      - resourceConfig
      - integrationType
    PutIntegrationResponse:
      type: object
      properties:
        integrationName:
          type: string
          description: The name of the integration that you just created.
        integrationStatus:
          type: string
          enum:
          - PROVISIONING
          - ACTIVE
          - FAILED
          description: The status of the integration that you just created. After you create an integration, it takes a few
            minutes to complete. During this time, you'll see the status as PROVISIONING.
    ResourceConfig:
      type: object
      properties:
        openSearchResourceConfig:
          $ref: '#/components/schemas/OpenSearchResourceConfig'
      description: Exactly one member is set.
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)