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-hsm-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

openapi: 3.1.0
info:
  title: Amazon CloudHSM Hsm 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:
  /#CreateHsm:
    post:
      operationId: CreateHsm
      summary: Create Hsm
      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 an uninitialized
        HSM instance. There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation.
        If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation,
        go to the AWS Support Center, create a new case, and select Account and Billing Support. It can take up to 20 minutes
        to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready
        to be initialized when the status changes to RUNNING.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateHsmResponse'
        '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.CreateHsm
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateHsmRequest'
      tags:
      - Hsm
  /#DeleteHsm:
    post:
      operationId: DeleteHsm
      summary: Delete Hsm
      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 an HSM.
        After completion, this operation cannot be undone and your key material cannot be recovered.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteHsmResponse'
        '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.DeleteHsm
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteHsmRequest'
      tags:
      - Hsm
  /#DescribeHsm:
    post:
      operationId: DescribeHsm
      summary: Describe Hsm
      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 an HSM. You can identify the HSM by its ARN or its serial number.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeHsmResponse'
        '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.DescribeHsm
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeHsmRequest'
      tags:
      - Hsm
  /#ListHsms:
    post:
      operationId: ListHsms
      summary: List Hsms
      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 the
        identifiers of all of the HSMs provisioned for the current customer. 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 ListHsms to retrieve the next set of items.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListHsmsResponse'
        '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.ListHsms
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListHsmsRequest'
      tags:
      - Hsm
  /#ModifyHsm:
    post:
      operationId: ModifyHsm
      summary: Modify Hsm
      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 HSM.
        This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured.
        If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability,
        and consider executing this operation during a maintenance window.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ModifyHsmResponse'
        '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.ModifyHsm
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ModifyHsmRequest'
      tags:
      - Hsm
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.
    CreateHsmRequest:
      type: object
      properties:
        SubnetId:
          type: string
          description: The identifier of the subnet in your VPC in which to place the HSM.
        SshKey:
          type: string
          description: The SSH public key to install on the HSM.
        EniIp:
          type: string
          description: The IP address to assign to the HSM's ENI. If an IP address is not specified, an IP address will be
            randomly chosen from the CIDR range of the subnet.
        IamRoleArn:
          type: string
          description: The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
        ExternalId:
          type: string
          description: The external ID from IamRoleArn, if present.
        SubscriptionType:
          type: string
          enum:
          - PRODUCTION
        ClientToken:
          type: string
          description: A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token
            will be ignored.
        SyslogIp:
          type: string
          description: The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog
            monitoring server.
      required:
      - SubnetId
      - SshKey
      - IamRoleArn
      - SubscriptionType
    CreateHsmResponse:
      type: object
      properties:
        HsmArn:
          type: string
          description: The ARN of the HSM.
    DeleteHsmRequest:
      type: object
      properties:
        HsmArn:
          type: string
          description: The ARN of the HSM to delete.
      required:
      - HsmArn
    DeleteHsmResponse:
      type: object
      properties:
        Status:
          type: string
          description: The status of the operation.
      required:
      - Status
    DescribeHsmRequest:
      type: object
      properties:
        HsmArn:
          type: string
          description: The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
        HsmSerialNumber:
          type: string
          description: The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.
    DescribeHsmResponse:
      type: object
      properties:
        HsmArn:
          type: string
          description: The ARN of the HSM.
        Status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - UPDATING
          - SUSPENDED
          - TERMINATING
          - TERMINATED
          - DEGRADED
          description: The status of the HSM.
        StatusDetails:
          type: string
          description: Contains additional information about the status of the HSM.
        AvailabilityZone:
          type: string
          description: The Availability Zone that the HSM is in.
        EniId:
          type: string
          description: The identifier of the elastic network interface (ENI) attached to the HSM.
        EniIp:
          type: string
          description: The IP address assigned to the HSM's ENI.
        SubscriptionType:
          type: string
          enum:
          - PRODUCTION
        SubscriptionStartDate:
          type: string
          description: The subscription start date.
        SubscriptionEndDate:
          type: string
          description: The subscription end date.
        VpcId:
          type: string
          description: The identifier of the VPC that the HSM is in.
        SubnetId:
          type: string
          description: The identifier of the subnet that the HSM is in.
        IamRoleArn:
          type: string
          description: The ARN of the IAM role assigned to the HSM.
        SerialNumber:
          type: string
          description: The serial number of the HSM.
        VendorName:
          type: string
          description: The name of the HSM vendor.
        HsmType:
          type: string
          description: The HSM model type.
        SoftwareVersion:
          type: string
          description: The HSM software version.
        SshPublicKey:
          type: string
          description: The public SSH key.
        SshKeyLastUpdated:
          type: string
          description: The date and time that the SSH key was last updated.
        ServerCertUri:
          type: string
          description: The URI of the certificate server.
        ServerCertLastUpdated:
          type: string
          description: The date and time that the server certificate was last updated.
        Partitions:
          type: array
          items:
            type: string
          description: The list of partitions on the HSM.
    ListHsmsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The NextToken value from a previous call to ListHsms. Pass null if this is the first call.
    ListHsmsResponse:
      type: object
      properties:
        HsmList:
          type: array
          items:
            type: string
          description: The list of ARNs that identify the HSMs.
        NextToken:
          type: string
          description: If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.
    ModifyHsmRequest:
      type: object
      properties:
        HsmArn:
          type: string
          description: The ARN of the HSM to modify.
        SubnetId:
          type: string
          description: The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability
            Zone as the current subnet.
        EniIp:
          type: string
          description: The new IP address for the elastic network interface (ENI) attached to the HSM. If the HSM is moved
            to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR
            range of the new subnet.
        IamRoleArn:
          type: string
          description: The new IAM role ARN.
        ExternalId:
          type: string
          description: The new external ID.
        SyslogIp:
          type: string
          description: The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog
            monitoring server.
      required:
      - HsmArn
    ModifyHsmResponse:
      type: object
      properties:
        HsmArn:
          type: string
          description: The ARN of the HSM.
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)