Amazon CloudWatch Cloudwatch Data Protection Policy API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Data Protection Policy API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 3 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:
  /#DeleteDataProtectionPolicy:
    post:
      operationId: DeleteDataProtectionPolicy
      summary: Delete Data Protection Policy
      description: Deletes the data protection policy from the specified log group. For more information about data protection
        policies, see PutDataProtectionPolicy.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidParameterException; OperationAbortedException; 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.DeleteDataProtectionPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDataProtectionPolicyRequest'
      tags:
      - Data Protection Policy
  /#GetDataProtectionPolicy:
    post:
      operationId: GetDataProtectionPolicy
      summary: Get Data Protection Policy
      description: Returns information about a log group data protection policy.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDataProtectionPolicyResponse'
        '400':
          description: InvalidParameterException; OperationAbortedException; 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.GetDataProtectionPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDataProtectionPolicyRequest'
      tags:
      - Data Protection Policy
  /#PutDataProtectionPolicy:
    post:
      operationId: PutDataProtectionPolicy
      summary: Put Data Protection Policy
      description: Creates a data protection policy for the specified log group. A data protection policy can help safeguard
        sensitive data that's ingested by the log group by auditing and masking the sensitive log data. Sensitive data is
        detected and masked when it is ingested into the log group. When you set a data protection policy, log events ingested
        into the log group before that time are not masked. By default, when a user views a log event that includes masked
        data, the sensitive data is replaced by asterisks. A user who has the logs:Unmask permission can use a GetLogEvents
        or FilterLogEvents operation with the unmask parameter set to true to view the unmasked log events. Users with the
        logs:Unmask can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs Insights query
        with the unmask query command. For more information, including a list of types of data that can be audited and masked,
        see Protect sensitive log data with masking. The PutDataProtectionPolicy operation applies to only the specified log
        group. You can also use PutAccountPolicy to create an account-level data protection policy that applies to all log
        groups in the account, including both existing lo
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutDataProtectionPolicyResponse'
        '400':
          description: InvalidParameterException; LimitExceededException; OperationAbortedException; 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.PutDataProtectionPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutDataProtectionPolicyRequest'
      tags:
      - Data Protection Policy
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:
    DeleteDataProtectionPolicyRequest:
      type: object
      properties:
        logGroupIdentifier:
          type: string
          description: The name or ARN of the log group that you want to delete the data protection policy for.
      required:
      - logGroupIdentifier
    GetDataProtectionPolicyRequest:
      type: object
      properties:
        logGroupIdentifier:
          type: string
          description: The name or ARN of the log group that contains the data protection policy that you want to see.
      required:
      - logGroupIdentifier
    GetDataProtectionPolicyResponse:
      type: object
      properties:
        logGroupIdentifier:
          type: string
          description: The log group name or ARN that you specified in your request.
        policyDocument:
          type: string
          description: The data protection policy document for this log group.
        lastUpdatedTime:
          type: integer
          description: The date and time that this policy was most recently updated.
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    PutDataProtectionPolicyRequest:
      type: object
      properties:
        logGroupIdentifier:
          type: string
          description: Specify either the log group name or log group ARN.
        policyDocument:
          type: string
          description: 'Specify the data protection policy, in JSON. This policy must include two JSON blocks: The first block
            must include both a DataIdentifer array and an Operation property with an Audit action. The DataIdentifer array
            lists the types of sensitive data that you want to mask. For more information about the available options, see
            Types of data that you can mask. The Operation property with an Audit action is required to find the sensitive
            data terms. This Audit action must contain a FindingsDestination object. You can optionally use that FindingsDestination
            object to list one or more destinations to'
      required:
      - logGroupIdentifier
      - policyDocument
    PutDataProtectionPolicyResponse:
      type: object
      properties:
        logGroupIdentifier:
          type: string
          description: The log group name or ARN that you specified in your request.
        policyDocument:
          type: string
          description: The data protection policy used for this log group.
        lastUpdatedTime:
          type: integer
          description: The date and time that this policy was most recently updated.
    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)