Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken
value. Use this value in a subsequent DescribeClusters
request to get more clusters. When you receive a response with no NextToken
(or an empty or null value), that means there are no more clusters to get.
Cross-account use: No. You cannot perform this operation on AWS CloudHSM clusters in a different AWS account.
Request Syntax{
"Filters": {
"string
" : [ "string
" ]
},
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
One or more filters to limit the items returned in the response.
Use the clusterIds
filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).
Use the vpcIds
filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).
Use the states
filter to return only clusters that match the specified state.
Type: String to array of strings map
Map Entries: Maximum number of 30 items.
Key Pattern: [a-zA-Z0-9_-]+
Required: No
The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken
value.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 25.
Required: No
The NextToken
value that you received in the previous response. Use this value to get more clusters.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*
Required: No
{
"Clusters": [
{
"BackupPolicy": "string",
"BackupRetentionPolicy": {
"Type": "string",
"Value": "string"
},
"Certificates": {
"AwsHardwareCertificate": "string",
"ClusterCertificate": "string",
"ClusterCsr": "string",
"HsmCertificate": "string",
"ManufacturerHardwareCertificate": "string"
},
"ClusterId": "string",
"CreateTimestamp": number,
"Hsms": [
{
"AvailabilityZone": "string",
"ClusterId": "string",
"EniId": "string",
"EniIp": "string",
"EniIpV6": "string",
"HsmId": "string",
"HsmType": "string",
"State": "string",
"StateMessage": "string",
"SubnetId": "string"
}
],
"HsmType": "string",
"HsmTypeRollbackExpiration": number,
"Mode": "string",
"NetworkType": "string",
"PreCoPassword": "string",
"SecurityGroup": "string",
"SourceBackupId": "string",
"State": "string",
"StateMessage": "string",
"SubnetMapping": {
"string" : "string"
},
"TagList": [
{
"Key": "string",
"Value": "string"
}
],
"VpcId": "string"
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
A list of clusters.
Type: Array of Cluster objects
An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters
request to get more clusters.
Type: String
Length Constraints: Maximum length of 256.
Pattern: .*
For information about the errors that are common to all actions, see Common Errors.
The request was rejected because the requester does not have permission to perform the requested operation.
HTTP Status Code: 400
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
HTTP Status Code: 500
The request was rejected because it is not a valid request.
HTTP Status Code: 400
The request was rejected because an error occurred.
HTTP Status Code: 400
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
HTTP Status Code: 400
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4