:doc:`DataPipeline <../../datapipeline>` / Client / set_status

**********
set_status
**********



.. py:method:: DataPipeline.Client.set_status(**kwargs)

  

  Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on ``FINISHED`` pipelines and attempting to do so returns ``InvalidRequestException``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datapipeline-2012-10-29/SetStatus>`_  


  **Request Syntax**
  ::

    response = client.set_status(
        pipelineId='string',
        objectIds=[
            'string',
        ],
        status='string'
    )
    
  :type pipelineId: string
  :param pipelineId: **[REQUIRED]** 

    The ID of the pipeline that contains the objects.

    

  
  :type objectIds: list
  :param objectIds: **[REQUIRED]** 

    The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

    

  
    - *(string) --* 

    

  :type status: string
  :param status: **[REQUIRED]** 

    The status to be set on all the objects specified in ``objectIds``. For components, use ``PAUSE`` or ``RESUME``. For instances, use ``TRY_CANCEL``, ``RERUN``, or ``MARK_FINISHED``.

    

  
  
  :returns: None
  **Exceptions**
  
  *   :py:class:`DataPipeline.Client.exceptions.PipelineNotFoundException`

  
  *   :py:class:`DataPipeline.Client.exceptions.PipelineDeletedException`

  
  *   :py:class:`DataPipeline.Client.exceptions.InternalServiceError`

  
  *   :py:class:`DataPipeline.Client.exceptions.InvalidRequestException`

  