:doc:`ServiceCatalog <../../servicecatalog>` / Paginator / ScanProvisionedProducts

***********************
ScanProvisionedProducts
***********************



.. py:class:: ServiceCatalog.Paginator.ScanProvisionedProducts

  ::

    
    paginator = client.get_paginator('scan_provisioned_products')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ServiceCatalog.Client.scan_provisioned_products`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/servicecatalog-2015-12-10/ScanProvisionedProducts>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AcceptLanguage='string',
          AccessLevelFilter={
              'Key': 'Account'|'Role'|'User',
              'Value': 'string'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AcceptLanguage: string
    :param AcceptLanguage: 

      The language code.

       

      
      * ``jp`` - Japanese
       
      * ``zh`` - Chinese
      

      

    
    :type AccessLevelFilter: dict
    :param AccessLevelFilter: 

      The access level to use to obtain results. The default is ``User``.

      

    
      - **Key** *(string) --* 

        The access level.

         

        
        * ``Account`` - Filter results based on the account.
         
        * ``Role`` - Filter results based on the federated role of the specified user.
         
        * ``User`` - Filter results based on the specified user.
        

        

      
      - **Value** *(string) --* 

        The user to which the access level applies. The only supported value is ``self``.

        

      
    
    :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**

      
      ::

        {
            'ProvisionedProducts': [
                {
                    'Name': 'string',
                    'Arn': 'string',
                    'Type': 'string',
                    'Id': 'string',
                    'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
                    'StatusMessage': 'string',
                    'CreatedTime': datetime(2015, 1, 1),
                    'IdempotencyToken': 'string',
                    'LastRecordId': 'string',
                    'LastProvisioningRecordId': 'string',
                    'LastSuccessfulProvisioningRecordId': 'string',
                    'ProductId': 'string',
                    'ProvisioningArtifactId': 'string',
                    'LaunchRoleArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ProvisionedProducts** *(list) --* 

          Information about the provisioned products.

          
          

          - *(dict) --* 

            Information about a provisioned product.

            
            

            - **Name** *(string) --* 

              The user-friendly name of the provisioned product.

              
            

            - **Arn** *(string) --* 

              The ARN of the provisioned product.

              
            

            - **Type** *(string) --* 

              The type of provisioned product. The supported values are ``CFN_STACK``, ``CFN_STACKSET``, ``TERRAFORM_OPEN_SOURCE``, ``TERRAFORM_CLOUD``, and ``EXTERNAL``.

              
            

            - **Id** *(string) --* 

              The identifier of the provisioned product.

              
            

            - **Status** *(string) --* 

              The current status of the provisioned product.

               

              
              * ``AVAILABLE`` - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
               
              * ``UNDER_CHANGE`` - Transitive state. Operations performed might not have valid results. Wait for an ``AVAILABLE`` status before performing operations.
               
              * ``TAINTED`` - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
               
              * ``ERROR`` - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
               
              * ``PLAN_IN_PROGRESS`` - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an ``AVAILABLE`` status before performing operations.
              

              
            

            - **StatusMessage** *(string) --* 

              The current status message of the provisioned product.

              
            

            - **CreatedTime** *(datetime) --* 

              The UTC time stamp of the creation time.

              
            

            - **IdempotencyToken** *(string) --* 

              A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

              
            

            - **LastRecordId** *(string) --* 

              The record identifier of the last request performed on this provisioned product.

              
            

            - **LastProvisioningRecordId** *(string) --* 

              The record identifier of the last request performed on this provisioned product of the following types:

               

              
              * ProvisionProduct
               
              * UpdateProvisionedProduct
               
              * ExecuteProvisionedProductPlan
               
              * TerminateProvisionedProduct
              

              
            

            - **LastSuccessfulProvisioningRecordId** *(string) --* 

              The record identifier of the last successful request performed on this provisioned product of the following types:

               

              
              * ProvisionProduct
               
              * UpdateProvisionedProduct
               
              * ExecuteProvisionedProductPlan
               
              * TerminateProvisionedProduct
              

              
            

            - **ProductId** *(string) --* 

              The product identifier. For example, ``prod-abcdzk7xy33qa``.

              
            

            - **ProvisioningArtifactId** *(string) --* 

              The identifier of the provisioning artifact. For example, ``pa-4abcdjnxjj6ne``.

              
            

            - **LaunchRoleArn** *(string) --* 

              The ARN of the launch role associated with the provisioned product.

              
        
      
        

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

          A token to resume pagination.

          
    