Skip to content

list_audit_suppressions

list_audit_suppressions(
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    check_name: Optional[AuditCheckName] = None,
    resource_identifier: Optional[ResourceIdentifier] = None,
    ascending_order: Optional[AscendingOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListAuditSuppressionsResponse

Lists your Device Defender audit listings.

Requires permission to access the ListAuditSuppressions action.

Parameters:

  • ascending_order (Optional[AscendingOrder], default: None ) –

    Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, ascendingOrder=true.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next set of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return at one time. The default is 25.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def list_audit_suppressions(
    self,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    check_name: Optional["capo_iot.types.audit_check_name.AuditCheckName"] = None,
    resource_identifier: Optional[
        "capo_iot.types.resource_identifier.ResourceIdentifier"
    ] = None,
    ascending_order: Optional[
        "capo_iot.types.ascending_order.AscendingOrder"
    ] = None,
    next_token: Optional["capo_iot.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iot.types.max_results.MaxResults"] = None,
) -> (
    "capo_iot.types.list_audit_suppressions_response.ListAuditSuppressionsResponse"
):
    """<p> Lists your Device Defender audit listings. </p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListAuditSuppressions</a> action.</p>

    Args:
        ascending_order: <p> Determines whether suppressions are listed in ascending order by expiration date or not. If parameter isn't provided, <code>ascendingOrder=true</code>. </p>
        next_token: <p> The token for the next set of results. </p>
        max_results: <p> The maximum number of results to return at one time. The default is 25. </p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.list_audit_suppressions_request.ListAuditSuppressionsRequest]",
    ) -> OperationResponse[
        "capo_iot.types.list_audit_suppressions_response.ListAuditSuppressionsResponse"
    ]:
        import capo_iot._operations.aws_iot_service.list_audit_suppressions

        output, http_response = (
            capo_iot._operations.aws_iot_service.list_audit_suppressions.list_audit_suppressions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAuditSuppressions")
    )
    input_: capo_iot.types.list_audit_suppressions_request.ListAuditSuppressionsRequest = {}
    if check_name is not None:
        input_["check_name"] = check_name
    if resource_identifier is not None:
        input_["resource_identifier"] = resource_identifier
    if ascending_order is not None:
        input_["ascending_order"] = ascending_order
    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