Skip to content

update_project

update_project(
    domain_identifier: DomainId,
    identifier: ProjectId,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    name: Optional[ProjectName] = None,
    description: Optional[Description] = None,
    resource_tags: Optional[Tags] = None,
    glossary_terms: Optional[GlossaryTerms] = None,
    domain_unit_id: Optional[DomainUnitId] = None,
    environment_deployment_details: Optional[EnvironmentDeploymentDetails] = None,
    user_parameters: Optional[EnvironmentConfigurationUserParametersList] = None,
    project_profile_version: Optional[str] = None,
) -> UpdateProjectOutput

Updates the specified project in Amazon DataZone.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the Amazon DataZone domain where a project is being updated.

  • identifier (ProjectId) –

    The identifier of the project that is to be updated.

  • name (Optional[ProjectName], default: None ) –

    The name to be updated as part of the UpdateProject action.

  • description (Optional[Description], default: None ) –

    The description to be updated as part of the UpdateProject action.

  • resource_tags (Optional[Tags], default: None ) –

    The resource tags of the project.

  • glossary_terms (Optional[GlossaryTerms], default: None ) –

    The glossary terms to be updated as part of the UpdateProject action.

  • domain_unit_id (Optional[DomainUnitId], default: None ) –

    The ID of the domain unit.

  • environment_deployment_details (Optional[EnvironmentDeploymentDetails], default: None ) –

    The environment deployment details of the project.

  • user_parameters (Optional[EnvironmentConfigurationUserParametersList], default: None ) –

    The user parameters of the project.

  • project_profile_version (Optional[str], default: None ) –

    The project profile version to which the project should be updated. You can only specify the following string for this parameter: latest.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def update_project(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.project_id.ProjectId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    name: Optional["capo_datazone.types.project_name.ProjectName"] = None,
    description: Optional["capo_datazone.types.description.Description"] = None,
    resource_tags: Optional["capo_datazone.types.tags.Tags"] = None,
    glossary_terms: Optional[
        "capo_datazone.types.glossary_terms.GlossaryTerms"
    ] = None,
    domain_unit_id: Optional[
        "capo_datazone.types.domain_unit_id.DomainUnitId"
    ] = None,
    environment_deployment_details: Optional[
        "capo_datazone.types.environment_deployment_details.EnvironmentDeploymentDetails"
    ] = None,
    user_parameters: Optional[
        "capo_datazone.types.environment_configuration_user_parameters_list.EnvironmentConfigurationUserParametersList"
    ] = None,
    project_profile_version: Optional[str] = None,
) -> "capo_datazone.types.update_project_output.UpdateProjectOutput":
    """<p>Updates the specified project in Amazon DataZone.</p>

    Args:
        domain_identifier: <p>The ID of the Amazon DataZone domain where a project is being updated.</p>
        identifier: <p>The identifier of the project that is to be updated.</p>
        name: <p>The name to be updated as part of the <code>UpdateProject</code> action.</p>
        description: <p>The description to be updated as part of the <code>UpdateProject</code> action.</p>
        resource_tags: <p>The resource tags of the project.</p>
        glossary_terms: <p>The glossary terms to be updated as part of the <code>UpdateProject</code> action.</p>
        domain_unit_id: <p>The ID of the domain unit.</p>
        environment_deployment_details: <p>The environment deployment details of the project.</p>
        user_parameters: <p>The user parameters of the project.</p>
        project_profile_version: <p>The project profile version to which the project should be updated. You can only specify the following string for this parameter: <code>latest</code>.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.conflict_exception.ConflictException: <p>There is a conflict while performing this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request has exceeded the specified service quota.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.update_project_input.UpdateProjectInput]",
    ) -> OperationResponse[
        "capo_datazone.types.update_project_output.UpdateProjectOutput"
    ]:
        import capo_datazone._operations.data_zone.update_project

        output, http_response = (
            capo_datazone._operations.data_zone.update_project.update_project(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_datazone.types.update_project_input.UpdateProjectInput",
    ) -> dict[str, Any]:
        import capo_datazone.types.update_project_input

        return capo_datazone.types.update_project_input.redact_sensitive(input_)

    def _redact_output(
        output: "capo_datazone.types.update_project_output.UpdateProjectOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.update_project_output

        return capo_datazone.types.update_project_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateProject",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_datazone.types.update_project_input.UpdateProjectInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if resource_tags is not None:
        input_["resource_tags"] = resource_tags
    if glossary_terms is not None:
        input_["glossary_terms"] = glossary_terms
    if domain_unit_id is not None:
        input_["domain_unit_id"] = domain_unit_id
    if environment_deployment_details is not None:
        input_["environment_deployment_details"] = environment_deployment_details
    if user_parameters is not None:
        input_["user_parameters"] = user_parameters
    if project_profile_version is not None:
        input_["project_profile_version"] = project_profile_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output