DataZone / Client / list_projects

list_projects

DataZone.Client.list_projects(**kwargs)

Lists Amazon DataZone projects.

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    domainIdentifier='string',
    groupIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    userIdentifier='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain.

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

  • maxResults (integer) – The maximum number of projects to return in a single call to ListProjects. When the number of projects to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjects to list the next set of projects.

  • name (string) – The name of the project.

  • nextToken (string) – When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

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

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'domainUnitId': 'string',
            'failureReasons': [
                {
                    'code': 'string',
                    'message': 'string'
                },
            ],
            'id': 'string',
            'name': 'string',
            'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
            '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.

        • domainUnitId (string) –

          The ID of the domain unit.

        • failureReasons (list) –

          Specifies the error message that is returned if the operation cannot be successfully completed.

          • (dict) –

            Specifies the error message that is returned if the operation cannot be successfully completed.

            • code (string) –

              The code of the project deletion error.

            • message (string) –

              The message of the project deletion error.

        • id (string) –

          The identifier of a project.

        • name (string) –

          The name of a project.

        • projectStatus (string) –

          The status of the project.

        • updatedAt (datetime) –

          The timestamp of when the project was updated.

    • nextToken (string) –

      When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

Exceptions