CodeBuild / Client / list_shared_projects

list_shared_projects#

CodeBuild.Client.list_shared_projects(**kwargs)#

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

See also: AWS API Documentation

Request Syntax

response = client.list_shared_projects(
    sortBy='ARN'|'MODIFIED_TIME',
    sortOrder='ASCENDING'|'DESCENDING',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • sortBy (string) –

    The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:

    • ARN: List based on the ARN.

    • MODIFIED_TIME: List based on when information about the shared project was last changed.

  • sortOrder (string) –

    The order in which to list shared build projects. Valid values include:

    • ASCENDING: List in ascending order.

    • DESCENDING: List in descending order.

  • maxResults (integer) – The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.

  • nextToken (string) – During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'projects': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • projects (list) –

      The list of ARNs for the build projects shared with the current Amazon Web Services account or user.

      • (string) –

Exceptions

  • CodeBuild.Client.exceptions.InvalidInputException