Skip to content

PreviewAgentsRequest

Source code in docs_src/capo_inspector/types/preview_agents_request.py 
15
16
17
18
19
20
21
22
23
class PreviewAgentsRequest(TypedDict, closed=True):
    preview_agents_arn: "capo_inspector.types.arn.Arn"
    """<p>The ARN of the assessment target whose agents you want to preview.</p>"""
    next_token: NotRequired["capo_inspector.types.pagination_token.PaginationToken"]
    """<p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the <b>PreviewAgents</b> action. Subsequent calls to the action fill <b>nextToken</b> in the request with the value of <b>NextToken</b> from the previous response to continue listing data.</p>"""
    max_results: NotRequired[
        "capo_inspector.types.preview_agents_max_results.PreviewAgentsMaxResults"
    ]
    """<p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.</p>"""

max_results instance-attribute 

max_results: NotRequired[PreviewAgentsMaxResults]

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

preview_agents_arn instance-attribute 

preview_agents_arn: Arn

The ARN of the assessment target whose agents you want to preview.