Skip to content

list_rules_packages

list_rules_packages(
    *,
    config_overrides: Optional[InspectorClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[ListMaxResults] = None,
) -> ListRulesPackagesResponse

Lists all available Amazon Inspector rules packages.

Parameters:

  • 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 ListRulesPackages 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 rules packages Lists all available Amazon Inspector rules packages.

>>> client.list_rules_packages(max_results=123)
Source code in docs_src/capo_inspector/_services/inspector.py
def list_rules_packages(
    self,
    *,
    config_overrides: Optional[InspectorClientConfig] = 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_rules_packages_response.ListRulesPackagesResponse":
    """<p>Lists all available Amazon Inspector rules packages.</p>

    Args:
        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>ListRulesPackages</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 rules packages
        Lists all available Amazon Inspector rules packages.

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

    def _handler(
        req: "OperationRequest[capo_inspector.types.list_rules_packages_request.ListRulesPackagesRequest]",
    ) -> OperationResponse[
        "capo_inspector.types.list_rules_packages_response.ListRulesPackagesResponse"
    ]:
        import capo_inspector._operations.inspector_service.list_rules_packages

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRulesPackages")
    )
    input_: capo_inspector.types.list_rules_packages_request.ListRulesPackagesRequest = {}
    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