Skip to content

SearchOutput

Source code in docs_src/capo_resource_explorer_2/types/search_output.py
class SearchOutput(TypedDict, closed=True):
    resources: NotRequired["capo_resource_explorer_2.types.resource_list.ResourceList"]
    """<p>The list of structures that describe the resources that match the query.</p>"""
    next_token: NotRequired["str"]
    """<p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>"""
    view_arn: NotRequired["str"]
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon resource name (ARN)</a> of the view that this operation used to perform the search.</p>"""
    count: NotRequired["capo_resource_explorer_2.types.resource_count.ResourceCount"]
    """<p>The number of resources that match the query.</p>"""

count instance-attribute

count: NotRequired[ResourceCount]

The number of resources that match the query.

next_token instance-attribute

next_token: NotRequired[str]

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. The pagination tokens expire after 24 hours.

resources instance-attribute

resources: NotRequired[ResourceList]

The list of structures that describe the resources that match the query.

view_arn instance-attribute

view_arn: NotRequired[str]

The Amazon resource name (ARN) of the view that this operation used to perform the search.