Rekognition / Paginator / DescribeProjects

DescribeProjects#

class Rekognition.Paginator.DescribeProjects#

paginator = client.get_paginator('describe_projects')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Rekognition.Client.describe_projects().

Request Syntax

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

Parameters:

ProjectNames (list) –
A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don’t specify a value, the response includes descriptions for all the projects in your AWS account.
- (string) –
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

{
    'ProjectDescriptions': [
        {
            'ProjectArn': 'string',
            'CreationTimestamp': datetime(2015, 1, 1),
            'Status': 'CREATING'|'CREATED'|'DELETING',
            'Datasets': [
                {
                    'CreationTimestamp': datetime(2015, 1, 1),
                    'DatasetType': 'TRAIN'|'TEST',
                    'DatasetArn': 'string',
                    'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS',
                    'StatusMessage': 'string',
                    'StatusMessageCode': 'SUCCESS'|'SERVICE_ERROR'|'CLIENT_ERROR'
                },
            ]
        },
    ],

}

Response Structure

(dict) –
- ProjectDescriptions (list) –
  
  A list of project descriptions. The list is sorted by the date and time the projects are created.
  - (dict) –
    
    A description of an Amazon Rekognition Custom Labels project. For more information, see DescribeProjects.
    - ProjectArn (string) –
      
      The Amazon Resource Name (ARN) of the project.
    - CreationTimestamp (datetime) –
      
      The Unix timestamp for the date and time that the project was created.
    - Status (string) –
      
      The current status of the project.
    - Datasets (list) –
      
      Information about the training and test datasets in the project.
      - (dict) –
        
        Summary information for an Amazon Rekognition Custom Labels dataset. For more information, see ProjectDescription.
        
        CreationTimestamp (datetime) –
        
        The Unix timestamp for the date and time that the dataset was created.
        
        DatasetType (string) –
        
        The type of the dataset.
        
        DatasetArn (string) –
        
        The Amazon Resource Name (ARN) for the dataset.
        
        Status (string) –
        
        The status for the dataset.
        
        StatusMessage (string) –
        
        The status message for the dataset.
        
        StatusMessageCode (string) –
        
        The status message code for the dataset operation. If a service error occurs, try the API call again later. If a client error occurs, check the input parameters to the dataset API call that failed.