projects

Creates, updates, deletes, gets or lists a projects resource.

Overview

Name	projects
Type	Resource
Id	aws.datazone.projects

Fields

The following fields are returned by SELECT queries:

get_project

Name	Datatype	Description
id	string	>The ID of the project. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the project. (pattern: <code>[\w -]+</code>)
created_at	string (date-time)	The timestamp of when the project was created.
created_by	string	The Amazon DataZone user who created the project.
description	string	The description of the project.
domain_id	string	The ID of the Amazon DataZone domain in which the project exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
domain_unit_id	string	The ID of the domain unit. (pattern: <code>[a-z0-9_-]+</code>)
environment_deployment_details	object	The environment deployment status of a project.
failure_reasons	array	Specifies the error message that is returned if the operation cannot be successfully completed.
glossary_terms	array	The business glossary terms that can be used in the project.
last_updated_at	string (date-time)	The timestamp of when the project was last updated.
project_category	string	The category of the project.
project_profile_id	string	The ID of the project profile of a project. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
project_status	string	The status of the project. (ACTIVE, DELETING, DELETE_FAILED, UPDATING, UPDATE_FAILED, MOVING)
resource_tags	array	The resource tags of the project.
user_parameters	array	The user parameters of a project.

list_projects

Name	Datatype	Description
id	string	The identifier of a project. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of a project. (pattern: <code>[\w -]+</code>)
created_at	string (date-time)	The timestamp of when a project was created.
created_by	string	The Amazon DataZone user who created the project.
description	string	The description of a project.
domain_id	string	The identifier of a Amazon DataZone domain where the project exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
domain_unit_id	string	The ID of the domain unit. (pattern: <code>[a-z0-9_-]+</code>)
failure_reasons	array	Specifies the error message that is returned if the operation cannot be successfully completed.
project_category	string	The category of the project.
project_status	string	The status of the project. (ACTIVE, DELETING, DELETE_FAILED, UPDATING, UPDATE_FAILED, MOVING)
updated_at	string (date-time)	The timestamp of when the project was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_project	select	domain_identifier, identifier, region		Gets a project in Amazon DataZone.
list_projects	select	domain_identifier, region	userIdentifier, groupIdentifier, name, projectCategory, nextToken, maxResults	Lists Amazon DataZone projects.
create_project	insert	domain_identifier, region, name		Creates an Amazon DataZone project.
update_project	update	domain_identifier, identifier, region		Updates the specified project in Amazon DataZone.
delete_project	delete	domain_identifier, identifier, region	skipDeletionCheck	Deletes a project in Amazon DataZone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The ID of the Amazon DataZone domain in which the project is deleted.
identifier	string	The identifier of the project that is to be deleted.
region	string	AWS region (default: us-east-1)
groupIdentifier	string	The identifier of a group.
maxResults	integer	The maximum number of projects to return in a single call to ListProjects. When the number of projects 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 ListProjects to list the next set of projects.
name	string	The name of the project.
nextToken	string	When the number of projects 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 projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.
projectCategory	string	A parameter to filter projects by their category.
skipDeletionCheck	boolean	Specifies the optional flag to delete all child entities within the project.
userIdentifier	string	The identifier of the Amazon DataZone user.

SELECT examples

get_project

Gets a project in Amazon DataZone.

SELECT
id,
name,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
environment_deployment_details,
failure_reasons,
glossary_terms,
last_updated_at,
project_category,
project_profile_id,
project_status,
resource_tags,
user_parameters
FROM aws.datazone.projects
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_projects

Lists Amazon DataZone projects.

SELECT
id,
name,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
failure_reasons,
project_category,
project_status,
updated_at
FROM aws.datazone.projects
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND userIdentifier = '{{ userIdentifier }}'
AND groupIdentifier = '{{ groupIdentifier }}'
AND name = '{{ name }}'
AND projectCategory = '{{ projectCategory }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_project

Creates an Amazon DataZone project.

INSERT INTO aws.datazone.projects (
name,
description,
resourceTags,
glossaryTerms,
domainUnitId,
projectProfileId,
userParameters,
projectCategory,
projectExecutionRole,
membershipAssignments,
domain_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ resourceTags }}',
'{{ glossaryTerms }}',
'{{ domainUnitId }}',
'{{ projectProfileId }}',
'{{ userParameters }}',
'{{ projectCategory }}',
'{{ projectExecutionRole }}',
'{{ membershipAssignments }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
name,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
environment_deployment_details,
failure_reasons,
glossary_terms,
last_updated_at,
project_category,
project_profile_id,
project_status,
resource_tags,
user_parameters
;

Manifest

# Description fields are for documentation purposes
- name: projects
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the projects resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the projects resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: resourceTags
    value: "{{ resourceTags }}"
  - name: glossaryTerms
    value:
      - "{{ glossaryTerms }}"
  - name: domainUnitId
    value: "{{ domainUnitId }}"
  - name: projectProfileId
    value: "{{ projectProfileId }}"
  - name: userParameters
    value:
      - environmentId: "{{ environmentId }}"
        environmentResolvedAccount:
          awsAccountId: "{{ awsAccountId }}"
          regionName: "{{ regionName }}"
          sourceAccountPoolId: "{{ sourceAccountPoolId }}"
        environmentConfigurationName: "{{ environmentConfigurationName }}"
        environmentParameters: "{{ environmentParameters }}"
  - name: projectCategory
    value: "{{ projectCategory }}"
  - name: projectExecutionRole
    value: "{{ projectExecutionRole }}"
  - name: membershipAssignments
    value:
      - member:
          userIdentifier: "{{ userIdentifier }}"
          groupIdentifier: "{{ groupIdentifier }}"
        designation: "{{ designation }}"

UPDATE examples

update_project

Updates the specified project in Amazon DataZone.

UPDATE aws.datazone.projects
SET 
name = '{{ name }}',
description = '{{ description }}',
resourceTags = '{{ resourceTags }}',
glossaryTerms = '{{ glossaryTerms }}',
domainUnitId = '{{ domainUnitId }}',
environmentDeploymentDetails = '{{ environmentDeploymentDetails }}',
userParameters = '{{ userParameters }}',
projectProfileVersion = '{{ projectProfileVersion }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
created_at,
created_by,
description,
domain_id,
domain_unit_id,
environment_deployment_details,
failure_reasons,
glossary_terms,
last_updated_at,
project_category,
project_profile_id,
project_status,
resource_tags,
user_parameters;

DELETE examples

delete_project

Deletes a project in Amazon DataZone.

DELETE FROM aws.datazone.projects
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
AND skipDeletionCheck = '{{ skipDeletionCheck }}'
;