DeviceFarm / Paginator / ListProjects

ListProjects#

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

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    arn='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • arn (string) – Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.

  • 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.

    • 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': [
        {
            'arn': 'string',
            'name': 'string',
            'defaultJobTimeoutMinutes': 123,
            'created': datetime(2015, 1, 1),
            'vpcConfig': {
                'securityGroupIds': [
                    'string',
                ],
                'subnetIds': [
                    'string',
                ],
                'vpcId': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Represents the result of a list projects request.

    • projects (list) –

      Information about the projects.

      • (dict) –

        Represents an operating-system neutral workspace for running and managing tests.

        • arn (string) –

          The project’s ARN.

        • name (string) –

          The project’s name.

        • defaultJobTimeoutMinutes (integer) –

          The default number of minutes (at the project level) a test run executes before it times out. The default value is 150 minutes.

        • created (datetime) –

          When the project was created.

        • vpcConfig (dict) –

          The VPC security groups and subnets that are attached to a project.

          • securityGroupIds (list) –

            An array of one or more security groups IDs in your Amazon VPC.

            • (string) –

          • subnetIds (list) –

            An array of one or more subnet IDs in your Amazon VPC.

            • (string) –

          • vpcId (string) –

            The ID of the Amazon VPC.

    • NextToken (string) –

      A token to resume pagination.