:doc:`IoT <../../iot>` / Paginator / ListAuditSuppressions

*********************
ListAuditSuppressions
*********************



.. py:class:: IoT.Paginator.ListAuditSuppressions

  ::

    
    paginator = client.get_paginator('list_audit_suppressions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoT.Client.list_audit_suppressions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/ListAuditSuppressions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          checkName='string',
          resourceIdentifier={
              'deviceCertificateId': 'string',
              'caCertificateId': 'string',
              'cognitoIdentityPoolId': 'string',
              'clientId': 'string',
              'policyVersionIdentifier': {
                  'policyName': 'string',
                  'policyVersionId': 'string'
              },
              'account': 'string',
              'iamRoleArn': 'string',
              'roleAliasArn': 'string',
              'issuerCertificateIdentifier': {
                  'issuerCertificateSubject': 'string',
                  'issuerId': 'string',
                  'issuerCertificateSerialNumber': 'string'
              },
              'deviceCertificateArn': 'string'
          },
          ascendingOrder=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type checkName: string
    :param checkName: 

      An audit check name. Checks must be enabled for your account. (Use ``DescribeAccountAuditConfiguration`` to see the list of all checks, including those that are enabled or use ``UpdateAccountAuditConfiguration`` to select which checks are enabled.)

      

    
    :type resourceIdentifier: dict
    :param resourceIdentifier: 

      Information that identifies the noncompliant resource.

      

    
      - **deviceCertificateId** *(string) --* 

        The ID of the certificate attached to the resource.

        

      
      - **caCertificateId** *(string) --* 

        The ID of the CA certificate used to authorize the certificate.

        

      
      - **cognitoIdentityPoolId** *(string) --* 

        The ID of the Amazon Cognito identity pool.

        

      
      - **clientId** *(string) --* 

        The client ID.

        

      
      - **policyVersionIdentifier** *(dict) --* 

        The version of the policy associated with the resource.

        

      
        - **policyName** *(string) --* 

          The name of the policy.

          

        
        - **policyVersionId** *(string) --* 

          The ID of the version of the policy associated with the resource.

          

        
      
      - **account** *(string) --* 

        The account with which the resource is associated.

        

      
      - **iamRoleArn** *(string) --* 

        The ARN of the IAM role that has overly permissive actions.

        

      
      - **roleAliasArn** *(string) --* 

        The ARN of the role alias that has overly permissive actions.

        

      
      - **issuerCertificateIdentifier** *(dict) --* 

        The issuer certificate identifier.

        

      
        - **issuerCertificateSubject** *(string) --* 

          The subject of the issuer certificate.

          

        
        - **issuerId** *(string) --* 

          The issuer ID.

          

        
        - **issuerCertificateSerialNumber** *(string) --* 

          The issuer certificate serial number.

          

        
      
      - **deviceCertificateArn** *(string) --* 

        The ARN of the identified device certificate.

        

      
    
    :type ascendingOrder: boolean
    :param ascendingOrder: 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'suppressions': [
                {
                    'checkName': 'string',
                    'resourceIdentifier': {
                        'deviceCertificateId': 'string',
                        'caCertificateId': 'string',
                        'cognitoIdentityPoolId': 'string',
                        'clientId': 'string',
                        'policyVersionIdentifier': {
                            'policyName': 'string',
                            'policyVersionId': 'string'
                        },
                        'account': 'string',
                        'iamRoleArn': 'string',
                        'roleAliasArn': 'string',
                        'issuerCertificateIdentifier': {
                            'issuerCertificateSubject': 'string',
                            'issuerId': 'string',
                            'issuerCertificateSerialNumber': 'string'
                        },
                        'deviceCertificateArn': 'string'
                    },
                    'expirationDate': datetime(2015, 1, 1),
                    'suppressIndefinitely': True|False,
                    'description': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **suppressions** *(list) --* 

          List of audit suppressions.

          
          

          - *(dict) --* 

            Filters out specific findings of a Device Defender audit.

            
            

            - **checkName** *(string) --* 

              An audit check name. Checks must be enabled for your account. (Use ``DescribeAccountAuditConfiguration`` to see the list of all checks, including those that are enabled or use ``UpdateAccountAuditConfiguration`` to select which checks are enabled.)

              
            

            - **resourceIdentifier** *(dict) --* 

              Information that identifies the noncompliant resource.

              
              

              - **deviceCertificateId** *(string) --* 

                The ID of the certificate attached to the resource.

                
              

              - **caCertificateId** *(string) --* 

                The ID of the CA certificate used to authorize the certificate.

                
              

              - **cognitoIdentityPoolId** *(string) --* 

                The ID of the Amazon Cognito identity pool.

                
              

              - **clientId** *(string) --* 

                The client ID.

                
              

              - **policyVersionIdentifier** *(dict) --* 

                The version of the policy associated with the resource.

                
                

                - **policyName** *(string) --* 

                  The name of the policy.

                  
                

                - **policyVersionId** *(string) --* 

                  The ID of the version of the policy associated with the resource.

                  
            
              

              - **account** *(string) --* 

                The account with which the resource is associated.

                
              

              - **iamRoleArn** *(string) --* 

                The ARN of the IAM role that has overly permissive actions.

                
              

              - **roleAliasArn** *(string) --* 

                The ARN of the role alias that has overly permissive actions.

                
              

              - **issuerCertificateIdentifier** *(dict) --* 

                The issuer certificate identifier.

                
                

                - **issuerCertificateSubject** *(string) --* 

                  The subject of the issuer certificate.

                  
                

                - **issuerId** *(string) --* 

                  The issuer ID.

                  
                

                - **issuerCertificateSerialNumber** *(string) --* 

                  The issuer certificate serial number.

                  
            
              

              - **deviceCertificateArn** *(string) --* 

                The ARN of the identified device certificate.

                
          
            

            - **expirationDate** *(datetime) --* 

              The expiration date (epoch timestamp in seconds) that you want the suppression to adhere to.

              
            

            - **suppressIndefinitely** *(boolean) --* 

              Indicates whether a suppression should exist indefinitely or not.

              
            

            - **description** *(string) --* 

              The description of the audit suppression.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    