Amazon CloudHSM
<fullname>AWS CloudHSM Service</fullname> <p>This is documentation for <b>AWS CloudHSM Classic</b>
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"info": {
"version": "2014-05-30",
"x-release": "v4",
"title": "Amazon CloudHSM",
"description": "<fullname>AWS CloudHSM Service</fullname> <p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p>",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png",
"backgroundColor": "#FFFFFF"
},
"termsOfService": "https://aws.amazon.com/service-terms/",
"contact": {
"name": "Mike Ralphson",
"email": "mike.ralphson@gmail.com",
"url": "https://github.com/mermade/aws2openapi",
"x-twitter": "PermittedSoc"
},
"license": {
"name": "Apache 2.0 License",
"url": "http://www.apache.org/licenses/"
},
"x-providerName": "amazonaws.com",
"x-serviceName": "cloudhsm",
"x-origin": [
{
"contentType": "application/json",
"url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cloudhsm-2014-05-30.normal.json",
"converter": {
"url": "https://github.com/mermade/aws2openapi",
"version": "1.0.0"
},
"x-apisguru-driver": "external"
}
],
"x-apiClientRegistration": {
"url": "https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"
},
"x-apisguru-categories": [
"cloud"
],
"x-preferred": true
},
"externalDocs": {
"description": "Amazon Web Services documentation",
"url": "https://docs.aws.amazon.com/cloudhsm/"
},
"servers": [
{
"url": "http://cloudhsm.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The CloudHSM multi-region endpoint"
},
{
"url": "https://cloudhsm.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The CloudHSM multi-region endpoint"
},
{
"url": "http://cloudhsm.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The CloudHSM endpoint for China (Beijing) and China (Ningxia)"
},
{
"url": "https://cloudhsm.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The CloudHSM endpoint for China (Beijing) and China (Ningxia)"
}
],
"x-hasEquivalentPaths": true,
"paths": {
"/#X-Amz-Target=CloudHsmFrontendService.AddTagsToResource": {
"post": {
"operationId": "AddTagsToResource",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Adds or overwrites one or more tags for the specified AWS CloudHSM resource.</p> <p>Each tag consists of a key and a value. Tag keys must be unique to each resource.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddTagsToResourceResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddTagsToResourceRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.AddTagsToResource"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.CreateHapg": {
"post": {
"operationId": "CreateHapg",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateHapgResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateHapgRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.CreateHapg"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.CreateHsm": {
"post": {
"operationId": "CreateHsm",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an uninitialized HSM instance.</p> <p>There is an upfront fee charged for each HSM instance that you create with the <code>CreateHsm</code> operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the <a>DeleteHsm</a> operation, go to the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a>, create a new case, and select <b>Account and Billing Support</b>.</p> <important> <p>It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the <a>DescribeHsm</a> operation. The HSM is ready to be initialized when the status changes to <code>RUNNING</code>.</p> </important>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateHsmResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateHsmRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.CreateHsm"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.CreateLunaClient": {
"post": {
"operationId": "CreateLunaClient",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an HSM client.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLunaClientResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLunaClientRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.CreateLunaClient"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.DeleteHapg": {
"post": {
"operationId": "DeleteHapg",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a high-availability partition group.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteHapgResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteHapgRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.DeleteHapg"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.DeleteHsm": {
"post": {
"operationId": "DeleteHsm",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteHsmResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteHsmRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.DeleteHsm"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.DeleteLunaClient": {
"post": {
"operationId": "DeleteLunaClient",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a client.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLunaClientResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteLunaClientRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.DeleteLunaClient"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.DescribeHapg": {
"post": {
"operationId": "DescribeHapg",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about a high-availability partition group.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeHapgResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeHapgRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.DescribeHapg"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.DescribeHsm": {
"post": {
"operationId": "DescribeHsm",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeHsmResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeHsmRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.DescribeHsm"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.DescribeLunaClient": {
"post": {
"operationId": "DescribeLunaClient",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM client.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeLunaClientResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DescribeLunaClientRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.DescribeLunaClient"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.GetConfig": {
"post": {
"operationId": "GetConfig",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConfigResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConfigRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.GetConfig"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ListAvailableZones": {
"post": {
"operationId": "ListAvailableZones",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAvailableZonesResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListAvailableZonesRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ListAvailableZones"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ListHapgs": {
"post": {
"operationId": "ListHapgs",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the high-availability partition groups for the account.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHapgs</code> to retrieve the next set of items.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListHapgsResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListHapgsRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ListHapgs"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ListHsms": {
"post": {
"operationId": "ListHsms",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves the identifiers of all of the HSMs provisioned for the current customer.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHsms</code> to retrieve the next set of items.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListHsmsResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListHsmsRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ListHsms"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ListLunaClients": {
"post": {
"operationId": "ListLunaClients",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists all of the clients.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListLunaClients</code> to retrieve the next set of items.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListLunaClientsResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListLunaClientsRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ListLunaClients"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ListTagsForResource": {
"post": {
"operationId": "ListTagsForResource",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTagsForResourceResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTagsForResourceRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ListTagsForResource"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ModifyHapg": {
"post": {
"operationId": "ModifyHapg",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an existing high-availability partition group.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyHapgResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyHapgRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ModifyHapg"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ModifyHsm": {
"post": {
"operationId": "ModifyHsm",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an HSM.</p> <important> <p>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.</p> </important>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyHsmResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyHsmRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ModifyHsm"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.ModifyLunaClient": {
"post": {
"operationId": "ModifyLunaClient",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies the certificate used by the client.</p> <p>This action can potentially start a workflow to install the new certificate on the client's HSMs.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyLunaClientResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModifyLunaClientRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.ModifyLunaClient"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
},
"/#X-Amz-Target=CloudHsmFrontendService.RemoveTagsFromResource": {
"post": {
"operationId": "RemoveTagsFromResource",
"description": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"https://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Removes one or more tags from the specified AWS CloudHSM resource.</p> <p>To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoveTagsFromResourceResponse"
}
}
}
},
"480": {
"description": "CloudHsmServiceException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmServiceException"
}
}
}
},
"481": {
"description": "CloudHsmInternalException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudHsmInternalException"
}
}
}
},
"482": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoveTagsFromResourceRequest"
}
}
}
},
"parameters": [
{
"name": "X-Amz-Target",
"in": "header",
"required": true,
"schema": {
"type": "string",
"enum": [
"CloudHsmFrontendService.RemoveTagsFromResource"
]
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
}
},
"components": {
"parameters": {
"X-Amz-Content-Sha256": {
"name": "X-Amz-Content-Sha256",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Date": {
"name": "X-Amz-Date",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Algorithm": {
"name": "X-Amz-Algorithm",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Credential": {
"name": "X-Amz-Credential",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Security-Token": {
"name": "X-Amz-Security-Token",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Signature": {
"name": "X-Amz-Signature",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-SignedHeaders": {
"name": "X-Amz-SignedHeaders",
"in": "header",
"schema": {
"type": "string"
},
"required": false
}
},
"securitySchemes": {
"hmac": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"description": "Amazon Signature authorization v4",
"x-amazon-apigateway-authtype": "awsSigv4"
}
},
"schemas": {
"AddTagsToResourceResponse": {
"type": "object",
"required": [
"Status"
],
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The status of the operation."
}
]
}
}
},
"AddTagsToResourceRequest": {
"type": "object",
"required": [
"ResourceArn",
"TagList"
],
"title": "AddTagsToResourceRequest",
"properties": {
"ResourceArn": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag."
}
]
},
"TagList": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "One or more tags."
}
]
}
}
},
"CloudHsmServiceException": {},
"CloudHsmInternalException": {},
"InvalidRequestException": {},
"CreateHapgResponse": {
"type": "object",
"properties": {
"HapgArn": {
"allOf": [
{
"$ref": "#/components/schemas/HapgArn"
},
{
"description": "The ARN of the high-availability partition group."
}
]
}
},
"description": "Contains the output of the <a>CreateHAPartitionGroup</a> action."
},
"CreateHapgRequest": {
"type": "object",
"required": [
"Label"
],
"title": "CreateHapgRequest",
"properties": {
"Label": {
"allOf": [
{
"$ref": "#/components/schemas/Label"
},
{
"description": "The label of the new high-availability partition group."
}
]
}
},
"description": "Contains the inputs for the <a>CreateHapgRequest</a> action."
},
"CreateHsmResponse": {
"type": "object",
"properties": {
"HsmArn": {
"allOf": [
{
"$ref": "#/components/schemas/HsmArn"
},
{
"description": "The ARN of the HSM."
}
]
}
},
"description": "Contains the output of the <code>CreateHsm</code> operation."
},
"CreateHsmRequest": {
"type": "object",
"required": [
"SubnetId",
"SshKey",
"IamRoleArn",
"SubscriptionType"
],
"title": "CreateHsmRequest",
"properties": {
"SubnetId": {
"allOf": [
{
"$ref": "#/components/schemas/SubnetId"
},
{
"description": "The identifier of the subnet in your VPC in which to place the HSM."
}
]
},
"SshKey": {
"allOf": [
{
"$ref": "#/components/schemas/SshKey"
},
{
"description": "The SSH public key to install on the HSM."
}
]
},
"EniIp": {
"allOf": [
{
"$ref": "#/components/schemas/IpAddress"
},
{
"description": "<p>The IP address to assign to the HSM's ENI.</p> <p>If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.</p>"
}
]
},
"IamRoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/IamRoleArn"
},
{
"description": "The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf."
}
]
},
"ExternalId": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalId"
},
{
"description": "The external ID from <code>IamRoleArn</code>, if present."
}
]
},
"SubscriptionType": {
"$ref": "#/components/schemas/SubscriptionType"
},
"ClientToken": {
"allOf": [
{
"$ref": "#/components/schemas/ClientToken"
},
{
"description": "A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored."
}
]
},
"SyslogIp": {
"allOf": [
{
"$ref": "#/components/schemas/IpAddress"
},
{
"description": "The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server."
}
]
}
},
"description": "Contains the inputs for the <code>CreateHsm</code> operation."
},
"CreateLunaClientResponse": {
"type": "object",
"properties": {
"ClientArn": {
"allOf": [
{
"$ref": "#/components/schemas/ClientArn"
},
{
"description": "The ARN of the client."
}
]
}
},
"description": "Contains the output of the <a>CreateLunaClient</a> action."
},
"CreateLunaClientRequest": {
"type": "object",
"required": [
"Certificate"
],
"title": "CreateLunaClientRequest",
"properties": {
"Label": {
"allOf": [
{
"$ref": "#/components/schemas/ClientLabel"
},
{
"description": "The label for the client."
}
]
},
"Certificate": {
"allOf": [
{
"$ref": "#/components/schemas/Certificate"
},
{
"description": "The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client."
}
]
}
},
"description": "Contains the inputs for the <a>CreateLunaClient</a> action."
},
"DeleteHapgResponse": {
"type": "object",
"required": [
"Status"
],
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The status of the action."
}
]
}
},
"description": "Contains the output of the <a>DeleteHapg</a> action."
},
"DeleteHapgRequest": {
"type": "object",
"required": [
"HapgArn"
],
"title": "DeleteHapgRequest",
"properties": {
"HapgArn": {
"allOf": [
{
"$ref": "#/components/schemas/HapgArn"
},
{
"description": "The ARN of the high-availability partition group to delete."
}
]
}
},
"description": "Contains the inputs for the <a>DeleteHapg</a> action."
},
"DeleteHsmResponse": {
"type": "object",
"required": [
"Status"
],
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The status of the operation."
}
]
}
},
"description": "Contains the output of the <a>DeleteHsm</a> operation."
},
"DeleteHsmRequest": {
"type": "object",
"required": [
"HsmArn"
],
"title": "DeleteHsmRequest",
"properties": {
"HsmArn": {
"allOf": [
{
"$ref": "#/components/schemas/HsmArn"
},
{
"description": "The ARN of the HSM to delete."
}
]
}
},
"description": "Contains the inputs for the <a>DeleteHsm</a> operation."
},
"DeleteLunaClientResponse": {
"type": "object",
"required": [
"Status"
],
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The status of the action."
}
]
}
}
},
"DeleteLunaClientRequest": {
"type": "object",
"required": [
"ClientArn"
],
"title": "DeleteLunaClientRequest",
"properties": {
"ClientArn": {
"allOf": [
{
"$ref": "#/components/schemas/ClientArn"
},
{
"description": "The ARN of the client to delete."
}
]
}
}
},
"DescribeHapgResponse": {
"type": "object",
"properties": {
"HapgArn": {
"allOf": [
{
"$ref": "#/components/schemas/HapgArn"
},
{
"description": "The ARN of the high-availability partition group."
}
]
},
"HapgSerial": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The serial number of the high-availability partition group."
}
]
},
"HsmsLastActionFailed": {
"allOf": [
{
"$ref": "#/components/schemas/HsmList"
},
{
"description": "<p/>"
}
]
},
"HsmsPendingDeletion": {
"allOf": [
{
"$ref": "#/components/schemas/HsmList"
},
{
"description": "<p/>"
}
]
},
"HsmsPendingRegistration": {
"allOf": [
{
"$ref": "#/components/schemas/HsmList"
},
{
"description": "<p/>"
}
]
},
"Label": {
"allOf": [
{
"$ref": "#/components/schemas/Label"
},
{
"description": "The label for the high-availability partition group."
}
]
},
"LastModifiedTimestamp": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date and time the high-availability partition group was last modified."
}
]
},
"PartitionSerialList": {
"allOf": [
{
"$ref": "#/components/schemas/PartitionSerialList"
},
{
"description": "The list of partition serial numbers that belong to the high-availability partition group."
}
]
},
"State": {
"allOf": [
{
"$ref": "#/components/schemas/CloudHsmObjectState"
},
{
"description": "The state of the high-availability partition group."
}
]
}
},
"description": "Contains the output of the <a>DescribeHapg</a> action."
},
"DescribeHapgRequest": {
"type": "object",
"required": [
"HapgArn"
],
"title": "DescribeHapgRequest",
"properties": {
"HapgArn": {
"allOf": [
{
"$ref": "#/components/schemas/HapgArn"
},
{
"description": "The ARN of the high-availability partition group to describe."
}
]
}
},
"description": "Contains the inputs for the <a>DescribeHapg</a> action."
},
"DescribeHsmResponse": {
"type": "object",
"properties": {
"HsmArn": {
"allOf": [
{
"$ref": "#/components/schemas/HsmArn"
},
{
"description": "The ARN of the HSM."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/HsmStatus"
},
{
"description": "The status of the HSM."
}
]
},
"StatusDetails": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "Contains additional information about the status of the HSM."
}
]
},
"AvailabilityZone": {
"allOf": [
{
"$ref": "#/components/schemas/AZ"
},
{
"description": "The Availability Zone that the HSM is in."
}
]
},
"EniId": {
"allOf": [
{
"$ref": "#/components/schemas/EniId"
},
{
"description": "The identifier of the elastic network interface (ENI) attached to the HSM."
}
]
},
"EniIp": {
"allOf": [
{
"$ref": "#/components/schemas/IpAddress"
},
{
"description": "The IP address assigned to the HSM's ENI."
}
]
},
"SubscriptionType": {
"$ref": "#/components/schemas/SubscriptionType"
},
"SubscriptionStartDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The subscription start date."
}
]
},
"SubscriptionEndDate": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The subscription end date."
}
]
},
"VpcId": {
"allOf": [
{
"$ref": "#/components/schemas/VpcId"
},
{
"description": "The identifier of the VPC that the HSM is in."
}
]
},
"SubnetId": {
"allOf": [
{
"$ref": "#/components/schemas/SubnetId"
},
{
"description": "The identifier of the subnet that the HSM is in."
}
]
},
"IamRoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/IamRoleArn"
},
{
"description": "The ARN of the IAM role assigned to the HSM."
}
]
},
"SerialNumber": {
"allOf": [
{
"$ref": "#/components/schemas/HsmSerialNumber"
},
{
"description": "The serial number of the HSM."
}
]
},
"VendorName": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The name of the HSM vendor."
}
]
},
"HsmType": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The HSM model type."
}
]
},
"SoftwareVersion": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The HSM software version."
}
]
},
"SshPublicKey": {
"allOf": [
{
"$ref": "#/components/schemas/SshKey"
},
{
"description": "The public SSH key."
}
]
},
"SshKeyLastUpdated": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date and time that the SSH key was last updated."
}
]
},
"ServerCertUri": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The URI of the certificate server."
}
]
},
"ServerCertLastUpdated": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date and time that the server certificate was last updated."
}
]
},
"Partitions": {
"allOf": [
{
"$ref": "#/components/schemas/PartitionList"
},
{
"description": "The list of partitions on the HSM."
}
]
}
},
"description": "Contains the output of the <a>DescribeHsm</a> operation."
},
"DescribeHsmRequest": {
"type": "object",
"title": "DescribeHsmRequest",
"properties": {
"HsmArn": {
"allOf": [
{
"$ref": "#/components/schemas/HsmArn"
},
{
"description": "The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code> parameter must be specified."
}
]
},
"HsmSerialNumber": {
"allOf": [
{
"$ref": "#/components/schemas/HsmSerialNumber"
},
{
"description": "The serial number of the HSM. Either the <code>HsmArn</code> or the <code>HsmSerialNumber</code> parameter must be specified."
}
]
}
},
"description": "Contains the inputs for the <a>DescribeHsm</a> operation."
},
"DescribeLunaClientResponse": {
"type": "object",
"properties": {
"ClientArn": {
"allOf": [
{
"$ref": "#/components/schemas/ClientArn"
},
{
"description": "The ARN of the client."
}
]
},
"Certificate": {
"allOf": [
{
"$ref": "#/components/schemas/Certificate"
},
{
"description": "The certificate installed on the HSMs used by this client."
}
]
},
"CertificateFingerprint": {
"allOf": [
{
"$ref": "#/components/schemas/CertificateFingerprint"
},
{
"description": "The certificate fingerprint."
}
]
},
"LastModifiedTimestamp": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The date and time the client was last modified."
}
]
},
"Label": {
"allOf": [
{
"$ref": "#/components/schemas/Label"
},
{
"description": "The label of the client."
}
]
}
}
},
"DescribeLunaClientRequest": {
"type": "object",
"title": "DescribeLunaClientRequest",
"properties": {
"ClientArn": {
"allOf": [
{
"$ref": "#/components/schemas/ClientArn"
},
{
"description": "The ARN of the client."
}
]
},
"CertificateFingerprint": {
"allOf": [
{
"$ref": "#/components/schemas/CertificateFingerprint"
},
{
"description": "The certificate fingerprint."
}
]
}
}
},
"GetConfigResponse": {
"type": "object",
"properties": {
"ConfigType": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The type of credentials."
}
]
},
"ConfigFile": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The chrystoki.conf configuration file."
}
]
},
"ConfigCred": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The certificate file containing the server.pem files of the HSMs."
}
]
}
}
},
"GetConfigRequest": {
"type": "object",
"required": [
"ClientArn",
"ClientVersion",
"HapgList"
],
"title": "GetConfigRequest",
"properties": {
"ClientArn": {
"allOf": [
{
"$ref": "#/components/schemas/ClientArn"
},
{
"description": "The ARN of the client."
}
]
},
"ClientVersion": {
"allOf": [
{
"$ref": "#/components/schemas/ClientVersion"
},
{
"description": "The client version."
}
]
},
"HapgList": {
"allOf": [
{
"$ref": "#/components/schemas/HapgList"
},
{
"description": "A list of ARNs that identify the high-availability partition groups that are associated with the client."
}
]
}
}
},
"ListAvailableZonesResponse": {
"type": "object",
"properties": {
"AZList": {
"allOf": [
{
"$ref": "#/components/schemas/AZList"
},
{
"description": "The list of Availability Zones that have available AWS CloudHSM capacity."
}
]
}
}
},
"ListAvailableZonesRequest": {
"type": "object",
"title": "ListAvailableZonesRequest",
"properties": {},
"description": "Contains the inputs for the <a>ListAvailableZones</a> action."
},
"ListHapgsResponse": {
"type": "object",
"required": [
"HapgList"
],
"properties": {
"HapgList": {
"allOf": [
{
"$ref": "#/components/schemas/HapgList"
},
{
"description": "The list of high-availability partition groups."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "If not null, more results are available. Pass this value to <code>ListHapgs</code> to retrieve the next set of items."
}
]
}
}
},
"ListHapgsRequest": {
"type": "object",
"title": "ListHapgsRequest",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "The <code>NextToken</code> value from a previous call to <code>ListHapgs</code>. Pass null if this is the first call."
}
]
}
}
},
"ListHsmsResponse": {
"type": "object",
"properties": {
"HsmList": {
"allOf": [
{
"$ref": "#/components/schemas/HsmList"
},
{
"description": "The list of ARNs that identify the HSMs."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "If not null, more results are available. Pass this value to <code>ListHsms</code> to retrieve the next set of items."
}
]
}
},
"description": "Contains the output of the <code>ListHsms</code> operation."
},
"ListHsmsRequest": {
"type": "object",
"title": "ListHsmsRequest",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "The <code>NextToken</code> value from a previous call to <code>ListHsms</code>. Pass null if this is the first call."
}
]
}
}
},
"ListLunaClientsResponse": {
"type": "object",
"required": [
"ClientList"
],
"properties": {
"ClientList": {
"allOf": [
{
"$ref": "#/components/schemas/ClientList"
},
{
"description": "The list of clients."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "If not null, more results are available. Pass this to <code>ListLunaClients</code> to retrieve the next set of items."
}
]
}
}
},
"ListLunaClientsRequest": {
"type": "object",
"title": "ListLunaClientsRequest",
"properties": {
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "The <code>NextToken</code> value from a previous call to <code>ListLunaClients</code>. Pass null if this is the first call."
}
]
}
}
},
"ListTagsForResourceResponse": {
"type": "object",
"required": [
"TagList"
],
"properties": {
"TagList": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "One or more tags."
}
]
}
}
},
"ListTagsForResourceRequest": {
"type": "object",
"required": [
"ResourceArn"
],
"title": "ListTagsForResourceRequest",
"properties": {
"ResourceArn": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The Amazon Resource Name (ARN) of the AWS CloudHSM resource."
}
]
}
}
},
"ModifyHapgResponse": {
"type": "object",
"properties": {
"HapgArn": {
"allOf": [
{
"$ref": "#/components/schemas/HapgArn"
},
{
"description": "The ARN of the high-availability partition group."
}
]
}
}
},
"ModifyHapgRequest": {
"type": "object",
"required": [
"HapgArn"
],
"title": "ModifyHapgRequest",
"properties": {
"HapgArn": {
"allOf": [
{
"$ref": "#/components/schemas/HapgArn"
},
{
"description": "The ARN of the high-availability partition group to modify."
}
]
},
"Label": {
"allOf": [
{
"$ref": "#/components/schemas/Label"
},
{
"description": "The new label for the high-availability partition group."
}
]
},
"PartitionSerialList": {
"allOf": [
{
"$ref": "#/components/schemas/PartitionSerialList"
},
{
"description": "The list of partition serial numbers to make members of the high-availability partition group."
}
]
}
}
},
"ModifyHsmResponse": {
"type": "object",
"properties": {
"HsmArn": {
"allOf": [
{
"$ref": "#/components/schemas/HsmArn"
},
{
"description": "The ARN of the HSM."
}
]
}
},
"description": "Contains the output of the <a>ModifyHsm</a> operation."
},
"ModifyHsmRequest": {
"type": "object",
"required": [
"HsmArn"
],
"title": "ModifyHsmRequest",
"properties": {
"HsmArn": {
"allOf": [
{
"$ref": "#/components/schemas/HsmArn"
},
{
"description": "The ARN of the HSM to modify."
}
]
},
"SubnetId": {
"allOf": [
{
"$ref": "#/components/schemas/SubnetId"
},
{
"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": {
"allOf": [
{
"$ref": "#/components/schemas/IpAddress"
},
{
"description": "<p>The new IP address for the elastic network interface (ENI) attached to the HSM.</p> <p>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.</p>"
}
]
},
"IamRoleArn": {
"allOf": [
{
"$ref": "#/components/schemas/IamRoleArn"
},
{
"description": "The new IAM role ARN."
}
]
},
"ExternalId": {
"allOf": [
{
"$ref": "#/components/schemas/ExternalId"
},
{
"description": "The new external ID."
}
]
},
"SyslogIp": {
"allOf": [
{
"$ref": "#/components/schemas/IpAddress"
},
{
"description": "The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server."
}
]
}
},
"description": "Contains the inputs for the <a>ModifyHsm</a> operation."
},
"ModifyLunaClientResponse": {
"type": "object",
"properties": {
"ClientArn": {
"allOf": [
{
"$ref": "#/components/schemas/ClientArn"
},
{
"description": "The ARN of the client."
}
]
}
}
},
"ModifyLunaClientRequest": {
"type": "object",
"required": [
"ClientArn",
"Certificate"
],
"title": "ModifyLunaClientRequest",
"properties": {
"ClientArn": {
"allOf": [
{
"$ref": "#/components/schemas/ClientArn"
},
{
"description": "The ARN of the client."
}
]
},
"Certificate": {
"allOf": [
{
"$ref": "#/components/schemas/Certificate"
},
{
"description": "The new certificate for the client."
}
]
}
}
},
"RemoveTagsFromResourceResponse": {
"type": "object",
"required": [
"Status"
],
"properties": {
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The status of the operation."
}
]
}
}
},
"RemoveTagsFromResourceRequest": {
"type": "object",
"required": [
"ResourceArn",
"TagKeyList"
],
"title": "RemoveTagsFromResourceRequest",
"properties": {
"ResourceArn": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The Amazon Resource Name (ARN) of the AWS CloudHSM resource."
}
]
},
"TagKeyList": {
"allOf": [
{
"$ref": "#/components/schemas/TagKeyList"
},
{
"description": "<p>The tag key or keys to remove.</p> <p>Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>"
}
]
}
}
},
"AZ": {
"type": "string",
"pattern": "[a-zA-Z0-9\\-]*"
},
"AZList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AZ"
}
},
"String": {
"type": "string",
"pattern": "[\\w :+=./\\\\-]*"
},
"TagList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
},
"Certificate": {
"type": "string",
"pattern": "[\\w :+=./\\n-]*",
"minLength": 600,
"maxLength": 2400
},
"CertificateFingerprint": {
"type": "string",
"pattern": "([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]"
},
"ClientArn": {
"type": "string",
"pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:client-[0-9a-f]{8}"
},
"ClientLabel": {
"type": "string",
"pattern": "[a-zA-Z0-9_.-]{2,64}"
},
"ClientList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientArn"
}
},
"ClientToken": {
"type": "string",
"pattern": "[a-zA-Z0-9]{1,64}"
},
"ClientVersion": {
"type": "string",
"enum": [
"5.1",
"5.3"
]
},
"CloudHsmObjectState": {
"type": "string",
"enum": [
"READY",
"UPDATING",
"DEGRADED"
]
},
"Label": {
"type": "string",
"pattern": "[a-zA-Z0-9_.-]{1,64}"
},
"HapgArn": {
"type": "string",
"pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hapg-[0-9a-f]{8}"
},
"SubnetId": {
"type": "string",
"pattern": "subnet-[0-9a-f]{8}"
},
"SshKey": {
"type": "string",
"pattern": "[a-zA-Z0-9+/= ._:\\\\@-]*"
},
"IpAddress": {
"type": "string",
"pattern": "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"
},
"IamRoleArn": {
"type": "string",
"pattern": "arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\\+=,\\.\\-@]{1,64}"
},
"ExternalId": {
"type": "string",
"pattern": "[\\w :+=./-]*"
},
"SubscriptionType": {
"type": "string",
"enum": [
"PRODUCTION"
],
"description": "<p>Specifies the type of subscription for the HSM.</p> <ul> <li> <p> <b>PRODUCTION</b> - The HSM is being used in a production environment.</p> </li> <li> <p> <b>TRIAL</b> - The HSM is being used in a product trial.</p> </li> </ul>"
},
"HsmArn": {
"type": "string",
"pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}",
"description": "An ARN that identifies an HSM."
},
"HsmList": {
"type": "array",
"description": "Contains a list of ARNs that identify the HSMs.",
"items": {
"$ref": "#/components/schemas/HsmArn"
}
},
"Timestamp": {
"type": "string",
"pattern": "\\d*"
},
"PartitionSerialList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartitionSerial"
}
},
"HsmSerialNumber": {
"type": "string",
"pattern": "\\d{1,16}"
},
"HsmStatus": {
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"UPDATING",
"SUSPENDED",
"TERMINATING",
"TERMINATED",
"DEGRADED"
]
},
"EniId": {
"type": "string",
"pattern": "eni-[0-9a-f]{8}"
},
"VpcId": {
"type": "string",
"pattern": "vpc-[0-9a-f]{8}"
},
"PartitionList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartitionArn"
}
},
"HapgList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HapgArn"
}
},
"PaginationToken": {
"type": "string",
"pattern": "[a-zA-Z0-9+/]*"
},
"PartitionArn": {
"type": "string",
"pattern": "arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12}"
},
"PartitionSerial": {
"type": "string",
"pattern": "\\d{6,12}"
},
"TagKeyList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagKey"
}
},
"TagKey": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"TagValue": {
"type": "string",
"minLength": 0,
"maxLength": 256
},
"Tag": {
"type": "object",
"required": [
"Key",
"Value"
],
"properties": {
"Key": {
"allOf": [
{
"$ref": "#/components/schemas/TagKey"
},
{
"description": "The key of the tag."
}
]
},
"Value": {
"allOf": [
{
"$ref": "#/components/schemas/TagValue"
},
{
"description": "The value of the tag."
}
]
}
},
"description": "A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource."
}
}
},
"security": [
{
"hmac": []
}
]
}