MainframeModernization / Paginator / ListDataSets

ListDataSets

class MainframeModernization.Paginator.ListDataSets

paginator = client.get_paginator('list_data_sets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MainframeModernization.Client.list_data_sets().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• applicationId (string) –

  [REQUIRED]

  The unique identifier of the application for which you want to list the associated data sets.

• nameFilter (string) – Filter dataset name matching the specified pattern. Can use * and % as wild cards.

• prefix (string) – The prefix of the data set name, which you can use to filter the list of data sets.

• 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

{
    'dataSets': [
        {
            'creationTime': datetime(2015, 1, 1),
            'dataSetName': 'string',
            'dataSetOrg': 'string',
            'format': 'string',
            'lastReferencedTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • dataSets (list) –

    The list of data sets, containing information including the creation time, the data set name, the data set organization, the data set format, and the last time the data set was referenced or updated.

    • (dict) –

      A subset of the possible data set attributes.

      • creationTime (datetime) –

        The timestamp when the data set was created.

      • dataSetName (string) –

        The name of the data set.

      • dataSetOrg (string) –

        The type of data set. The only supported value is VSAM.

      • format (string) –

        The format of the data set.

      • lastReferencedTime (datetime) –

        The last time the data set was referenced.

      • lastUpdatedTime (datetime) –

        The last time the data set was updated.

  • NextToken (string) –

    A token to resume pagination.