public class AWSCloudHSMClient extends AmazonWebServiceClient implements AWSCloudHSM
LOGGING_AWS_REQUEST_METRIC| Constructor and Description |
|---|
AWSCloudHSMClient()
Constructs a new client to invoke service methods on CloudHSM.
|
AWSCloudHSMClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on CloudHSM using the
specified AWS account credentials.
|
AWSCloudHSMClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on CloudHSM using the
specified AWS account credentials and client configuration options.
|
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on CloudHSM using the
specified AWS account credentials provider.
|
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on CloudHSM using the
specified AWS account credentials provider and client configuration
options.
|
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on CloudHSM using the
specified AWS account credentials provider, client configuration options,
and request metric collector.
|
AWSCloudHSMClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on CloudHSM.
|
| Modifier and Type | Method and Description |
|---|---|
CreateHapgResult |
createHapg(CreateHapgRequest createHapgRequest)
Creates a high-availability partition group.
|
CreateHsmResult |
createHsm(CreateHsmRequest createHsmRequest)
Creates an uninitialized HSM instance.
|
CreateLunaClientResult |
createLunaClient(CreateLunaClientRequest createLunaClientRequest)
Creates an HSM client.
|
DeleteHapgResult |
deleteHapg(DeleteHapgRequest deleteHapgRequest)
Deletes a high-availability partition group.
|
DeleteHsmResult |
deleteHsm(DeleteHsmRequest deleteHsmRequest)
Deletes an HSM.
|
DeleteLunaClientResult |
deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
Deletes a client.
|
DescribeHapgResult |
describeHapg(DescribeHapgRequest describeHapgRequest)
Retrieves information about a high-availability partition group.
|
DescribeHsmResult |
describeHsm()
Simplified method form for invoking the DescribeHsm operation.
|
DescribeHsmResult |
describeHsm(DescribeHsmRequest describeHsmRequest)
Retrieves information about an HSM.
|
DescribeLunaClientResult |
describeLunaClient()
Simplified method form for invoking the DescribeLunaClient operation.
|
DescribeLunaClientResult |
describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
Retrieves information about an HSM client.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful,
request, typically used for debugging issues where a service isn't acting
as expected.
|
GetConfigResult |
getConfig(GetConfigRequest getConfigRequest)
Gets the configuration files necessary to connect to all high
availability partition groups the client is associated with.
|
ListAvailableZonesResult |
listAvailableZones()
Simplified method form for invoking the ListAvailableZones operation.
|
ListAvailableZonesResult |
listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
Lists the Availability Zones that have available AWS CloudHSM capacity.
|
ListHapgsResult |
listHapgs()
Simplified method form for invoking the ListHapgs operation.
|
ListHapgsResult |
listHapgs(ListHapgsRequest listHapgsRequest)
Lists the high-availability partition groups for the account.
|
ListHsmsResult |
listHsms()
Simplified method form for invoking the ListHsms operation.
|
ListHsmsResult |
listHsms(ListHsmsRequest listHsmsRequest)
Retrieves the identifiers of all of the HSMs provisioned for the current
customer.
|
ListLunaClientsResult |
listLunaClients()
Simplified method form for invoking the ListLunaClients operation.
|
ListLunaClientsResult |
listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
Lists all of the clients.
|
ModifyHapgResult |
modifyHapg(ModifyHapgRequest modifyHapgRequest)
Modifies an existing high-availability partition group.
|
ModifyHsmResult |
modifyHsm(ModifyHsmRequest modifyHsmRequest)
Modifies an HSM.
|
ModifyLunaClientResult |
modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
Modifies the certificate used by the client.
|
addRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic AWSCloudHSMClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AWSCloudHSMClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client
connects to CloudHSM (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AWSCloudHSMClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AWSCloudHSMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to CloudHSM (ex: proxy settings, retry counts, etc.).public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to CloudHSM (ex: proxy settings, retry counts, etc.).public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client
connects to CloudHSM (ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic CreateHapgResult createHapg(CreateHapgRequest createHapgRequest)
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
createHapg in interface AWSCloudHSMcreateHapgRequest - Contains the inputs for the CreateHapgRequest action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public CreateHsmResult createHsm(CreateHsmRequest createHsmRequest)
Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.
createHsm in interface AWSCloudHSMcreateHsmRequest - Contains the inputs for the CreateHsm action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public CreateLunaClientResult createLunaClient(CreateLunaClientRequest createLunaClientRequest)
Creates an HSM client.
createLunaClient in interface AWSCloudHSMcreateLunaClientRequest - Contains the inputs for the CreateLunaClient action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public DeleteHapgResult deleteHapg(DeleteHapgRequest deleteHapgRequest)
Deletes a high-availability partition group.
deleteHapg in interface AWSCloudHSMdeleteHapgRequest - Contains the inputs for the DeleteHapg action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public DeleteHsmResult deleteHsm(DeleteHsmRequest deleteHsmRequest)
Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.
deleteHsm in interface AWSCloudHSMdeleteHsmRequest - Contains the inputs for the DeleteHsm action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
Deletes a client.
deleteLunaClient in interface AWSCloudHSMdeleteLunaClientRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public DescribeHapgResult describeHapg(DescribeHapgRequest describeHapgRequest)
Retrieves information about a high-availability partition group.
describeHapg in interface AWSCloudHSMdescribeHapgRequest - Contains the inputs for the DescribeHapg action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public DescribeHsmResult describeHsm(DescribeHsmRequest describeHsmRequest)
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
describeHsm in interface AWSCloudHSMdescribeHsmRequest - Contains the inputs for the DescribeHsm action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public DescribeHsmResult describeHsm()
AWSCloudHSMdescribeHsm in interface AWSCloudHSMAWSCloudHSM.describeHsm(DescribeHsmRequest)public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
Retrieves information about an HSM client.
describeLunaClient in interface AWSCloudHSMdescribeLunaClientRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public DescribeLunaClientResult describeLunaClient()
AWSCloudHSMdescribeLunaClient in interface AWSCloudHSMAWSCloudHSM.describeLunaClient(DescribeLunaClientRequest)public GetConfigResult getConfig(GetConfigRequest getConfigRequest)
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
getConfig in interface AWSCloudHSMgetConfigRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
Lists the Availability Zones that have available AWS CloudHSM capacity.
listAvailableZones in interface AWSCloudHSMlistAvailableZonesRequest - Contains the inputs for the ListAvailableZones action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public ListAvailableZonesResult listAvailableZones()
AWSCloudHSMlistAvailableZones in interface AWSCloudHSMAWSCloudHSM.listAvailableZones(ListAvailableZonesRequest)public ListHapgsResult listHapgs(ListHapgsRequest listHapgsRequest)
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.
listHapgs in interface AWSCloudHSMlistHapgsRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public ListHapgsResult listHapgs()
AWSCloudHSMlistHapgs in interface AWSCloudHSMAWSCloudHSM.listHapgs(ListHapgsRequest)public ListHsmsResult listHsms(ListHsmsRequest listHsmsRequest)
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.
listHsms in interface AWSCloudHSMlistHsmsRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public ListHsmsResult listHsms()
AWSCloudHSMlistHsms in interface AWSCloudHSMAWSCloudHSM.listHsms(ListHsmsRequest)public ListLunaClientsResult listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
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.
listLunaClients in interface AWSCloudHSMlistLunaClientsRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public ListLunaClientsResult listLunaClients()
AWSCloudHSMlistLunaClients in interface AWSCloudHSMAWSCloudHSM.listLunaClients(ListLunaClientsRequest)public ModifyHapgResult modifyHapg(ModifyHapgRequest modifyHapgRequest)
Modifies an existing high-availability partition group.
modifyHapg in interface AWSCloudHSMmodifyHapgRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public ModifyHsmResult modifyHsm(ModifyHsmRequest modifyHsmRequest)
Modifies an HSM.
modifyHsm in interface AWSCloudHSMmodifyHsmRequest - Contains the inputs for the ModifyHsm action.CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException - Indicates that an internal error occurred.InvalidRequestException - Indicates that one or more of the request parameters are not
valid.public ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.
modifyLunaClient in interface AWSCloudHSMmodifyLunaClientRequest - CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AWSCloudHSMrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.