Amazon CloudHSM

Amazon CloudHSM Cloudhsm Hapg API

The Cloudhsm Hapg API from Amazon CloudHSM — 5 operation(s) for cloudhsm hapg.

GitHub OpenAPI

Operations 5

POST /#CreateHapg Create Hapg #
POST /#DeleteHapg Delete Hapg #
POST /#DescribeHapg Describe Hapg #
POST /#ListHapgs List Hapgs #
POST /#ModifyHapg Modify Hapg #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-cloudhsm/openapi/amazon-cloudhsm-hapg-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-cloudhsm:amazon-cloudhsm-hapg-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-cloudhsm-hapg-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Amazon CloudHSM Hapg API
  version: '2014-05-30'
  description: Generated from AWS's published Smithy model for Amazon CloudHSM. 5 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://cloudhsm.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateHapg:
    post:
      operationId: CreateHapg
      summary: Create Hapg
      description: This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the
        AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version
        of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Creates a high-availability
        partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateHapgResponse'
        '500':
          description: CloudHsmInternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalException'
        '400':
          description: CloudHsmServiceException; InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmServiceException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudHsmFrontendService.CreateHapg
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateHapgRequest'
      tags:
      - Hapg
  /#DeleteHapg:
    post:
      operationId: DeleteHapg
      summary: Delete Hapg
      description: This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the
        AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version
        of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Deletes a high-availability
        partition group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteHapgResponse'
        '500':
          description: CloudHsmInternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalException'
        '400':
          description: CloudHsmServiceException; InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmServiceException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudHsmFrontendService.DeleteHapg
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteHapgRequest'
      tags:
      - Hapg
  /#DescribeHapg:
    post:
      operationId: DescribeHapg
      summary: Describe Hapg
      description: This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the
        AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version
        of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Retrieves information
        about a high-availability partition group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeHapgResponse'
        '500':
          description: CloudHsmInternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalException'
        '400':
          description: CloudHsmServiceException; InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmServiceException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudHsmFrontendService.DescribeHapg
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeHapgRequest'
      tags:
      - Hapg
  /#ListHapgs:
    post:
      operationId: ListHapgs
      summary: List Hapgs
      description: This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the
        AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version
        of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Lists the high-availability
        partition groups for the account. This operation supports pagination with the use of the NextToken member. If more
        results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs
        to retrieve the next set of items.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListHapgsResponse'
        '500':
          description: CloudHsmInternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalException'
        '400':
          description: CloudHsmServiceException; InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmServiceException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudHsmFrontendService.ListHapgs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListHapgsRequest'
      tags:
      - Hapg
  /#ModifyHapg:
    post:
      operationId: ModifyHapg
      summary: Modify Hapg
      description: This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the
        AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference. For information about the current version
        of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference. Modifies an existing
        high-availability partition group.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ModifyHapgResponse'
        '500':
          description: CloudHsmInternalException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmInternalException'
        '400':
          description: CloudHsmServiceException; InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CloudHsmServiceException'
      deprecated: true
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudHsmFrontendService.ModifyHapg
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ModifyHapgRequest'
      tags:
      - Hapg
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:
    CloudHsmInternalException:
      type: object
      properties:
        message:
          type: string
          description: Additional information about the error.
        retryable:
          type: boolean
          description: Indicates if the action can be retried.
    CloudHsmServiceException:
      type: object
      properties:
        message:
          type: string
          description: Additional information about the error.
        retryable:
          type: boolean
          description: Indicates if the action can be retried.
    CreateHapgRequest:
      type: object
      properties:
        Label:
          type: string
          description: The label of the new high-availability partition group.
      required:
      - Label
    CreateHapgResponse:
      type: object
      properties:
        HapgArn:
          type: string
          description: The ARN of the high-availability partition group.
    DeleteHapgRequest:
      type: object
      properties:
        HapgArn:
          type: string
          description: The ARN of the high-availability partition group to delete.
      required:
      - HapgArn
    DeleteHapgResponse:
      type: object
      properties:
        Status:
          type: string
          description: The status of the action.
      required:
      - Status
    DescribeHapgRequest:
      type: object
      properties:
        HapgArn:
          type: string
          description: The ARN of the high-availability partition group to describe.
      required:
      - HapgArn
    DescribeHapgResponse:
      type: object
      properties:
        HapgArn:
          type: string
          description: The ARN of the high-availability partition group.
        HapgSerial:
          type: string
          description: The serial number of the high-availability partition group.
        HsmsLastActionFailed:
          type: array
          items:
            type: string
        HsmsPendingDeletion:
          type: array
          items:
            type: string
        HsmsPendingRegistration:
          type: array
          items:
            type: string
        Label:
          type: string
          description: The label for the high-availability partition group.
        LastModifiedTimestamp:
          type: string
          description: The date and time the high-availability partition group was last modified.
        PartitionSerialList:
          type: array
          items:
            type: string
          description: The list of partition serial numbers that belong to the high-availability partition group.
        State:
          type: string
          enum:
          - READY
          - UPDATING
          - DEGRADED
          description: The state of the high-availability partition group.
    ListHapgsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.
    ListHapgsResponse:
      type: object
      properties:
        HapgList:
          type: array
          items:
            type: string
          description: The list of high-availability partition groups.
        NextToken:
          type: string
          description: If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.
      required:
      - HapgList
    ModifyHapgRequest:
      type: object
      properties:
        HapgArn:
          type: string
          description: The ARN of the high-availability partition group to modify.
        Label:
          type: string
          description: The new label for the high-availability partition group.
        PartitionSerialList:
          type: array
          items:
            type: string
          description: The list of partition serial numbers to make members of the high-availability partition group.
      required:
      - HapgArn
    ModifyHapgResponse:
      type: object
      properties:
        HapgArn:
          type: string
          description: The ARN of the high-availability partition group.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudhsm/service/2014-05-30/cloudhsm-2014-05-30.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)