

***
SFN
***

.. contents:: Table of Contents
   :depth: 2


======
Client
======



.. py:class:: SFN.Client

  A low-level client representing AWS Step Functions (SFN)::

    
    import boto3
    
    client = boto3.client('stepfunctions')

  
  These are the available methods:
  
  *   :py:meth:`~SFN.Client.can_paginate`

  
  *   :py:meth:`~SFN.Client.create_activity`

  
  *   :py:meth:`~SFN.Client.create_state_machine`

  
  *   :py:meth:`~SFN.Client.delete_activity`

  
  *   :py:meth:`~SFN.Client.delete_state_machine`

  
  *   :py:meth:`~SFN.Client.describe_activity`

  
  *   :py:meth:`~SFN.Client.describe_execution`

  
  *   :py:meth:`~SFN.Client.describe_state_machine`

  
  *   :py:meth:`~SFN.Client.generate_presigned_url`

  
  *   :py:meth:`~SFN.Client.get_activity_task`

  
  *   :py:meth:`~SFN.Client.get_execution_history`

  
  *   :py:meth:`~SFN.Client.get_paginator`

  
  *   :py:meth:`~SFN.Client.get_waiter`

  
  *   :py:meth:`~SFN.Client.list_activities`

  
  *   :py:meth:`~SFN.Client.list_executions`

  
  *   :py:meth:`~SFN.Client.list_state_machines`

  
  *   :py:meth:`~SFN.Client.send_task_failure`

  
  *   :py:meth:`~SFN.Client.send_task_heartbeat`

  
  *   :py:meth:`~SFN.Client.send_task_success`

  
  *   :py:meth:`~SFN.Client.start_execution`

  
  *   :py:meth:`~SFN.Client.stop_execution`

  

  .. py:method:: can_paginate(operation_name)

        
    Check if an operation can be paginated.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :return: ``True`` if the operation can be paginated,
        ``False`` otherwise.


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

    

    Creates an activity.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateActivity>`_    


    **Request Syntax** 
    ::

      response = client.create_activity(
          name='string'
      )
    :type name: string
    :param name: **[REQUIRED]** 

      The name of the activity to create. This name must be unique for your AWS account and region.

      

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

      
      ::

        {
            'activityArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **activityArn** *(string) --* 

          The Amazon Resource Name (ARN) that identifies the created activity.

          
        

        - **creationDate** *(datetime) --* 

          The date the activity was created.

          
    

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

    

    Creates a state machine.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/CreateStateMachine>`_    


    **Request Syntax** 
    ::

      response = client.create_state_machine(
          name='string',
          definition='string',
          roleArn='string'
      )
    :type name: string
    :param name: **[REQUIRED]** 

      The name of the state machine. This name must be unique for your AWS account and region.

      

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

      The Amazon States Language definition of the state machine.

      

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

      The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

      

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

      
      ::

        {
            'stateMachineArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **stateMachineArn** *(string) --* 

          The Amazon Resource Name (ARN) that identifies the created state machine.

          
        

        - **creationDate** *(datetime) --* 

          The date the state machine was created.

          
    

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

    

    Deletes an activity.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteActivity>`_    


    **Request Syntax** 
    ::

      response = client.delete_activity(
          activityArn='string'
      )
    :type activityArn: string
    :param activityArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the activity to delete.

      

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

      
      ::

        {}
        
      **Response Structure** 

      

      - *(dict) --* 
    

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

    

    Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to "DELETING" and begins the delete process.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DeleteStateMachine>`_    


    **Request Syntax** 
    ::

      response = client.delete_state_machine(
          stateMachineArn='string'
      )
    :type stateMachineArn: string
    :param stateMachineArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the state machine to delete.

      

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

      
      ::

        {}
        
      **Response Structure** 

      

      - *(dict) --* 
    

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

    

    Describes an activity.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeActivity>`_    


    **Request Syntax** 
    ::

      response = client.describe_activity(
          activityArn='string'
      )
    :type activityArn: string
    :param activityArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the activity to describe.

      

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

      
      ::

        {
            'activityArn': 'string',
            'name': 'string',
            'creationDate': datetime(2015, 1, 1)
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **activityArn** *(string) --* 

          The Amazon Resource Name (ARN) that identifies the activity.

          
        

        - **name** *(string) --* 

          The name of the activity.

          
        

        - **creationDate** *(datetime) --* 

          The date the activity was created.

          
    

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

    

    Describes an execution.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeExecution>`_    


    **Request Syntax** 
    ::

      response = client.describe_execution(
          executionArn='string'
      )
    :type executionArn: string
    :param executionArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the execution to describe.

      

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

      
      ::

        {
            'executionArn': 'string',
            'stateMachineArn': 'string',
            'name': 'string',
            'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
            'startDate': datetime(2015, 1, 1),
            'stopDate': datetime(2015, 1, 1),
            'input': 'string',
            'output': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **executionArn** *(string) --* 

          The Amazon Resource Name (ARN) that identifies the execution.

          
        

        - **stateMachineArn** *(string) --* 

          The Amazon Resource Name (ARN) of the executed stated machine.

          
        

        - **name** *(string) --* 

          The name of the execution.

          
        

        - **status** *(string) --* 

          The current status of the execution.

          
        

        - **startDate** *(datetime) --* 

          The date the execution was started.

          
        

        - **stopDate** *(datetime) --* 

          If the execution has already ended, the date the execution stopped.

          
        

        - **input** *(string) --* 

          The JSON input data of the execution.

          
        

        - **output** *(string) --* 

          The JSON output data of the execution.

          
    

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

    

    Describes a state machine.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/DescribeStateMachine>`_    


    **Request Syntax** 
    ::

      response = client.describe_state_machine(
          stateMachineArn='string'
      )
    :type stateMachineArn: string
    :param stateMachineArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the state machine to describe.

      

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

      
      ::

        {
            'stateMachineArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'DELETING',
            'definition': 'string',
            'roleArn': 'string',
            'creationDate': datetime(2015, 1, 1)
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **stateMachineArn** *(string) --* 

          The Amazon Resource Name (ARN) that identifies the state machine.

          
        

        - **name** *(string) --* 

          The name of the state machine.

          
        

        - **status** *(string) --* 

          The current status of the state machine.

          
        

        - **definition** *(string) --* 

          The Amazon States Language definition of the state machine.

          
        

        - **roleArn** *(string) --* 

          The Amazon Resource Name (ARN) of the IAM role used for executing this state machine.

          
        

        - **creationDate** *(datetime) --* 

          The date the state machine was created.

          
    

  .. py:method:: generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

        
    Generate a presigned url given a client, its method, and arguments
    
    :type ClientMethod: string
    :param ClientMethod: The client method to presign for
    
    :type Params: dict
    :param Params: The parameters normally passed to
        ``ClientMethod``.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned url is valid
        for. By default it expires in an hour (3600 seconds)
    
    :type HttpMethod: string
    :param HttpMethod: The http method to use on the generated url. By
        default, the http method is whatever is used in the method's model.
    
    :returns: The presigned url


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

    

    Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result, that is, the ``taskToken`` returned is an empty string.

     

    .. warning::

       

      Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

       

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetActivityTask>`_    


    **Request Syntax** 
    ::

      response = client.get_activity_task(
          activityArn='string',
          workerName='string'
      )
    :type activityArn: string
    :param activityArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the activity to retrieve tasks from.

      

    
    :type workerName: string
    :param workerName: 

      An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history.

      

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

      
      ::

        {
            'taskToken': 'string',
            'input': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **taskToken** *(string) --* 

          A token that identifies the scheduled task. This token must be copied and included in subsequent calls to  SendTaskHeartbeat ,  SendTaskSuccess or  SendTaskFailure in order to report the progress or completion of the task.

          
        

        - **input** *(string) --* 

          The JSON input data for the task.

          
    

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

    

    Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the ``timeStamp`` of the events. Use the ``reverseOrder`` parameter to get the latest events first. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the ``nextToken`` returned by the previous call.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory>`_    


    **Request Syntax** 
    ::

      response = client.get_execution_history(
          executionArn='string',
          maxResults=123,
          reverseOrder=True|False,
          nextToken='string'
      )
    :type executionArn: string
    :param executionArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the execution.

      

    
    :type maxResults: integer
    :param maxResults: 

      The maximum number of results that will be returned per call. ``nextToken`` can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

       

      This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

      

    
    :type reverseOrder: boolean
    :param reverseOrder: 

      Lists events in descending order of their ``timeStamp`` .

      

    
    :type nextToken: string
    :param nextToken: 

      If a ``nextToken`` was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

       

      The configured ``maxResults`` determines how many results can be returned in a single call.

      

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

      
      ::

        {
            'events': [
                {
                    'timestamp': datetime(2015, 1, 1),
                    'type': 'ActivityFailed'|'ActivityScheduleFailed'|'ActivityScheduled'|'ActivityStarted'|'ActivitySucceeded'|'ActivityTimedOut'|'ChoiceStateEntered'|'ChoiceStateExited'|'ExecutionFailed'|'ExecutionStarted'|'ExecutionSucceeded'|'ExecutionAborted'|'ExecutionTimedOut'|'FailStateEntered'|'LambdaFunctionFailed'|'LambdaFunctionScheduleFailed'|'LambdaFunctionScheduled'|'LambdaFunctionStartFailed'|'LambdaFunctionStarted'|'LambdaFunctionSucceeded'|'LambdaFunctionTimedOut'|'SucceedStateEntered'|'SucceedStateExited'|'TaskStateEntered'|'TaskStateExited'|'PassStateEntered'|'PassStateExited'|'ParallelStateEntered'|'ParallelStateExited'|'WaitStateEntered'|'WaitStateExited',
                    'id': 123,
                    'previousEventId': 123,
                    'activityFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'activityScheduleFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'activityScheduledEventDetails': {
                        'resource': 'string',
                        'input': 'string',
                        'timeoutInSeconds': 123,
                        'heartbeatInSeconds': 123
                    },
                    'activityStartedEventDetails': {
                        'workerName': 'string'
                    },
                    'activitySucceededEventDetails': {
                        'output': 'string'
                    },
                    'activityTimedOutEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'executionFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'executionStartedEventDetails': {
                        'input': 'string',
                        'roleArn': 'string'
                    },
                    'executionSucceededEventDetails': {
                        'output': 'string'
                    },
                    'executionAbortedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'executionTimedOutEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionScheduleFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionScheduledEventDetails': {
                        'resource': 'string',
                        'input': 'string',
                        'timeoutInSeconds': 123
                    },
                    'lambdaFunctionStartFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionSucceededEventDetails': {
                        'output': 'string'
                    },
                    'lambdaFunctionTimedOutEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'stateEnteredEventDetails': {
                        'name': 'string',
                        'input': 'string'
                    },
                    'stateExitedEventDetails': {
                        'name': 'string',
                        'output': 'string'
                    }
                },
            ],
            'nextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **events** *(list) --* 

          The list of events that occurred in the execution.

          
          

          - *(dict) --* 
            

            - **timestamp** *(datetime) --* 

              The date the event occured.

              
            

            - **type** *(string) --* 

              The type of the event.

              
            

            - **id** *(integer) --* 

              The id of the event. Events are numbered sequentially, starting at one.

              
            

            - **previousEventId** *(integer) --* 

              The id of the previous event.

              
            

            - **activityFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **activityScheduleFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **activityScheduledEventDetails** *(dict) --* 
              

              - **resource** *(string) --* 

                The Amazon Resource Name (ARN) of the scheduled activity.

                
              

              - **input** *(string) --* 

                The JSON data input to the activity task.

                
              

              - **timeoutInSeconds** *(integer) --* 

                The maximum allowed duration of the activity task.

                
              

              - **heartbeatInSeconds** *(integer) --* 

                The maximum allowed duration between two heartbeats for the activity task.

                
          
            

            - **activityStartedEventDetails** *(dict) --* 
              

              - **workerName** *(string) --* 

                The name of the worker that the task was assigned to. These names are provided by the workers when calling  GetActivityTask .

                
          
            

            - **activitySucceededEventDetails** *(dict) --* 
              

              - **output** *(string) --* 

                The JSON data output by the activity task.

                
          
            

            - **activityTimedOutEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the timeout.

                
          
            

            - **executionFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **executionStartedEventDetails** *(dict) --* 
              

              - **input** *(string) --* 

                The JSON data input to the execution.

                
              

              - **roleArn** *(string) --* 

                The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.

                
          
            

            - **executionSucceededEventDetails** *(dict) --* 
              

              - **output** *(string) --* 

                The JSON data output by the execution.

                
          
            

            - **executionAbortedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **executionTimedOutEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the timeout.

                
          
            

            - **lambdaFunctionFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **lambdaFunctionScheduleFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **lambdaFunctionScheduledEventDetails** *(dict) --* 
              

              - **resource** *(string) --* 

                The Amazon Resource Name (ARN) of the scheduled lambda function.

                
              

              - **input** *(string) --* 

                The JSON data input to the lambda function.

                
              

              - **timeoutInSeconds** *(integer) --* 

                The maximum allowed duration of the lambda function.

                
          
            

            - **lambdaFunctionStartFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **lambdaFunctionSucceededEventDetails** *(dict) --* 
              

              - **output** *(string) --* 

                The JSON data output by the lambda function.

                
          
            

            - **lambdaFunctionTimedOutEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the timeout.

                
          
            

            - **stateEnteredEventDetails** *(dict) --* 
              

              - **name** *(string) --* 

                The name of the state.

                
              

              - **input** *(string) --* 

                The JSON input data to the state.

                
          
            

            - **stateExitedEventDetails** *(dict) --* 
              

              - **name** *(string) --* 

                The name of the state.

                
              

              - **output** *(string) --* 

                The JSON output data of the state.

                
          
        
      
        

        - **nextToken** *(string) --* 

          If a ``nextToken`` is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

           

          The configured ``maxResults`` determines how many results can be returned in a single call.

          
    

  .. py:method:: get_paginator(operation_name)

        
    Create a paginator for an operation.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :raise OperationNotPageableError: Raised if the operation is not
        pageable.  You can use the ``client.can_paginate`` method to
        check if an operation is pageable.
    
    :rtype: L{botocore.paginate.Paginator}
    :return: A paginator object.


  .. py:method:: get_waiter(waiter_name)

        


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

    

    Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the ``nextToken`` returned by the previous call.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivities>`_    


    **Request Syntax** 
    ::

      response = client.list_activities(
          maxResults=123,
          nextToken='string'
      )
    :type maxResults: integer
    :param maxResults: 

      The maximum number of results that will be returned per call. ``nextToken`` can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

       

      This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

      

    
    :type nextToken: string
    :param nextToken: 

      If a ``nextToken`` was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

       

      The configured ``maxResults`` determines how many results can be returned in a single call.

      

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

      
      ::

        {
            'activities': [
                {
                    'activityArn': 'string',
                    'name': 'string',
                    'creationDate': datetime(2015, 1, 1)
                },
            ],
            'nextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **activities** *(list) --* 

          The list of activities.

          
          

          - *(dict) --* 
            

            - **activityArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the activity.

              
            

            - **name** *(string) --* 

              The name of the activity.

              
            

            - **creationDate** *(datetime) --* 

              The date the activity was created.

              
        
      
        

        - **nextToken** *(string) --* 

          If a ``nextToken`` is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

           

          The configured ``maxResults`` determines how many results can be returned in a single call.

          
    

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

    

    Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the ``nextToken`` returned by the previous call.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions>`_    


    **Request Syntax** 
    ::

      response = client.list_executions(
          stateMachineArn='string',
          statusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
          maxResults=123,
          nextToken='string'
      )
    :type stateMachineArn: string
    :param stateMachineArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the state machine whose executions will be listed.

      

    
    :type statusFilter: string
    :param statusFilter: 

      If specified, only list the executions whose current execution status matches the given filter.

      

    
    :type maxResults: integer
    :param maxResults: 

      The maximum number of results that will be returned per call. ``nextToken`` can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

       

      This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

      

    
    :type nextToken: string
    :param nextToken: 

      If a ``nextToken`` was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

       

      The configured ``maxResults`` determines how many results can be returned in a single call.

      

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

      
      ::

        {
            'executions': [
                {
                    'executionArn': 'string',
                    'stateMachineArn': 'string',
                    'name': 'string',
                    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
                    'startDate': datetime(2015, 1, 1),
                    'stopDate': datetime(2015, 1, 1)
                },
            ],
            'nextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **executions** *(list) --* 

          The list of matching executions.

          
          

          - *(dict) --* 
            

            - **executionArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the execution.

              
            

            - **stateMachineArn** *(string) --* 

              The Amazon Resource Name (ARN) of the executed state machine.

              
            

            - **name** *(string) --* 

              The name of the execution.

              
            

            - **status** *(string) --* 

              The current status of the execution.

              
            

            - **startDate** *(datetime) --* 

              The date the execution started.

              
            

            - **stopDate** *(datetime) --* 

              If the execution already ended, the date the execution stopped.

              
        
      
        

        - **nextToken** *(string) --* 

          If a ``nextToken`` is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

           

          The configured ``maxResults`` determines how many results can be returned in a single call.

          
    

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

    

    Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the ``nextToken`` returned by the previous call.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachines>`_    


    **Request Syntax** 
    ::

      response = client.list_state_machines(
          maxResults=123,
          nextToken='string'
      )
    :type maxResults: integer
    :param maxResults: 

      The maximum number of results that will be returned per call. ``nextToken`` can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

       

      This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

      

    
    :type nextToken: string
    :param nextToken: 

      If a ``nextToken`` was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

       

      The configured ``maxResults`` determines how many results can be returned in a single call.

      

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

      
      ::

        {
            'stateMachines': [
                {
                    'stateMachineArn': 'string',
                    'name': 'string',
                    'creationDate': datetime(2015, 1, 1)
                },
            ],
            'nextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **stateMachines** *(list) --* 
          

          - *(dict) --* 
            

            - **stateMachineArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the state machine.

              
            

            - **name** *(string) --* 

              The name of the state machine.

              
            

            - **creationDate** *(datetime) --* 

              The date the state machine was created.

              
        
      
        

        - **nextToken** *(string) --* 

          If a ``nextToken`` is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in ``nextToken`` . Keep all other arguments unchanged.

           

          The configured ``maxResults`` determines how many results can be returned in a single call.

          
    

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

    

    Used by workers to report that the task identified by the ``taskToken`` failed.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskFailure>`_    


    **Request Syntax** 
    ::

      response = client.send_task_failure(
          taskToken='string',
          error='string',
          cause='string'
      )
    :type taskToken: string
    :param taskToken: **[REQUIRED]** 

      The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

      

    
    :type error: string
    :param error: 

      An arbitrary error code that identifies the cause of the failure.

      

    
    :type cause: string
    :param cause: 

      A more detailed explanation of the cause of the failure.

      

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

      
      ::

        {}
        
      **Response Structure** 

      

      - *(dict) --* 
    

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

    

    Used by workers to report to the service that the task represented by the specified ``taskToken`` is still making progress. This action resets the ``Heartbeat`` clock. The ``Heartbeat`` threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history will contain an ``ActivityTimedOut`` event.

     

    .. note::

       

      The ``Timeout`` of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of  SendTaskHeartbeat requests received.

       

     

    .. note::

       

      This operation is only useful for long-lived tasks to report the liveliness of the task.

       

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskHeartbeat>`_    


    **Request Syntax** 
    ::

      response = client.send_task_heartbeat(
          taskToken='string'
      )
    :type taskToken: string
    :param taskToken: **[REQUIRED]** 

      The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

      

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

      
      ::

        {}
        
      **Response Structure** 

      

      - *(dict) --* 
    

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

    

    Used by workers to report that the task identified by the ``taskToken`` completed successfully.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/SendTaskSuccess>`_    


    **Request Syntax** 
    ::

      response = client.send_task_success(
          taskToken='string',
          output='string'
      )
    :type taskToken: string
    :param taskToken: **[REQUIRED]** 

      The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

      

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

      The JSON output of the task.

      

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

      
      ::

        {}
        
      **Response Structure** 

      

      - *(dict) --* 
    

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

    

    Starts a state machine execution.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StartExecution>`_    


    **Request Syntax** 
    ::

      response = client.start_execution(
          stateMachineArn='string',
          name='string',
          input='string'
      )
    :type stateMachineArn: string
    :param stateMachineArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the state machine to execute.

      

    
    :type name: string
    :param name: 

      The name of the execution. This name must be unique for your AWS account and region.

      

    
    :type input: string
    :param input: 

      The JSON input data for the execution.

      

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

      
      ::

        {
            'executionArn': 'string',
            'startDate': datetime(2015, 1, 1)
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **executionArn** *(string) --* 

          The Amazon Resource Name (ARN) that identifies the execution.

          
        

        - **startDate** *(datetime) --* 

          The date the execution was started.

          
    

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

    

    Stops an execution.

    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/StopExecution>`_    


    **Request Syntax** 
    ::

      response = client.stop_execution(
          executionArn='string',
          error='string',
          cause='string'
      )
    :type executionArn: string
    :param executionArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the execution to stop.

      

    
    :type error: string
    :param error: 

      An arbitrary error code that identifies the cause of the termination.

      

    
    :type cause: string
    :param cause: 

      A more detailed explanation of the cause of the termination.

      

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

      
      ::

        {
            'stopDate': datetime(2015, 1, 1)
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **stopDate** *(datetime) --* 

          The date the execution was stopped.

          
    

==========
Paginators
==========


The available paginators are:

* :py:class:`SFN.Paginator.GetExecutionHistory`


* :py:class:`SFN.Paginator.ListActivities`


* :py:class:`SFN.Paginator.ListExecutions`


* :py:class:`SFN.Paginator.ListStateMachines`



.. py:class:: SFN.Paginator.GetExecutionHistory

  ::

    
    paginator = client.get_paginator('get_execution_history')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SFN.Client.get_execution_history`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/GetExecutionHistory>`_    


    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          executionArn='string',
          reverseOrder=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type executionArn: string
    :param executionArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the execution.

      

    
    :type reverseOrder: boolean
    :param reverseOrder: 

      Lists events in descending order of their ``timeStamp`` .

      

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

      
      ::

        {
            'events': [
                {
                    'timestamp': datetime(2015, 1, 1),
                    'type': 'ActivityFailed'|'ActivityScheduleFailed'|'ActivityScheduled'|'ActivityStarted'|'ActivitySucceeded'|'ActivityTimedOut'|'ChoiceStateEntered'|'ChoiceStateExited'|'ExecutionFailed'|'ExecutionStarted'|'ExecutionSucceeded'|'ExecutionAborted'|'ExecutionTimedOut'|'FailStateEntered'|'LambdaFunctionFailed'|'LambdaFunctionScheduleFailed'|'LambdaFunctionScheduled'|'LambdaFunctionStartFailed'|'LambdaFunctionStarted'|'LambdaFunctionSucceeded'|'LambdaFunctionTimedOut'|'SucceedStateEntered'|'SucceedStateExited'|'TaskStateEntered'|'TaskStateExited'|'PassStateEntered'|'PassStateExited'|'ParallelStateEntered'|'ParallelStateExited'|'WaitStateEntered'|'WaitStateExited',
                    'id': 123,
                    'previousEventId': 123,
                    'activityFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'activityScheduleFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'activityScheduledEventDetails': {
                        'resource': 'string',
                        'input': 'string',
                        'timeoutInSeconds': 123,
                        'heartbeatInSeconds': 123
                    },
                    'activityStartedEventDetails': {
                        'workerName': 'string'
                    },
                    'activitySucceededEventDetails': {
                        'output': 'string'
                    },
                    'activityTimedOutEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'executionFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'executionStartedEventDetails': {
                        'input': 'string',
                        'roleArn': 'string'
                    },
                    'executionSucceededEventDetails': {
                        'output': 'string'
                    },
                    'executionAbortedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'executionTimedOutEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionScheduleFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionScheduledEventDetails': {
                        'resource': 'string',
                        'input': 'string',
                        'timeoutInSeconds': 123
                    },
                    'lambdaFunctionStartFailedEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'lambdaFunctionSucceededEventDetails': {
                        'output': 'string'
                    },
                    'lambdaFunctionTimedOutEventDetails': {
                        'error': 'string',
                        'cause': 'string'
                    },
                    'stateEnteredEventDetails': {
                        'name': 'string',
                        'input': 'string'
                    },
                    'stateExitedEventDetails': {
                        'name': 'string',
                        'output': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **events** *(list) --* 

          The list of events that occurred in the execution.

          
          

          - *(dict) --* 
            

            - **timestamp** *(datetime) --* 

              The date the event occured.

              
            

            - **type** *(string) --* 

              The type of the event.

              
            

            - **id** *(integer) --* 

              The id of the event. Events are numbered sequentially, starting at one.

              
            

            - **previousEventId** *(integer) --* 

              The id of the previous event.

              
            

            - **activityFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **activityScheduleFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **activityScheduledEventDetails** *(dict) --* 
              

              - **resource** *(string) --* 

                The Amazon Resource Name (ARN) of the scheduled activity.

                
              

              - **input** *(string) --* 

                The JSON data input to the activity task.

                
              

              - **timeoutInSeconds** *(integer) --* 

                The maximum allowed duration of the activity task.

                
              

              - **heartbeatInSeconds** *(integer) --* 

                The maximum allowed duration between two heartbeats for the activity task.

                
          
            

            - **activityStartedEventDetails** *(dict) --* 
              

              - **workerName** *(string) --* 

                The name of the worker that the task was assigned to. These names are provided by the workers when calling  GetActivityTask .

                
          
            

            - **activitySucceededEventDetails** *(dict) --* 
              

              - **output** *(string) --* 

                The JSON data output by the activity task.

                
          
            

            - **activityTimedOutEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the timeout.

                
          
            

            - **executionFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **executionStartedEventDetails** *(dict) --* 
              

              - **input** *(string) --* 

                The JSON data input to the execution.

                
              

              - **roleArn** *(string) --* 

                The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.

                
          
            

            - **executionSucceededEventDetails** *(dict) --* 
              

              - **output** *(string) --* 

                The JSON data output by the execution.

                
          
            

            - **executionAbortedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **executionTimedOutEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the timeout.

                
          
            

            - **lambdaFunctionFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **lambdaFunctionScheduleFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **lambdaFunctionScheduledEventDetails** *(dict) --* 
              

              - **resource** *(string) --* 

                The Amazon Resource Name (ARN) of the scheduled lambda function.

                
              

              - **input** *(string) --* 

                The JSON data input to the lambda function.

                
              

              - **timeoutInSeconds** *(integer) --* 

                The maximum allowed duration of the lambda function.

                
          
            

            - **lambdaFunctionStartFailedEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the failure.

                
          
            

            - **lambdaFunctionSucceededEventDetails** *(dict) --* 
              

              - **output** *(string) --* 

                The JSON data output by the lambda function.

                
          
            

            - **lambdaFunctionTimedOutEventDetails** *(dict) --* 
              

              - **error** *(string) --* 

                The error code of the failure.

                
              

              - **cause** *(string) --* 

                A more detailed explanation of the cause of the timeout.

                
          
            

            - **stateEnteredEventDetails** *(dict) --* 
              

              - **name** *(string) --* 

                The name of the state.

                
              

              - **input** *(string) --* 

                The JSON input data to the state.

                
          
            

            - **stateExitedEventDetails** *(dict) --* 
              

              - **name** *(string) --* 

                The name of the state.

                
              

              - **output** *(string) --* 

                The JSON output data of the state.

                
          
        
      
        

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

          A token to resume pagination.

          
    

.. py:class:: SFN.Paginator.ListActivities

  ::

    
    paginator = client.get_paginator('list_activities')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SFN.Client.list_activities`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListActivities>`_    


    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :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** 

      
      ::

        {
            'activities': [
                {
                    'activityArn': 'string',
                    'name': 'string',
                    'creationDate': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **activities** *(list) --* 

          The list of activities.

          
          

          - *(dict) --* 
            

            - **activityArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the activity.

              
            

            - **name** *(string) --* 

              The name of the activity.

              
            

            - **creationDate** *(datetime) --* 

              The date the activity was created.

              
        
      
        

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

          A token to resume pagination.

          
    

.. py:class:: SFN.Paginator.ListExecutions

  ::

    
    paginator = client.get_paginator('list_executions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SFN.Client.list_executions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListExecutions>`_    


    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          stateMachineArn='string',
          statusFilter='RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type stateMachineArn: string
    :param stateMachineArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the state machine whose executions will be listed.

      

    
    :type statusFilter: string
    :param statusFilter: 

      If specified, only list the executions whose current execution status matches the given filter.

      

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

      
      ::

        {
            'executions': [
                {
                    'executionArn': 'string',
                    'stateMachineArn': 'string',
                    'name': 'string',
                    'status': 'RUNNING'|'SUCCEEDED'|'FAILED'|'TIMED_OUT'|'ABORTED',
                    'startDate': datetime(2015, 1, 1),
                    'stopDate': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **executions** *(list) --* 

          The list of matching executions.

          
          

          - *(dict) --* 
            

            - **executionArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the execution.

              
            

            - **stateMachineArn** *(string) --* 

              The Amazon Resource Name (ARN) of the executed state machine.

              
            

            - **name** *(string) --* 

              The name of the execution.

              
            

            - **status** *(string) --* 

              The current status of the execution.

              
            

            - **startDate** *(datetime) --* 

              The date the execution started.

              
            

            - **stopDate** *(datetime) --* 

              If the execution already ended, the date the execution stopped.

              
        
      
        

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

          A token to resume pagination.

          
    

.. py:class:: SFN.Paginator.ListStateMachines

  ::

    
    paginator = client.get_paginator('list_state_machines')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SFN.Client.list_state_machines`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/states-2016-11-23/ListStateMachines>`_    


    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :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** 

      
      ::

        {
            'stateMachines': [
                {
                    'stateMachineArn': 'string',
                    'name': 'string',
                    'creationDate': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 
        

        - **stateMachines** *(list) --* 
          

          - *(dict) --* 
            

            - **stateMachineArn** *(string) --* 

              The Amazon Resource Name (ARN) that identifies the state machine.

              
            

            - **name** *(string) --* 

              The name of the state machine.

              
            

            - **creationDate** *(datetime) --* 

              The date the state machine was created.

              
        
      
        

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

          A token to resume pagination.

          
    