ResilienceHubV2 / Paginator / ListUserJourneys

ListUserJourneys¶

class ResilienceHubV2.Paginator.ListUserJourneys¶

paginator = client.get_paginator('list_user_journeys')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResilienceHubV2.Client.list_user_journeys().

Request Syntax

response_iterator = paginator.paginate(
    systemArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

systemArn (string) –
[REQUIRED]

ARN identifier.
PaginationConfig (dict) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'userJourneySummaries': [
        {
            'userJourneyId': 'string',
            'name': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- userJourneySummaries (list) –
  
  The list of user journey summaries.
  - (dict) –
    
    Contains summary information about a user journey.
    - userJourneyId (string) –
      
      The unique identifier of the user journey.
    - name (string) –
      
      Entity label (not part of ARN — spaces allowed).
    - createdAt (datetime) –
      
      The timestamp when the user journey was created.
    - updatedAt (datetime) –
      
      The timestamp when the user journey was last updated.
- NextToken (string) –
  
  A token to resume pagination.