DataZone / Paginator / ListProjects

ListProjects#

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

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    groupIdentifier='string',
    name='string',
    userIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain.

  • groupIdentifier (string) – The identifier of a group.

  • name (string) –

  • userIdentifier (string) – The identifier of the Amazon DataZone user.

  • 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

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'failureReasons': [
                {
                    'code': 'string',
                    'message': 'string'
                },
            ],
            'id': 'string',
            'name': 'string',
            'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results of the ListProjects action.

      • (dict) –

        The details of a Amazon DataZone project.

        • createdAt (datetime) –

          The timestamp of when a project was created.

        • createdBy (string) –

          The Amazon DataZone user who created the project.

        • description (string) –

          The description of a project.

        • domainId (string) –

          The identifier of a Amazon DataZone domain where the project exists.

        • failureReasons (list) –

          Reasons for failed project deletion

          • (dict) –

            Error that occurred during project deletion

            • code (string) –

              Project Deletion Error Code

            • message (string) –

              Project Deletion Error Message

        • id (string) –

          The identifier of a project.

        • name (string) –

          The name of a project.

        • projectStatus (string) –

          Status of the project

        • updatedAt (datetime) –

          The timestamp of when the project was updated.

    • NextToken (string) –

      A token to resume pagination.