GlueDataBrew / Paginator / ListProjects

ListProjects#

class GlueDataBrew.Paginator.ListProjects#
paginator = client.get_paginator('list_projects')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from GlueDataBrew.Client.list_projects().

See also: AWS API Documentation

Request Syntax

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

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

{
    'Projects': [
        {
            'AccountId': 'string',
            'CreateDate': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'DatasetName': 'string',
            'LastModifiedDate': datetime(2015, 1, 1),
            'LastModifiedBy': 'string',
            'Name': 'string',
            'RecipeName': 'string',
            'ResourceArn': 'string',
            'Sample': {
                'Size': 123,
                'Type': 'FIRST_N'|'LAST_N'|'RANDOM'
            },
            'Tags': {
                'string': 'string'
            },
            'RoleArn': 'string',
            'OpenedBy': 'string',
            'OpenDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • Projects (list) –

      A list of projects that are defined .

      • (dict) –

        Represents all of the attributes of a DataBrew project.

        • AccountId (string) –

          The ID of the Amazon Web Services account that owns the project.

        • CreateDate (datetime) –

          The date and time that the project was created.

        • CreatedBy (string) –

          The Amazon Resource Name (ARN) of the user who crated the project.

        • DatasetName (string) –

          The dataset that the project is to act upon.

        • LastModifiedDate (datetime) –

          The last modification date and time for the project.

        • LastModifiedBy (string) –

          The Amazon Resource Name (ARN) of the user who last modified the project.

        • Name (string) –

          The unique name of a project.

        • RecipeName (string) –

          The name of a recipe that will be developed during a project session.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) for the project.

        • Sample (dict) –

          The sample size and sampling type to apply to the data. If this parameter isn’t specified, then the sample consists of the first 500 rows from the dataset.

          • Size (integer) –

            The number of rows in the sample.

          • Type (string) –

            The way in which DataBrew obtains rows from a dataset.

        • Tags (dict) –

          Metadata tags that have been applied to the project.

          • (string) –

            • (string) –

        • RoleArn (string) –

          The Amazon Resource Name (ARN) of the role that will be assumed for this project.

        • OpenedBy (string) –

          The Amazon Resource Name (ARN) of the user that opened the project for use.

        • OpenDate (datetime) –

          The date and time when the project was opened.