View a markdown version of this page

DesignationSummary - Amazon DataZone

DesignationSummary

The summary representation of a designation returned by ListDesignations. The summary omits the Cedar permit policy. Call GetDesignation to retrieve the full designation record including the policy.

Contents

createdBy

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

Type: String

Required: Yes

deletionProtection

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

Type: Boolean

Required: Yes

domainId

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

Type: String

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

id

The unique ID of the designation.

Type: String

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\w -]+

Required: Yes

createdAt

The date and time when the designation was created.

Type: Timestamp

Required: No

description

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

designationType

The classification of this designation. Valid values:

  • MANAGED — System-defined designation.

  • USER_CREATED — User-created designation.

Type: String

Valid Values: MANAGED | USER_CREATED

Required: No

updatedAt

The date and time when the designation was last updated.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: