Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.cloudhsm;
 
Interface for accessing AWSCloudHSM. AWS CloudHSM Service
 
 public interface AWSCloudHSM {

    
Overrides the default endpoint for this client ("https://cloudhsm.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cloudhsm.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudhsm.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's com.amazonaws.ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:
endpoint The endpoint (ex: "cloudhsm.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudhsm.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.
Throws:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
 
     public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the com.amazonaws.ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

 
     public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

Parameters:
getConfigRequest Container for the necessary parameters to execute the GetConfig service method on AWSCloudHSM.
Returns:
The response from the GetConfig service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public GetConfigResult getConfig(GetConfigRequest getConfigRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Parameters:
createHapgRequest Container for the necessary parameters to execute the CreateHapg service method on AWSCloudHSM.
Returns:
The response from the CreateHapg service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public CreateHapgResult createHapg(CreateHapgRequest createHapgRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Retrieves information about a high-availability partition group.

Parameters:
describeHapgRequest Container for the necessary parameters to execute the DescribeHapg service method on AWSCloudHSM.
Returns:
The response from the DescribeHapg service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public DescribeHapgResult describeHapg(DescribeHapgRequest describeHapgRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Lists the Availability Zones that have available AWS CloudHSM capacity.

Parameters:
listAvailableZonesRequest Container for the necessary parameters to execute the ListAvailableZones service method on AWSCloudHSM.
Returns:
The response from the ListAvailableZones service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Modifies an HSM.

Parameters:
modifyHsmRequest Container for the necessary parameters to execute the ModifyHsm service method on AWSCloudHSM.
Returns:
The response from the ModifyHsm service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ModifyHsmResult modifyHsm(ModifyHsmRequest modifyHsmRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
listLunaClientsRequest Container for the necessary parameters to execute the ListLunaClients service method on AWSCloudHSM.
Returns:
The response from the ListLunaClients service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ListLunaClientsResult listLunaClients(ListLunaClientsRequest listLunaClientsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Parameters:
listHapgsRequest Container for the necessary parameters to execute the ListHapgs service method on AWSCloudHSM.
Returns:
The response from the ListHapgs service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ListHapgsResult listHapgs(ListHapgsRequest listHapgsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.

Parameters:
deleteHsmRequest Container for the necessary parameters to execute the DeleteHsm service method on AWSCloudHSM.
Returns:
The response from the DeleteHsm service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public DeleteHsmResult deleteHsm(DeleteHsmRequest deleteHsmRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.

Parameters:
createHsmRequest Container for the necessary parameters to execute the CreateHsm service method on AWSCloudHSM.
Returns:
The response from the CreateHsm service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public CreateHsmResult createHsm(CreateHsmRequest createHsmRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Parameters:
listHsmsRequest Container for the necessary parameters to execute the ListHsms service method on AWSCloudHSM.
Returns:
The response from the ListHsms service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ListHsmsResult listHsms(ListHsmsRequest listHsmsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Parameters:
describeHsmRequest Container for the necessary parameters to execute the DescribeHsm service method on AWSCloudHSM.
Returns:
The response from the DescribeHsm service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public DescribeHsmResult describeHsm(DescribeHsmRequest describeHsmRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Deletes a high-availability partition group.

Parameters:
deleteHapgRequest Container for the necessary parameters to execute the DeleteHapg service method on AWSCloudHSM.
Returns:
The response from the DeleteHapg service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public DeleteHapgResult deleteHapg(DeleteHapgRequest deleteHapgRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Modifies an existing high-availability partition group.

Parameters:
modifyHapgRequest Container for the necessary parameters to execute the ModifyHapg service method on AWSCloudHSM.
Returns:
The response from the ModifyHapg service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ModifyHapgResult modifyHapg(ModifyHapgRequest modifyHapgRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Creates an HSM client.

Parameters:
createLunaClientRequest Container for the necessary parameters to execute the CreateLunaClient service method on AWSCloudHSM.
Returns:
The response from the CreateLunaClient service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public CreateLunaClientResult createLunaClient(CreateLunaClientRequest createLunaClientRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Deletes a client.

Parameters:
deleteLunaClientRequest Container for the necessary parameters to execute the DeleteLunaClient service method on AWSCloudHSM.
Returns:
The response from the DeleteLunaClient service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

Parameters:
modifyLunaClientRequest Container for the necessary parameters to execute the ModifyLunaClient service method on AWSCloudHSM.
Returns:
The response from the ModifyLunaClient service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Retrieves information about an HSM client.

Parameters:
describeLunaClientRequest Container for the necessary parameters to execute the DescribeLunaClient service method on AWSCloudHSM.
Returns:
The response from the DescribeLunaClient service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Lists the Availability Zones that have available AWS CloudHSM capacity.

Returns:
The response from the ListAvailableZones service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

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.

Returns:
The response from the ListLunaClients service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Returns:
The response from the ListHapgs service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ListHapgsResult listHapgs() throws AmazonServiceExceptionAmazonClientException;
    
    

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Returns:
The response from the ListHsms service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public ListHsmsResult listHsms() throws AmazonServiceExceptionAmazonClientException;
    
    

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Returns:
The response from the DescribeHsm service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
    public DescribeHsmResult describeHsm() throws AmazonServiceExceptionAmazonClientException;
    
    

Retrieves information about an HSM client.

Returns:
The response from the DescribeLunaClient service method, as returned by AWSCloudHSM.
Throws:
com.amazonaws.services.cloudhsm.model.InvalidRequestException
com.amazonaws.services.cloudhsm.model.CloudHsmInternalException
com.amazonaws.services.cloudhsm.model.CloudHsmServiceException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    public void shutdown();
    
    
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:
request The originally executed request.
Returns:
The response metadata for the specified request, or null if none is available.
}
        
New to GrepCode? Check out our FAQ X