CodeCatalyst / Client / list_projects

list_projects#

CodeCatalyst.Client.list_projects(**kwargs)#

Retrieves a list of projects.

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    spaceName='string',
    nextToken='string',
    maxResults=123,
    filters=[
        {
            'key': 'hasAccessTo',
            'values': [
                'string',
            ],
            'comparisonOperator': 'EQ'|'GT'|'GE'|'LT'|'LE'
        },
    ]
)
Parameters:

  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • nextToken (string) – A token returned from a call to this API to indicate the next batch of results to return, if any.

  • maxResults (integer) – The maximum number of results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a NextToken element, which you can use to obtain additional results.

  • filters (list) –

    Information about filters to apply to narrow the results returned in the list.

    • (dict) –

      nformation about the filter used to narrow the results returned in a list of projects.

      • key (string) – [REQUIRED]

        A key that can be used to sort results.

      • values (list) – [REQUIRED]

        The value of the key.

        • (string) –

      • comparisonOperator (string) –

        The operator used to compare the fields.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'name': 'string',
            'displayName': 'string',
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A token returned from a call to this API to indicate the next batch of results to return, if any.

    • items (list) –

      Information about the projects.

      • (dict) –

        Information about a project.

        • name (string) –

          The name of the project in the space.

        • displayName (string) –

          The friendly name displayed to users of the project in Amazon CodeCatalyst.

        • description (string) –

          The description of the project.

Exceptions

  • CodeCatalyst.Client.exceptions.ThrottlingException

  • CodeCatalyst.Client.exceptions.ConflictException

  • CodeCatalyst.Client.exceptions.ValidationException

  • CodeCatalyst.Client.exceptions.ServiceQuotaExceededException

  • CodeCatalyst.Client.exceptions.ResourceNotFoundException

  • CodeCatalyst.Client.exceptions.AccessDeniedException