Skip to content

DescribeClustersRequest

Source code in docs_src/capo_cloudhsm_v2/types/describe_clusters_request.py 
13
14
15
16
17
18
19
class DescribeClustersRequest(TypedDict, closed=True):
    filters: NotRequired["capo_cloudhsm_v2.types.filters.Filters"]
    """<p>One or more filters to limit the items returned in the response.</p> <p>Use the <code>clusterIds</code> filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).</p> <p>Use the <code>vpcIds</code> filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).</p> <p>Use the <code>states</code> filter to return only clusters that match the specified state.</p>"""
    next_token: NotRequired["capo_cloudhsm_v2.types.next_token.NextToken"]
    """<p>The <code>NextToken</code> value that you received in the previous response. Use this value to get more clusters.</p>"""
    max_results: NotRequired["capo_cloudhsm_v2.types.clusters_max_size.ClustersMaxSize"]
    """<p>The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a <code>NextToken</code> value.</p>"""

filters instance-attribute 

filters: NotRequired[Filters]

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.

max_results instance-attribute 

max_results: NotRequired[ClustersMaxSize]

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.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The NextToken value that you received in the previous response. Use this value to get more clusters.