Amazon CloudWatch Cloudwatch Resource Policy API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Resource 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:
  /#DeleteResourcePolicy:
    post:
      operationId: DeleteResourcePolicy
      summary: Delete Resource Policy
      description: Deletes a resource policy from this account. This revokes the access of the identities in that policy to
        put log events to this account.
      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.DeleteResourcePolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteResourcePolicyRequest'
      tags:
      - Resource Policy
  /#DescribeResourcePolicies:
    post:
      operationId: DescribeResourcePolicies
      summary: Describe Resource Policies
      description: Lists the resource policies in this account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeResourcePoliciesResponse'
        '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.DescribeResourcePolicies
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeResourcePoliciesRequest'
      tags:
      - Resource Policy
  /#PutResourcePolicy:
    post:
      operationId: PutResourcePolicy
      summary: Put Resource Policy
      description: 'Creates or updates a resource policy allowing other Amazon Web Services services to put log events to
        this account, such as Amazon Route 53. This API has the following restrictions: Supported actions - Policy only supports
        logs:PutLogEvents and logs:CreateLogStream actions Supported principals - Policy only applies when operations are
        invoked by Amazon Web Services service principals (not IAM users, roles, or cross-account principals) Policy limits
        - An account can have a maximum of 10 policies without resourceARN and one per LogGroup resourceARN Resource policies
        with actions invoked by non-Amazon Web Services service principals (such as IAM users, roles, or other Amazon Web
        Services accounts) will not be enforced. For access control involving these principals, use the IAM policies.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutResourcePolicyResponse'
        '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.PutResourcePolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutResourcePolicyRequest'
      tags:
      - Resource 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:
    DeleteResourcePolicyRequest:
      type: object
      properties:
        policyName:
          type: string
          description: The name of the policy to be revoked. This parameter is required.
        resourceArn:
          type: string
          description: The ARN of the CloudWatch Logs resource for which the resource policy needs to be deleted
        expectedRevisionId:
          type: string
          description: The expected revision ID of the resource policy. Required when deleting a resource-scoped policy to
            prevent concurrent modifications.
    DescribeResourcePoliciesRequest:
      type: object
      properties:
        nextToken:
          type: string
        limit:
          type: integer
          description: The maximum number of resource policies to be displayed with one call of this API.
        resourceArn:
          type: string
          description: The ARN of the CloudWatch Logs resource for which to query the resource policy.
        policyScope:
          type: string
          enum:
          - ACCOUNT
          - RESOURCE
          description: Specifies the scope of the resource policy. Valid values are ACCOUNT or RESOURCE. When not specified,
            defaults to ACCOUNT.
    DescribeResourcePoliciesResponse:
      type: object
      properties:
        resourcePolicies:
          type: array
          items:
            $ref: '#/components/schemas/ResourcePolicy'
          description: The resource policies that exist in this account.
        nextToken:
          type: string
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    PutResourcePolicyRequest:
      type: object
      properties:
        policyName:
          type: string
          description: Name of the new policy. This parameter is required.
        policyDocument:
          type: string
          description: Details of the new policy, including the identity of the principal that is enabled to put logs to this
            account. This is formatted as a JSON string. This parameter is required. The following example creates a resource
            policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with
            the ARN of your CloudWatch Logs resource, such as a log group or log stream. CloudWatch Logs also supports aws:SourceArn
            and aws:SourceAccount condition context keys. In the example resource policy, you would replace the value of SourceArn
            with the resource making the ca
        resourceArn:
          type: string
          description: The ARN of the CloudWatch Logs resource to which the resource policy needs to be added or attached.
            Currently only supports LogGroup ARN.
        expectedRevisionId:
          type: string
          description: The expected revision ID of the resource policy. Required when resourceArn is provided to prevent concurrent
            modifications. Use null when creating a resource policy for the first time.
    PutResourcePolicyResponse:
      type: object
      properties:
        resourcePolicy:
          $ref: '#/components/schemas/ResourcePolicy'
        revisionId:
          type: string
          description: The revision ID of the created or updated resource policy. Only returned for resource-scoped policies.
    ResourcePolicy:
      type: object
      properties:
        policyName:
          type: string
          description: The name of the resource policy.
        policyDocument:
          type: string
          description: The details of the policy.
        lastUpdatedTime:
          type: integer
          description: Timestamp showing when this policy was last updated, expressed as the number of milliseconds after
            Jan 1, 1970 00:00:00 UTC.
        policyScope:
          type: string
          enum:
          - ACCOUNT
          - RESOURCE
          description: Specifies scope of the resource policy. Valid values are ACCOUNT or RESOURCE.
        resourceArn:
          type: string
          description: The ARN of the CloudWatch Logs resource to which the resource policy is attached. Only populated for
            resource-scoped policies.
        revisionId:
          type: string
          description: The revision ID of the resource policy. Only populated for resource-scoped policies.
    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)