DataZone / Client / create_designation

create_designation

DataZone.Client.create_designation(**kwargs)

Creates a new user-defined designation with a Cedar permit policy. The designation defines a named role that can be assigned to project members through CreateProjectMembership or granted through AddPolicyGrant.

See also: AWS API Documentation

Request Syntax

response = client.create_designation(
    domainIdentifier='string',
    name='string',
    description='string',
    policy='string',
    deletionProtection=True|False
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain in which the designation is created.

  • name (string) –

    [REQUIRED]

    The name of the designation. The name must be unique within the domain.

  • description (string) – A human-readable description of the designation and its intended use.

  • policy (string) –

    [REQUIRED]

    The Cedar permit policy that defines the actions holders of this designation are allowed to perform.

  • deletionProtection (boolean) – Specifies whether deletion protection is enabled for this designation. Defaults to true when omitted. When enabled, DeleteDesignation is rejected until protection is disabled through UpdateDesignation.

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'id': 'string',
    'name': 'string',
    'description': 'string',
    'designationType': 'MANAGED'|'USER_CREATED',
    'policy': 'string',
    'deletionProtection': True|False,
    'createdBy': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    A designation defines a named role with a Cedar permit policy that controls what actions members holding this designation can perform within a project.

    • domainId (string) –

      The identifier of the Amazon DataZone domain in which the designation was created.

    • 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. Valid values:

      • MANAGED — System-defined designations that cannot be modified or deleted.

      • USER_CREATED — Designations created through CreateDesignation.

    • policy (string) –

      The Cedar permit policy that governs the actions holders of this designation are allowed to perform.

    • deletionProtection (boolean) –

      Specifies whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled through UpdateDesignation.

    • createdBy (string) –

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

    • createdAt (datetime) –

      The date and time when the designation was created.

    • lastUpdatedAt (datetime) –

      The date and time when the designation was last updated.

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.ResourceNotFoundException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ServiceQuotaExceededException

  • DataZone.Client.exceptions.ConflictException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException