{
"version":"2.0",
"metadata":{
"apiVersion":"2014-05-30",
"endpointPrefix":"cloudhsm",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"CloudHSM",
"serviceFullName":"Amazon CloudHSM",
"signatureVersion":"v4",
"targetPrefix":"CloudHsmFrontendService",
"uid":"cloudhsm-2014-05-30"
},
"operations":{
"AddTagsToResource":{
"name":"AddTagsToResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsToResourceRequest"},
"output":{"shape":"AddTagsToResourceResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<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>"
},
"CreateHapg":{
"name":"CreateHapg",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateHapgRequest"},
"output":{"shape":"CreateHapgResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.</p>"
},
"CreateHsm":{
"name":"CreateHsm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateHsmRequest"},
"output":{"shape":"CreateHsmResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates an uninitialized HSM instance.</p> <p>There is an upfront fee charged for each HSM instance that you create with the <a>CreateHsm</a> 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>"
},
"CreateLunaClient":{
"name":"CreateLunaClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateLunaClientRequest"},
"output":{"shape":"CreateLunaClientResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates an HSM client.</p>"
},
"DeleteHapg":{
"name":"DeleteHapg",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteHapgRequest"},
"output":{"shape":"DeleteHapgResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes a high-availability partition group.</p>"
},
"DeleteHsm":{
"name":"DeleteHsm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteHsmRequest"},
"output":{"shape":"DeleteHsmResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>"
},
"DeleteLunaClient":{
"name":"DeleteLunaClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteLunaClientRequest"},
"output":{"shape":"DeleteLunaClientResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes a client.</p>"
},
"DescribeHapg":{
"name":"DescribeHapg",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeHapgRequest"},
"output":{"shape":"DescribeHapgResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Retrieves information about a high-availability partition group.</p>"
},
"DescribeHsm":{
"name":"DescribeHsm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeHsmRequest"},
"output":{"shape":"DescribeHsmResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.</p>"
},
"DescribeLunaClient":{
"name":"DescribeLunaClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeLunaClientRequest"},
"output":{"shape":"DescribeLunaClientResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Retrieves information about an HSM client.</p>"
},
"GetConfig":{
"name":"GetConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetConfigRequest"},
"output":{"shape":"GetConfigResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>"
},
"ListAvailableZones":{
"name":"ListAvailableZones",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListAvailableZonesRequest"},
"output":{"shape":"ListAvailableZonesResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>"
},
"ListHapgs":{
"name":"ListHapgs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListHapgsRequest"},
"output":{"shape":"ListHapgsResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Lists the high-availability partition groups for the account.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items.</p>"
},
"ListHsms":{
"name":"ListHsms",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListHsmsRequest"},
"output":{"shape":"ListHsmsResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<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 <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items.</p>"
},
"ListLunaClients":{
"name":"ListLunaClients",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListLunaClientsRequest"},
"output":{"shape":"ListLunaClientsResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Lists all of the clients.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>"
},
"ModifyHapg":{
"name":"ModifyHapg",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyHapgRequest"},
"output":{"shape":"ModifyHapgResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Modifies an existing high-availability partition group.</p>"
},
"ModifyHsm":{
"name":"ModifyHsm",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyHsmRequest"},
"output":{"shape":"ModifyHsmResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<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>"
},
"ModifyLunaClient":{
"name":"ModifyLunaClient",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyLunaClientRequest"},
"output":{"shape":"ModifyLunaClientResponse"},
"errors":[
{"shape":"CloudHsmServiceException"}
],
"documentation":"<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>"
},
"RemoveTagsFromResource":{
"name":"RemoveTagsFromResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveTagsFromResourceRequest"},
"output":{"shape":"RemoveTagsFromResourceResponse"},
"errors":[
{"shape":"CloudHsmServiceException"},
{"shape":"CloudHsmInternalException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<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>"
}
},
"shapes":{
"AZ":{
"type":"string",
"pattern":"[a-zA-Z0-9\\-]*"
},
"AZList":{
"type":"list",
"member":{"shape":"AZ"}
},
"AddTagsToResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagList"
],
"members":{
"ResourceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.</p>"
},
"TagList":{
"shape":"TagList",
"documentation":"<p>One or more tags.</p>"
}
}
},
"AddTagsToResourceResponse":{
"type":"structure",
"required":["Status"],
"members":{
"Status":{
"shape":"String",
Loading ...