Skip to content

list_cis_scans async

list_cis_scans(
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
    filter_criteria: Optional[ListCisScansFilterCriteria] = None,
    detail_level: Optional[ListCisScansDetailLevel] = None,
    sort_by: Optional[ListCisScansSortBy] = None,
    sort_order: Optional[CisSortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[ListCisScansMaxResults] = None,
) -> ListCisScansResponse

Returns a CIS scan list.

Parameters:

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

    For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

  • InternalServerException –

    The request has failed due to an internal failure of the Amazon Inspector service.

  • ThrottlingException –

    The limit on the number of requests per second was exceeded.

  • ValidationException –

    The request has failed validation due to missing required fields or having invalid inputs.

  • UnknownServiceError –

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

Examples:

Sample ListCisScans Call

>>> await client.list_cis_scans()
Source code in docs_src/capo_inspector2/_services/async_inspector2.py
async def list_cis_scans(
    self,
    *,
    config_overrides: Optional[AsyncInspector2ClientConfig] = None,
    filter_criteria: Optional[
        "capo_inspector2.types.list_cis_scans_filter_criteria.ListCisScansFilterCriteria"
    ] = None,
    detail_level: Optional[
        "capo_inspector2.types.list_cis_scans_detail_level.ListCisScansDetailLevel"
    ] = None,
    sort_by: Optional[
        "capo_inspector2.types.list_cis_scans_sort_by.ListCisScansSortBy"
    ] = None,
    sort_order: Optional[
        "capo_inspector2.types.cis_sort_order.CisSortOrder"
    ] = None,
    next_token: Optional["capo_inspector2.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_inspector2.types.list_cis_scans_max_results.ListCisScansMaxResults"
    ] = None,
) -> "capo_inspector2.types.list_cis_scans_response.ListCisScansResponse":
    """<p>Returns a CIS scan list.</p>

    Args:
        filter_criteria: <p>The CIS scan filter criteria.</p>
        detail_level: <p>The detail applied to the CIS scan.</p>
        sort_by: <p>The CIS scans sort by order.</p>
        sort_order: <p>The CIS scans sort order.</p>
        next_token: <p>The pagination token from a previous request that's used to retrieve the next page of results.</p>
        max_results: <p>The maximum number of results to be returned.</p>

    Raises:
        capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
        capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
        capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
        capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Sample ListCisScans Call

        >>> await client.list_cis_scans()
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_inspector2.types.list_cis_scans_request.ListCisScansRequest]",
    ) -> AsyncOperationResponse[
        "capo_inspector2.types.list_cis_scans_response.ListCisScansResponse"
    ]:
        import capo_inspector2._operations.inspector2.list_cis_scans

        (
            output,
            http_response,
        ) = await capo_inspector2._operations.inspector2.list_cis_scans.async_list_cis_scans(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCisScans")
    )
    input_: capo_inspector2.types.list_cis_scans_request.ListCisScansRequest = {}
    if filter_criteria is not None:
        input_["filter_criteria"] = filter_criteria
    if detail_level is not None:
        input_["detail_level"] = detail_level
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    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