DataZone / Client / list_project_profiles

list_project_profiles#

DataZone.Client.list_project_profiles(**kwargs)#

Lists project profiles.

See also: AWS API Documentation

Request Syntax

response = client.list_project_profiles(
    domainIdentifier='string',
    maxResults=123,
    name='string',
    nextToken='string',
    sortBy='NAME',
    sortOrder='ASCENDING'|'DESCENDING'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The ID of the domain where you want to list project profiles.

  • maxResults (integer) – The maximum number of project profiles to return in a single call to ListProjectProfiles. When the number of project profiles 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 ListProjectProfiles to list the next set of project profiles.

  • name (string) – The name of a project profile.

  • nextToken (string) – When the number of project profiles 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 project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.

  • sortBy (string) – Specifies by what to sort project profiles.

  • sortOrder (string) – Specifies the sort order of the project profiles.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'domainUnitId': 'string',
            'id': 'string',
            'lastUpdatedAt': datetime(2015, 1, 1),
            'name': 'string',
            'status': 'ENABLED'|'DISABLED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The results of the ListProjectProfiles action.

      • (dict) –

        The summary of a project profile.

        • createdAt (datetime) –

          The timestamp of when the project profile was created.

        • createdBy (string) –

          The user who created the project profile.

        • description (string) –

          The description of the project profile.

        • domainId (string) –

          The domain ID of the project profile.

        • domainUnitId (string) –

          The domain unit ID of the project profile.

        • id (string) –

          The ID of the project profile.

        • lastUpdatedAt (datetime) –

          The timestamp at which a project profile was last updated.

        • name (string) –

          The name of a project profile.

        • status (string) –

          The status of a project profile.

    • nextToken (string) –

      When the number of project profiles 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 project profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectProfiles to list the next set of project profiles.

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException