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-luna-client-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 Luna Client 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:
  /#CreateLunaClient:
    post:
      operationId: CreateLunaClient
      summary: Create Luna Client
      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 HSM
        client.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLunaClientResponse'
        '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.CreateLunaClient
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLunaClientRequest'
      tags:
      - Luna Client
  /#DeleteLunaClient:
    post:
      operationId: DeleteLunaClient
      summary: Delete Luna Client
      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 client.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteLunaClientResponse'
        '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.DeleteLunaClient
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteLunaClientRequest'
      tags:
      - Luna Client
  /#DescribeLunaClient:
    post:
      operationId: DescribeLunaClient
      summary: Describe Luna Client
      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 client.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLunaClientResponse'
        '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.DescribeLunaClient
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLunaClientRequest'
      tags:
      - Luna Client
  /#ListLunaClients:
    post:
      operationId: ListLunaClients
      summary: List Luna Clients
      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 all of the
        clients. 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 ListLunaClients to retrieve the
        next set of items.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListLunaClientsResponse'
        '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.ListLunaClients
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListLunaClientsRequest'
      tags:
      - Luna Client
  /#ModifyLunaClient:
    post:
      operationId: ModifyLunaClient
      summary: Modify Luna Client
      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 the certificate
        used by the client. This action can potentially start a workflow to install the new certificate on the client's HSMs.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ModifyLunaClientResponse'
        '400':
          description: CloudHsmServiceException
          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.ModifyLunaClient
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ModifyLunaClientRequest'
      tags:
      - Luna Client
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.
    CreateLunaClientRequest:
      type: object
      properties:
        Label:
          type: string
          description: The label for the client.
        Certificate:
          type: string
          description: The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.
      required:
      - Certificate
    CreateLunaClientResponse:
      type: object
      properties:
        ClientArn:
          type: string
          description: The ARN of the client.
    DeleteLunaClientRequest:
      type: object
      properties:
        ClientArn:
          type: string
          description: The ARN of the client to delete.
      required:
      - ClientArn
    DeleteLunaClientResponse:
      type: object
      properties:
        Status:
          type: string
          description: The status of the action.
      required:
      - Status
    DescribeLunaClientRequest:
      type: object
      properties:
        ClientArn:
          type: string
          description: The ARN of the client.
        CertificateFingerprint:
          type: string
          description: The certificate fingerprint.
    DescribeLunaClientResponse:
      type: object
      properties:
        ClientArn:
          type: string
          description: The ARN of the client.
        Certificate:
          type: string
          description: The certificate installed on the HSMs used by this client.
        CertificateFingerprint:
          type: string
          description: The certificate fingerprint.
        LastModifiedTimestamp:
          type: string
          description: The date and time the client was last modified.
        Label:
          type: string
          description: The label of the client.
    ListLunaClientsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.
    ListLunaClientsResponse:
      type: object
      properties:
        ClientList:
          type: array
          items:
            type: string
          description: The list of clients.
        NextToken:
          type: string
          description: If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.
      required:
      - ClientList
    ModifyLunaClientRequest:
      type: object
      properties:
        ClientArn:
          type: string
          description: The ARN of the client.
        Certificate:
          type: string
          description: The new certificate for the client.
      required:
      - ClientArn
      - Certificate
    ModifyLunaClientResponse:
      type: object
      properties:
        ClientArn:
          type: string
          description: The ARN of the client.
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)