list_assessment_run_agents `async` ¶

list_assessment_run_agents(
    assessment_run_arn: Arn,
    *,
    config_overrides: Optional[AsyncInspectorClientConfig] = None,
    filter: Optional[AgentFilter] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[ListMaxResults] = None,
) -> ListAssessmentRunAgentsResponse

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

Parameters:

assessment_run_arn (Arn) –

The ARN that specifies the assessment run whose agents you want to list.
filter (Optional[AgentFilter], default: None ) –

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.
next_token (Optional[PaginationToken], default: None ) –

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
max_results (Optional[ListMaxResults], default: None ) –

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

Raises:

AccessDeniedException –

You do not have required permissions to access the requested resource.
InternalException –

Internal server error.
InvalidInputException –

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
NoSuchEntityException –

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

List assessment run agents Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

>>> await client.list_assessment_run_agents(assessment_run_arn='arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE', max_results=123)

Source code in docs_src/capo_inspector/_services/async_inspector.py

async def list_assessment_run_agents(
    self,
    assessment_run_arn: "capo_inspector.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncInspectorClientConfig] = None,
    filter: Optional["capo_inspector.types.agent_filter.AgentFilter"] = None,
    next_token: Optional[
        "capo_inspector.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_inspector.types.list_max_results.ListMaxResults"
    ] = None,
) -> "capo_inspector.types.list_assessment_run_agents_response.ListAssessmentRunAgentsResponse":
    """<p>Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.</p>

    Args:
        assessment_run_arn: <p>The ARN that specifies the assessment run whose agents you want to list.</p>
        filter: <p>You can use this parameter to specify a subset of data to be included in the action's response.</p> <p>For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.</p>
        next_token: <p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the <b>ListAssessmentRunAgents</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: <p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.</p>

    Raises:
        capo_inspector.errors.access_denied_exception.AccessDeniedException: <p>You do not have required permissions to access the requested resource.</p>
        capo_inspector.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_inspector.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>
        capo_inspector.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced an entity that does not exist. The error code describes the entity.</p>
        capo_inspector.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List assessment run agents
        Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

        >>> await client.list_assessment_run_agents(assessment_run_arn='arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE', max_results=123)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_inspector.types.list_assessment_run_agents_request.ListAssessmentRunAgentsRequest]",
    ) -> AsyncOperationResponse[
        "capo_inspector.types.list_assessment_run_agents_response.ListAssessmentRunAgentsResponse"
    ]:
        import capo_inspector._operations.inspector_service.list_assessment_run_agents

        (
            output,
            http_response,
        ) = await capo_inspector._operations.inspector_service.list_assessment_run_agents.async_list_assessment_run_agents(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAssessmentRunAgents")
    )
    input_: capo_inspector.types.list_assessment_run_agents_request.ListAssessmentRunAgentsRequest = {
        "assessment_run_arn": assessment_run_arn
    }
    if filter is not None:
        input_["filter"] = filter
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_assessment_run_agents async ¶

list_assessment_run_agents `async` ¶