DataZone / Client / list_designations

list_designations

DataZone.Client.list_designations(**kwargs)

Lists the designations in a domain. Returns system-managed designations first, followed by user-created designations sorted alphabetically by name.

See also: AWS API Documentation

Request Syntax

response = client.list_designations(
    domainIdentifier='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain that contains the designations to list.

  • nextToken (string) – If the results exceed the value of MaxResults, the previous call returns a pagination token. Specify this token in a subsequent call to ListDesignations to retrieve the next set of results. If not specified, the operation returns the first page of results.

  • maxResults (integer) – The maximum number of designations to return in a single call to ListDesignations. If the number of designations exceeds MaxResults, the response includes a NextToken value. Use that token in a subsequent call to ListDesignations to retrieve the next set of designations. The default value is 20.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'domainId': 'string',
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'designationType': 'MANAGED'|'USER_CREATED',
            'deletionProtection': True|False,
            'createdBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The designation summaries that ListDesignations returned. Each item contains summary information about a designation in the domain.

      • (dict) –

        Summary representation of a designation returned by list operations.

        • domainId (string) –

          The identifier of the Amazon DataZone domain that contains the designation.

        • id (string) –

          The unique ID of the designation.

        • name (string) –

          The name of the designation. The name is unique within the domain.

        • description (string) –

          A human-readable description of the designation and its intended use.

        • designationType (string) –

          The classification of this designation.

        • deletionProtection (boolean) –

          Whether deletion protection is enabled for this designation.

        • createdBy (string) –

          The identifier of the Amazon DataZone user who created the designation.

        • createdAt (datetime) –

          The date and time when the designation was created.

        • updatedAt (datetime) –

          The date and time when the designation was last updated.

    • nextToken (string) –

      A pagination token that indicates that more results are available. Pass this token to a subsequent call to ListDesignations to retrieve the next page of results. If there are no more results, this value is null.

Exceptions