Skip to content

list_assessment_targets

list_assessment_targets(
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
    filter: Optional[AssessmentTargetFilter] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[ListMaxResults] = None,
) -> ListAssessmentTargetsResponse

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

Parameters:

  • filter (Optional[AssessmentTargetFilter], 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 ListAssessmentTargets 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 you want in the response. The default value is 10. The maximum value is 500.

Raises:

Examples:

List assessment targets Lists the ARNs of the assessment targets within this AWS account.

>>> client.list_assessment_targets(max_results=123)
Source code in docs_src/capo_inspector/_services/inspector.py
def list_assessment_targets(
    self,
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
    filter: Optional[
        "capo_inspector.types.assessment_target_filter.AssessmentTargetFilter"
    ] = 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_targets_response.ListAssessmentTargetsResponse":
    """<p>Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see <a href="https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html">Amazon Inspector Assessment Targets</a>.</p>

    Args:
        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>ListAssessmentTargets</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 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.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List assessment targets
        Lists the ARNs of the assessment targets within this AWS account.

        >>> client.list_assessment_targets(max_results=123)
    """

    def _handler(
        req: "OperationRequest[capo_inspector.types.list_assessment_targets_request.ListAssessmentTargetsRequest]",
    ) -> OperationResponse[
        "capo_inspector.types.list_assessment_targets_response.ListAssessmentTargetsResponse"
    ]:
        import capo_inspector._operations.inspector_service.list_assessment_targets

        output, http_response = (
            capo_inspector._operations.inspector_service.list_assessment_targets.list_assessment_targets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAssessmentTargets")
    )
    input_: capo_inspector.types.list_assessment_targets_request.ListAssessmentTargetsRequest = {}
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output