Amazon CloudHSM Cloudhsm Resource Policy API

openapi: 3.1.0
info:
  title: Amazon CloudHSM Resource Policy API
  version: '2014-05-30'
  description: Generated from AWS's published Smithy model for Amazon CloudHSM. 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://cloudhsmv2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DeleteResourcePolicy:
    post:
      operationId: DeleteResourcePolicy
      summary: Delete Resource Policy
      description: 'Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared
        and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters
        created from that backup. Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different
        Amazon Web Services account.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteResourcePolicyResponse'
        '400':
          description: CloudHsmAccessDeniedException; CloudHsmInvalidRequestException; CloudHsmResourceNotFoundException;
            CloudHsmServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmAccessDeniedException'
        '500':
          description: CloudHsmInternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalFailureException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BaldrApiService.DeleteResourcePolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteResourcePolicyRequest'
      tags:
      - Resource Policy
  /#GetResourcePolicy:
    post:
      operationId: GetResourcePolicy
      summary: Get Resource Policy
      description: 'Retrieves the resource policy document attached to a given resource. Cross-account use: No. You cannot
        perform this operation on an CloudHSM resource in a different Amazon Web Services account.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetResourcePolicyResponse'
        '400':
          description: CloudHsmAccessDeniedException; CloudHsmInvalidRequestException; CloudHsmResourceNotFoundException;
            CloudHsmServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmAccessDeniedException'
        '500':
          description: CloudHsmInternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalFailureException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BaldrApiService.GetResourcePolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetResourcePolicyRequest'
      tags:
      - Resource Policy
  /#PutResourcePolicy:
    post:
      operationId: PutResourcePolicy
      summary: Put Resource Policy
      description: 'Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for
        example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support
        CloudHSM resource policies: Backup - The resource policy allows you to describe the backup and restore a cluster from
        the backup in another Amazon Web Services account. In order to share a backup, it must be in a ''READY'' state and
        you must own it. While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource
        Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple
        resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy
        and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard
        RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see Working
        with shared backups in the CloudHSM User Guide Cross-account use: No. You cannot perform this operation on an CloudHSM
        resource in a different Amazon Web'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutResourcePolicyResponse'
        '400':
          description: CloudHsmAccessDeniedException; CloudHsmInvalidRequestException; CloudHsmResourceNotFoundException;
            CloudHsmServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmAccessDeniedException'
        '500':
          description: CloudHsmInternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalFailureException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - BaldrApiService.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: cloudhsm
  schemas:
    CloudHsmAccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CloudHsmInternalFailureException:
      type: object
      properties:
        Message:
          type: string
    DeleteResourcePolicyRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource from which the policy will be removed.
    DeleteResourcePolicyResponse:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource from which the policy was deleted.
        Policy:
          type: string
          description: The policy previously attached to the resource.
    GetResourcePolicyRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource to which a policy is attached.
    GetResourcePolicyResponse:
      type: object
      properties:
        Policy:
          type: string
          description: The policy attached to a resource.
    PutResourcePolicyRequest:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource to which you want to attach a policy.
        Policy:
          type: string
          description: The policy you want to associate with a resource. For an example policy, see Working with shared backups
            in the CloudHSM User Guide
    PutResourcePolicyResponse:
      type: object
      properties:
        ResourceArn:
          type: string
          description: Amazon Resource Name (ARN) of the resource to which a policy is attached.
        Policy:
          type: string
          description: The policy attached to a resource.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cloudhsm-v2/service/2017-04-28/cloudhsm-v2-2017-04-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)