:doc:`CloudControlApi <../../cloudcontrol>` / Client / list_resource_requests

**********************
list_resource_requests
**********************



.. py:method:: CloudControlApi.Client.list_resource_requests(**kwargs)

  

  Returns existing resource operation requests. This includes requests of all status types. For more information, see `Listing active resource operation requests <https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list>`__ in the *Amazon Web Services Cloud Control API User Guide*.

   

  .. note::

    

    Resource operation requests expire after 7 days.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/ListResourceRequests>`_  


  **Request Syntax**
  ::

    response = client.list_resource_requests(
        MaxResults=123,
        NextToken='string',
        ResourceRequestStatusFilter={
            'Operations': [
                'CREATE'|'DELETE'|'UPDATE',
            ],
            'OperationStatuses': [
                'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
            ]
        }
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a ``NextToken`` value that you can assign to the ``NextToken`` request parameter to get the next set of results.

     

    The default is ``20``.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous paginated request didn't return all of the remaining results, the response object's ``NextToken`` parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's ``NextToken`` parameter. If there are no remaining results, the previous response object's ``NextToken`` parameter is set to ``null``.

    

  
  :type ResourceRequestStatusFilter: dict
  :param ResourceRequestStatusFilter: 

    The filter criteria to apply to the requests returned.

    

  
    - **Operations** *(list) --* 

      The operation types to include in the filter.

      

    
      - *(string) --* 

      
  
    - **OperationStatuses** *(list) --* 

      The operation statuses to include in the filter.

       

      
      * ``PENDING``: The operation has been requested, but not yet initiated.
       
      * ``IN_PROGRESS``: The operation is in progress.
       
      * ``SUCCESS``: The operation completed.
       
      * ``FAILED``: The operation failed.
       
      * ``CANCEL_IN_PROGRESS``: The operation is in the process of being canceled.
       
      * ``CANCEL_COMPLETE``: The operation has been canceled.
      

      

    
      - *(string) --* 

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

    
    ::

      {
          'ResourceRequestStatusSummaries': [
              {
                  'TypeName': 'string',
                  'Identifier': 'string',
                  'RequestToken': 'string',
                  'HooksRequestToken': 'string',
                  'Operation': 'CREATE'|'DELETE'|'UPDATE',
                  'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
                  'EventTime': datetime(2015, 1, 1),
                  'ResourceModel': 'string',
                  'StatusMessage': 'string',
                  'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'UnauthorizedTaggingOperation'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
                  'RetryAfter': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ResourceRequestStatusSummaries** *(list) --* 

        The requests that match the specified filter criteria.

        
        

        - *(dict) --* 

          Represents the current status of a resource operation request. For more information, see `Managing resource operation requests <https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html>`__ in the *Amazon Web Services Cloud Control API User Guide*.

          
          

          - **TypeName** *(string) --* 

            The name of the resource type used in the operation.

            
          

          - **Identifier** *(string) --* 

            The primary identifier for the resource.

             

            .. note::

              

              In some cases, the resource identifier may be available before the resource operation has reached a status of ``SUCCESS``.

              

            
          

          - **RequestToken** *(string) --* 

            The unique token representing this resource operation request.

             

            Use the ``RequestToken`` with `GetResourceRequestStatus <https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html>`__ to return the current status of a resource operation request.

            
          

          - **HooksRequestToken** *(string) --* 

            The unique token representing the Hooks operation for the request.

            
          

          - **Operation** *(string) --* 

            The resource operation type.

            
          

          - **OperationStatus** *(string) --* 

            The current status of the resource operation request.

             

            
            * ``PENDING``: The resource operation hasn't yet started.
             
            * ``IN_PROGRESS``: The resource operation is currently in progress.
             
            * ``SUCCESS``: The resource operation has successfully completed.
             
            * ``FAILED``: The resource operation has failed. Refer to the error code and status message for more information.
             
            * ``CANCEL_IN_PROGRESS``: The resource operation is in the process of being canceled.
             
            * ``CANCEL_COMPLETE``: The resource operation has been canceled.
            

            
          

          - **EventTime** *(datetime) --* 

            When the resource operation request was initiated.

            
          

          - **ResourceModel** *(string) --* 

            A JSON string containing the resource model, consisting of each resource property and its current value.

            
          

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

            Any message explaining the current status.

            
          

          - **ErrorCode** *(string) --* 

            For requests with a status of ``FAILED``, the associated error code.

             

            For error code definitions, see `Handler error codes <https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html>`__ in the *CloudFormation Command Line Interface User Guide for Extension Development*.

            
          

          - **RetryAfter** *(datetime) --* 

            When to next request the status of this resource operation request.

            
      
    
      

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

        If the request doesn't return all of the remaining results, ``NextToken`` is set to a token. To retrieve the next set of results, call ``ListResources`` again and assign that token to the request object's ``NextToken`` parameter. If the request returns all results, ``NextToken`` is set to null.

        
  