2026/10/21 - Amazon DataZone - 5 new6 updated api methods
Changes Added custom designations support with new CRUD APIs. The designation field in project membership and policy grant APIs supports a new enum for custom designations. These APIs also support a new field for custom designation id.
Creates a new user-defined designation with a Cedar permit policy. The designation defines a named role that can be assigned to project members.
See also: AWS API Documentation
Request Syntax
client.create_designation(
domainIdentifier='string',
name='string',
description='string',
policy='string',
deletionProtection=True|False
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which the designation is created.
string
[REQUIRED]
The name of the designation. The name must be unique within the domain.
string
A human-readable description of the designation and its intended use.
string
[REQUIRED]
The Cedar permit policy that defines what actions holders of this designation are allowed to perform.
boolean
Whether deletion protection is enabled for this designation. Defaults to true when omitted.
dict
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. MANAGED designations are system-defined and cannot be modified or deleted.
policy (string) --
The Cedar permit policy that governs what actions holders of this designation are allowed to perform.
deletionProtection (boolean) --
Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via 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.
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
client.list_designations(
domainIdentifier='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain that contains the designations to list.
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.
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.
dict
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.
Gets the details of a designation, including its Cedar policy.
See also: AWS API Documentation
Request Syntax
client.get_designation(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain that contains the designation.
string
[REQUIRED]
The unique ID of the designation to retrieve.
dict
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 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. MANAGED designations are system-defined and cannot be modified or deleted.
policy (string) --
The Cedar permit policy that governs what actions holders of this designation are allowed to perform.
deletionProtection (boolean) --
Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via 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.
Deletes a designation. Managed designations cannot be deleted. This operation is idempotent.
See also: AWS API Documentation
Request Syntax
client.delete_designation(
domainIdentifier='string',
identifier='string'
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain that contains the designation to delete.
string
[REQUIRED]
The unique ID of the designation to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates an existing designation. Managed designations cannot be modified.
See also: AWS API Documentation
Request Syntax
client.update_designation(
domainIdentifier='string',
identifier='string',
name='string',
description='string',
policy='string',
deletionProtection=True|False
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain that contains the designation to update.
string
[REQUIRED]
The unique ID of the designation to update.
string
The updated name of the designation. The name must be unique within the domain.
string
The updated human-readable description of the designation and its intended use.
string
The updated Cedar permit policy.
boolean
Whether deletion protection is enabled for this designation. Omit to keep the existing value.
dict
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 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. MANAGED designations are system-defined and cannot be modified or deleted.
policy (string) --
The Cedar permit policy that governs what actions holders of this designation are allowed to perform.
deletionProtection (boolean) --
Whether deletion protection is enabled for this designation. When true, DeleteDesignation is rejected until protection is disabled via 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.
{'principal': {'project': {'projectDesignation': {'USER_CREATED_DESIGNATION'},
'userCreatedDesignationId': 'string'}}}
Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
See also: AWS API Documentation
Request Syntax
client.add_policy_grant(
domainIdentifier='string',
entityType='DOMAIN_UNIT'|'ENVIRONMENT_BLUEPRINT_CONFIGURATION'|'ENVIRONMENT_PROFILE'|'ASSET_TYPE',
entityIdentifier='string',
policyType='CREATE_DOMAIN_UNIT'|'OVERRIDE_DOMAIN_UNIT_OWNERS'|'ADD_TO_PROJECT_MEMBER_POOL'|'OVERRIDE_PROJECT_OWNERS'|'CREATE_GLOSSARY'|'CREATE_FORM_TYPE'|'CREATE_ASSET_TYPE'|'CREATE_PROJECT'|'CREATE_ENVIRONMENT_PROFILE'|'DELEGATE_CREATE_ENVIRONMENT_PROFILE'|'CREATE_ENVIRONMENT'|'CREATE_ENVIRONMENT_FROM_BLUEPRINT'|'CREATE_PROJECT_FROM_PROJECT_PROFILE'|'USE_ASSET_TYPE',
principal={
'user': {
'userIdentifier': 'string',
'allUsersGrantFilter': {}
},
'group': {
'groupIdentifier': 'string'
},
'project': {
'projectDesignation': 'OWNER'|'CONTRIBUTOR'|'PROJECT_CATALOG_STEWARD'|'USER_CREATED_DESIGNATION',
'userCreatedDesignationId': 'string',
'projectIdentifier': 'string',
'projectGrantFilter': {
'domainUnitFilter': {
'domainUnit': 'string',
'includeChildDomainUnits': True|False
}
}
},
'domainUnit': {
'domainUnitDesignation': 'OWNER',
'domainUnitIdentifier': 'string',
'domainUnitGrantFilter': {
'allDomainUnitsGrantFilter': {}
}
}
},
detail={
'createDomainUnit': {
'includeChildDomainUnits': True|False
},
'overrideDomainUnitOwners': {
'includeChildDomainUnits': True|False
},
'addToProjectMemberPool': {
'includeChildDomainUnits': True|False
},
'overrideProjectOwners': {
'includeChildDomainUnits': True|False
},
'createGlossary': {
'includeChildDomainUnits': True|False
},
'createFormType': {
'includeChildDomainUnits': True|False
},
'createAssetType': {
'includeChildDomainUnits': True|False
},
'createProject': {
'includeChildDomainUnits': True|False
},
'createEnvironmentProfile': {
'domainUnitId': 'string'
},
'delegateCreateEnvironmentProfile': {}
,
'createEnvironment': {}
,
'createEnvironmentFromBlueprint': {}
,
'createProjectFromProjectProfile': {
'includeChildDomainUnits': True|False,
'projectProfiles': [
'string',
]
},
'useAssetType': {
'domainUnitId': 'string'
}
},
clientToken='string'
)
string
[REQUIRED]
The ID of the domain where you want to add a policy grant.
string
[REQUIRED]
The type of entity (resource) to which the grant is added.
string
[REQUIRED]
The ID of the entity (resource) to which you want to add a policy grant.
string
[REQUIRED]
The type of policy that you want to grant.
dict
[REQUIRED]
The principal to whom the permissions are granted.
user (dict) --
The user of the policy grant principal.
userIdentifier (string) --
The user ID of the user policy grant principal.
allUsersGrantFilter (dict) --
The all users grant filter of the user policy grant principal.
group (dict) --
The group of the policy grant principal.
groupIdentifier (string) --
The ID Of the group of the group principal.
project (dict) --
The project of the policy grant principal.
projectDesignation (string) -- [REQUIRED]
The project designation of the project policy grant principal.
userCreatedDesignationId (string) --
The ID of the user-created designation granted to the project principal. Required when projectDesignation is USER_CREATED_DESIGNATION; must not be provided otherwise.
projectIdentifier (string) --
The project ID of the project policy grant principal.
projectGrantFilter (dict) --
The project grant filter of the project policy grant principal.
domainUnitFilter (dict) --
The domain unit filter of the project grant filter.
domainUnit (string) -- [REQUIRED]
The domain unit ID to use in the filter.
includeChildDomainUnits (boolean) --
Specifies whether to include child domain units.
domainUnit (dict) --
The domain unit of the policy grant principal.
domainUnitDesignation (string) -- [REQUIRED]
Specifes the designation of the domain unit users.
domainUnitIdentifier (string) --
The ID of the domain unit.
domainUnitGrantFilter (dict) --
The grant filter for the domain unit.
allDomainUnitsGrantFilter (dict) --
Specifies a grant filter containing all domain units.
dict
[REQUIRED]
The details of the policy grant.
createDomainUnit (dict) --
Specifies that this is a create domain unit policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
overrideDomainUnitOwners (dict) --
Specifies whether to override domain unit owners.
includeChildDomainUnits (boolean) --
Specifies whether the policy is inherited by child domain units.
addToProjectMemberPool (dict) --
Specifies that the policy grant is to be added to the members of the project.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
overrideProjectOwners (dict) --
Specifies whether to override project owners.
includeChildDomainUnits (boolean) --
Specifies whether the policy is inherited by child domain units.
createGlossary (dict) --
Specifies that this is a create glossary policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createFormType (dict) --
Specifies that this is a create form type policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createAssetType (dict) --
Specifies that this is a create asset type policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createProject (dict) --
Specifies that this is a create project policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createEnvironmentProfile (dict) --
Specifies that this is a create environment profile policy.
domainUnitId (string) --
The ID of the domain unit.
delegateCreateEnvironmentProfile (dict) --
Specifies that this is the delegation of the create environment profile policy.
createEnvironment (dict) --
Specifies that this is a create environment policy.
createEnvironmentFromBlueprint (dict) --
The details of the policy of creating an environment.
createProjectFromProjectProfile (dict) --
Specifies whether to create a project from project profile.
includeChildDomainUnits (boolean) --
Specifies whether to include child domain units when creating a project from project profile policy grant details
projectProfiles (list) --
Specifies project profiles when creating a project from project profile policy grant details
(string) --
useAssetType (dict) --
Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
domainUnitId (string) --
The ID of the domain unit.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'grantId': 'string'
}
Response Structure
(dict) --
grantId (string) --
The ID of the policy grant that was added to a specified entity.
{'membershipAssignments': {'designation': {'USER_CREATED_DESIGNATION'},
'userCreatedDesignationId': 'string'}}
Creates an Amazon DataZone project.
See also: AWS API Documentation
Request Syntax
client.create_project(
domainIdentifier='string',
name='string',
description='string',
resourceTags={
'string': 'string'
},
glossaryTerms=[
'string',
],
domainUnitId='string',
projectProfileId='string',
userParameters=[
{
'environmentId': 'string',
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
},
'environmentConfigurationName': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
]
},
],
projectCategory='string',
projectExecutionRole='string',
membershipAssignments=[
{
'member': {
'userIdentifier': 'string',
'groupIdentifier': 'string'
},
'designation': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD'|'USER_CREATED_DESIGNATION',
'userCreatedDesignationId': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which this project is created.
string
[REQUIRED]
The name of the Amazon DataZone project.
string
The description of the Amazon DataZone project.
dict
The resource tags of the project.
(string) --
(string) --
list
The glossary terms that can be used in this Amazon DataZone project.
(string) --
string
The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.
string
The ID of the project profile.
list
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentId (string) --
The ID of the environment.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) -- [REQUIRED]
The ID of the resolved account.
regionName (string) -- [REQUIRED]
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
environmentConfigurationName (string) --
The environment configuration name.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
string
The category of the project. Set to 'ADMIN' designates this as an administrative project for the Amazon DataZone domain.
string
The default project IAM role that is used to access project resources and run computes such as Glue and Sagemaker.
list
The members to be assigned to the project.
(dict) --
A map of user or group profiles to designations that need to be assigned in the project.
member (dict) -- [REQUIRED]
The details about a project member.
userIdentifier (string) --
The user ID of a project member.
groupIdentifier (string) --
The ID of the group of a project member.
designation (string) -- [REQUIRED]
The designation of the project membership.
userCreatedDesignationId (string) --
The ID of the user-created designation to assign to this member when creating the project. Required when designation is USER_CREATED_DESIGNATION; must not be provided otherwise.
dict
Response Syntax
{
'domainId': 'string',
'id': 'string',
'name': 'string',
'description': 'string',
'projectStatus': 'ACTIVE'|'DELETING'|'DELETE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'MOVING',
'failureReasons': [
{
'code': 'string',
'message': 'string'
},
],
'createdBy': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'resourceTags': [
{
'key': 'string',
'value': 'string',
'source': 'PROJECT'|'PROJECT_PROFILE'
},
],
'glossaryTerms': [
'string',
],
'domainUnitId': 'string',
'projectProfileId': 'string',
'userParameters': [
{
'environmentId': 'string',
'environmentResolvedAccount': {
'awsAccountId': 'string',
'regionName': 'string',
'sourceAccountPoolId': 'string'
},
'environmentConfigurationName': 'string',
'environmentParameters': [
{
'name': 'string',
'value': 'string'
},
]
},
],
'environmentDeploymentDetails': {
'overallDeploymentStatus': 'PENDING_DEPLOYMENT'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED_VALIDATION'|'FAILED_DEPLOYMENT',
'environmentFailureReasons': {
'string': [
{
'code': 'string',
'message': 'string'
},
]
}
},
'projectCategory': 'string'
}
Response Structure
(dict) --
domainId (string) --
The identifier of the Amazon DataZone domain in which the project was created.
id (string) --
The ID of the Amazon DataZone project.
name (string) --
The name of the project.
description (string) --
The description of the project.
projectStatus (string) --
The status of the Amazon DataZone project that was created.
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.
createdBy (string) --
The Amazon DataZone user who created the project.
createdAt (datetime) --
The timestamp of when the project was created.
lastUpdatedAt (datetime) --
The timestamp of when the project was last updated.
resourceTags (list) --
The resource tags of the project.
(dict) --
The resource tag of the project.
key (string) --
The key of the resource tag of the project.
value (string) --
The value of the resource tag of the project.
source (string) --
The source of the resource tag of the project.
glossaryTerms (list) --
The glossary terms that can be used in the project.
(string) --
domainUnitId (string) --
The ID of the domain unit.
projectProfileId (string) --
The project profile ID.
userParameters (list) --
The user parameters of the project.
(dict) --
The environment configuration user parameters.
environmentId (string) --
The ID of the environment.
environmentResolvedAccount (dict) --
Specifies the account/Region that is to be used during project creation for a particular blueprint.
awsAccountId (string) --
The ID of the resolved account.
regionName (string) --
The name of the resolved Region.
sourceAccountPoolId (string) --
The ID of the account pool.
environmentConfigurationName (string) --
The environment configuration name.
environmentParameters (list) --
The environment parameters.
(dict) --
The parameter details of an evironment profile.
name (string) --
The name of an environment profile parameter.
value (string) --
The value of an environment profile parameter.
environmentDeploymentDetails (dict) --
The environment deployment details.
overallDeploymentStatus (string) --
The overall deployment status of the environment.
environmentFailureReasons (dict) --
Environment failure reasons.
(string) --
(list) --
(dict) --
The failure reasons for the environment deployment.
code (string) --
The error code for the failure reason for the environment deployment.
message (string) --
The error message for the failure reason for the environment deployment.
projectCategory (string) --
The category of the project.
{'designation': {'USER_CREATED_DESIGNATION'},
'userCreatedDesignationId': 'string'}
Creates a project membership in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
client.create_project_membership(
domainIdentifier='string',
projectIdentifier='string',
member={
'userIdentifier': 'string',
'groupIdentifier': 'string'
},
designation='PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD'|'USER_CREATED_DESIGNATION',
userCreatedDesignationId='string'
)
string
[REQUIRED]
The ID of the Amazon DataZone domain in which project membership is created.
string
[REQUIRED]
The ID of the project for which this project membership was created.
dict
[REQUIRED]
The project member whose project membership was created.
userIdentifier (string) --
The user ID of a project member.
groupIdentifier (string) --
The ID of the group of a project member.
string
[REQUIRED]
The designation of the project membership.
string
The ID of the user-created designation to assign to the project member. Required when designation is USER_CREATED_DESIGNATION; must not be provided otherwise.
dict
Response Syntax
{}
Response Structure
(dict) --
{'grantList': {'principal': {'project': {'projectDesignation': {'USER_CREATED_DESIGNATION'},
'userCreatedDesignationId': 'string'}}}}
Lists policy grants.
See also: AWS API Documentation
Request Syntax
client.list_policy_grants(
domainIdentifier='string',
entityType='DOMAIN_UNIT'|'ENVIRONMENT_BLUEPRINT_CONFIGURATION'|'ENVIRONMENT_PROFILE'|'ASSET_TYPE',
entityIdentifier='string',
policyType='CREATE_DOMAIN_UNIT'|'OVERRIDE_DOMAIN_UNIT_OWNERS'|'ADD_TO_PROJECT_MEMBER_POOL'|'OVERRIDE_PROJECT_OWNERS'|'CREATE_GLOSSARY'|'CREATE_FORM_TYPE'|'CREATE_ASSET_TYPE'|'CREATE_PROJECT'|'CREATE_ENVIRONMENT_PROFILE'|'DELEGATE_CREATE_ENVIRONMENT_PROFILE'|'CREATE_ENVIRONMENT'|'CREATE_ENVIRONMENT_FROM_BLUEPRINT'|'CREATE_PROJECT_FROM_PROJECT_PROFILE'|'USE_ASSET_TYPE',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the domain where you want to list policy grants.
string
[REQUIRED]
The type of entity for which you want to list policy grants.
string
[REQUIRED]
The ID of the entity for which you want to list policy grants.
string
[REQUIRED]
The type of policy that you want to list.
integer
The maximum number of grants to return in a single call to ListPolicyGrants. When the number of grants 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 ListPolicyGrants to list the next set of grants.
string
When the number of grants 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 grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.
dict
Response Syntax
{
'grantList': [
{
'principal': {
'user': {
'userIdentifier': 'string',
'allUsersGrantFilter': {}
},
'group': {
'groupIdentifier': 'string'
},
'project': {
'projectDesignation': 'OWNER'|'CONTRIBUTOR'|'PROJECT_CATALOG_STEWARD'|'USER_CREATED_DESIGNATION',
'userCreatedDesignationId': 'string',
'projectIdentifier': 'string',
'projectGrantFilter': {
'domainUnitFilter': {
'domainUnit': 'string',
'includeChildDomainUnits': True|False
}
}
},
'domainUnit': {
'domainUnitDesignation': 'OWNER',
'domainUnitIdentifier': 'string',
'domainUnitGrantFilter': {
'allDomainUnitsGrantFilter': {}
}
}
},
'detail': {
'createDomainUnit': {
'includeChildDomainUnits': True|False
},
'overrideDomainUnitOwners': {
'includeChildDomainUnits': True|False
},
'addToProjectMemberPool': {
'includeChildDomainUnits': True|False
},
'overrideProjectOwners': {
'includeChildDomainUnits': True|False
},
'createGlossary': {
'includeChildDomainUnits': True|False
},
'createFormType': {
'includeChildDomainUnits': True|False
},
'createAssetType': {
'includeChildDomainUnits': True|False
},
'createProject': {
'includeChildDomainUnits': True|False
},
'createEnvironmentProfile': {
'domainUnitId': 'string'
},
'delegateCreateEnvironmentProfile': {},
'createEnvironment': {},
'createEnvironmentFromBlueprint': {},
'createProjectFromProjectProfile': {
'includeChildDomainUnits': True|False,
'projectProfiles': [
'string',
]
},
'useAssetType': {
'domainUnitId': 'string'
}
},
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'grantId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
grantList (list) --
The results of this action - the listed grants.
(dict) --
A member of the policy grant list.
principal (dict) --
The principal of the policy grant member.
user (dict) --
The user of the policy grant principal.
userIdentifier (string) --
The user ID of the user policy grant principal.
allUsersGrantFilter (dict) --
The all users grant filter of the user policy grant principal.
group (dict) --
The group of the policy grant principal.
groupIdentifier (string) --
The ID Of the group of the group principal.
project (dict) --
The project of the policy grant principal.
projectDesignation (string) --
The project designation of the project policy grant principal.
userCreatedDesignationId (string) --
The ID of the user-created designation granted to the project principal. Required when projectDesignation is USER_CREATED_DESIGNATION; must not be provided otherwise.
projectIdentifier (string) --
The project ID of the project policy grant principal.
projectGrantFilter (dict) --
The project grant filter of the project policy grant principal.
domainUnitFilter (dict) --
The domain unit filter of the project grant filter.
domainUnit (string) --
The domain unit ID to use in the filter.
includeChildDomainUnits (boolean) --
Specifies whether to include child domain units.
domainUnit (dict) --
The domain unit of the policy grant principal.
domainUnitDesignation (string) --
Specifes the designation of the domain unit users.
domainUnitIdentifier (string) --
The ID of the domain unit.
domainUnitGrantFilter (dict) --
The grant filter for the domain unit.
allDomainUnitsGrantFilter (dict) --
Specifies a grant filter containing all domain units.
detail (dict) --
The details of the policy grant member.
createDomainUnit (dict) --
Specifies that this is a create domain unit policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
overrideDomainUnitOwners (dict) --
Specifies whether to override domain unit owners.
includeChildDomainUnits (boolean) --
Specifies whether the policy is inherited by child domain units.
addToProjectMemberPool (dict) --
Specifies that the policy grant is to be added to the members of the project.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
overrideProjectOwners (dict) --
Specifies whether to override project owners.
includeChildDomainUnits (boolean) --
Specifies whether the policy is inherited by child domain units.
createGlossary (dict) --
Specifies that this is a create glossary policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createFormType (dict) --
Specifies that this is a create form type policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createAssetType (dict) --
Specifies that this is a create asset type policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createProject (dict) --
Specifies that this is a create project policy.
includeChildDomainUnits (boolean) --
Specifies whether the policy grant is applied to child domain units.
createEnvironmentProfile (dict) --
Specifies that this is a create environment profile policy.
domainUnitId (string) --
The ID of the domain unit.
delegateCreateEnvironmentProfile (dict) --
Specifies that this is the delegation of the create environment profile policy.
createEnvironment (dict) --
Specifies that this is a create environment policy.
createEnvironmentFromBlueprint (dict) --
The details of the policy of creating an environment.
createProjectFromProjectProfile (dict) --
Specifies whether to create a project from project profile.
includeChildDomainUnits (boolean) --
Specifies whether to include child domain units when creating a project from project profile policy grant details
projectProfiles (list) --
Specifies project profiles when creating a project from project profile policy grant details
(string) --
useAssetType (dict) --
Specifies the domain unit(s) whose projects can use this asset type while creating asset or asset revisions.
domainUnitId (string) --
The ID of the domain unit.
createdAt (datetime) --
Specifies the timestamp at which policy grant member was created.
createdBy (string) --
Specifies the user who created the policy grant member.
grantId (string) --
The ID of the policy grant.
nextToken (string) --
When the number of grants 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 grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.
{'members': {'designation': {'USER_CREATED_DESIGNATION'},
'userCreatedDesignationId': 'string'}}
Lists all members of the specified project.
See also: AWS API Documentation
Request Syntax
client.list_project_memberships(
domainIdentifier='string',
projectIdentifier='string',
sortBy='NAME',
sortOrder='ASCENDING'|'DESCENDING',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The identifier of the Amazon DataZone domain in which you want to list project memberships.
string
[REQUIRED]
The identifier of the project whose memberships you want to list.
string
The method by which you want to sort the project memberships.
string
The sort order of the project memberships.
string
When the number of memberships 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 memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.
integer
The maximum number of memberships to return in a single call to ListProjectMemberships. When the number of memberships 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 ListProjectMemberships to list the next set of memberships.
dict
Response Syntax
{
'members': [
{
'memberDetails': {
'user': {
'userId': 'string'
},
'group': {
'groupId': 'string'
}
},
'designation': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_CATALOG_VIEWER'|'PROJECT_CATALOG_CONSUMER'|'PROJECT_CATALOG_STEWARD'|'USER_CREATED_DESIGNATION',
'userCreatedDesignationId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
members (list) --
The members of the project.
(dict) --
The details of a project member.
memberDetails (dict) --
The membership details of a project member.
user (dict) --
The user details of a project member.
userId (string) --
The identifier of the Amazon DataZone user.
group (dict) --
The group details of a project member.
groupId (string) --
The identifier of the group in Amazon DataZone.
designation (string) --
The designated role of a project member.
userCreatedDesignationId (string) --
The ID of the user-created designation held by the project member when designation is USER_CREATED_DESIGNATION.
nextToken (string) --
When the number of memberships 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 memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.
{'principal': {'project': {'projectDesignation': {'USER_CREATED_DESIGNATION'},
'userCreatedDesignationId': 'string'}}}
Removes a policy grant.
See also: AWS API Documentation
Request Syntax
client.remove_policy_grant(
domainIdentifier='string',
entityType='DOMAIN_UNIT'|'ENVIRONMENT_BLUEPRINT_CONFIGURATION'|'ENVIRONMENT_PROFILE'|'ASSET_TYPE',
entityIdentifier='string',
policyType='CREATE_DOMAIN_UNIT'|'OVERRIDE_DOMAIN_UNIT_OWNERS'|'ADD_TO_PROJECT_MEMBER_POOL'|'OVERRIDE_PROJECT_OWNERS'|'CREATE_GLOSSARY'|'CREATE_FORM_TYPE'|'CREATE_ASSET_TYPE'|'CREATE_PROJECT'|'CREATE_ENVIRONMENT_PROFILE'|'DELEGATE_CREATE_ENVIRONMENT_PROFILE'|'CREATE_ENVIRONMENT'|'CREATE_ENVIRONMENT_FROM_BLUEPRINT'|'CREATE_PROJECT_FROM_PROJECT_PROFILE'|'USE_ASSET_TYPE',
principal={
'user': {
'userIdentifier': 'string',
'allUsersGrantFilter': {}
},
'group': {
'groupIdentifier': 'string'
},
'project': {
'projectDesignation': 'OWNER'|'CONTRIBUTOR'|'PROJECT_CATALOG_STEWARD'|'USER_CREATED_DESIGNATION',
'userCreatedDesignationId': 'string',
'projectIdentifier': 'string',
'projectGrantFilter': {
'domainUnitFilter': {
'domainUnit': 'string',
'includeChildDomainUnits': True|False
}
}
},
'domainUnit': {
'domainUnitDesignation': 'OWNER',
'domainUnitIdentifier': 'string',
'domainUnitGrantFilter': {
'allDomainUnitsGrantFilter': {}
}
}
},
grantIdentifier='string',
clientToken='string'
)
string
[REQUIRED]
The ID of the domain where you want to remove a policy grant.
string
[REQUIRED]
The type of the entity from which you want to remove a policy grant.
string
[REQUIRED]
The ID of the entity from which you want to remove a policy grant.
string
[REQUIRED]
The type of the policy that you want to remove.
dict
[REQUIRED]
The principal from which you want to remove a policy grant.
user (dict) --
The user of the policy grant principal.
userIdentifier (string) --
The user ID of the user policy grant principal.
allUsersGrantFilter (dict) --
The all users grant filter of the user policy grant principal.
group (dict) --
The group of the policy grant principal.
groupIdentifier (string) --
The ID Of the group of the group principal.
project (dict) --
The project of the policy grant principal.
projectDesignation (string) -- [REQUIRED]
The project designation of the project policy grant principal.
userCreatedDesignationId (string) --
The ID of the user-created designation granted to the project principal. Required when projectDesignation is USER_CREATED_DESIGNATION; must not be provided otherwise.
projectIdentifier (string) --
The project ID of the project policy grant principal.
projectGrantFilter (dict) --
The project grant filter of the project policy grant principal.
domainUnitFilter (dict) --
The domain unit filter of the project grant filter.
domainUnit (string) -- [REQUIRED]
The domain unit ID to use in the filter.
includeChildDomainUnits (boolean) --
Specifies whether to include child domain units.
domainUnit (dict) --
The domain unit of the policy grant principal.
domainUnitDesignation (string) -- [REQUIRED]
Specifes the designation of the domain unit users.
domainUnitIdentifier (string) --
The ID of the domain unit.
domainUnitGrantFilter (dict) --
The grant filter for the domain unit.
allDomainUnitsGrantFilter (dict) --
Specifies a grant filter containing all domain units.
string
The ID of the policy grant that is to be removed from a specified entity.
string
A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{}
Response Structure
(dict) --