Skip to content

put_environment_blueprint_configuration

put_environment_blueprint_configuration(
    domain_identifier: DomainId,
    environment_blueprint_identifier: EnvironmentBlueprintId,
    enabled_regions: EnabledRegionList,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    provisioning_role_arn: Optional[RoleArn] = None,
    manage_access_role_arn: Optional[RoleArn] = None,
    environment_role_permission_boundary: Optional[PolicyArn] = None,
    regional_parameters: Optional[RegionalParameterMap] = None,
    resource_configurations: Optional[PutResourceConfigurations] = None,
    allow_user_provided_configurations: Optional[bool] = None,
    global_parameters: Optional[GlobalParameterMap] = None,
    provisioning_configurations: Optional[ProvisioningConfigurationList] = None,
) -> PutEnvironmentBlueprintConfigurationOutput

Writes the configuration for the specified environment blueprint in Amazon DataZone.

Parameters:

  • domain_identifier (DomainId) –

    The identifier of the Amazon DataZone domain.

  • environment_blueprint_identifier (EnvironmentBlueprintId) –

    The identifier of the environment blueprint.

  • provisioning_role_arn (Optional[RoleArn], default: None ) –

    The ARN of the provisioning role.

  • manage_access_role_arn (Optional[RoleArn], default: None ) –

    The ARN of the manage access role.

  • environment_role_permission_boundary (Optional[PolicyArn], default: None ) –

    The environment role permissions boundary.

  • enabled_regions (EnabledRegionList) –

    Specifies the enabled Amazon Web Services Regions.

  • regional_parameters (Optional[RegionalParameterMap], default: None ) –

    The regional parameters in the environment blueprint.

  • resource_configurations (Optional[PutResourceConfigurations], default: None ) –

    The resource configurations of the environment blueprint.

  • allow_user_provided_configurations (Optional[bool], default: None ) –

    Specifies whether user-provided resource configurations are allowed for the environment blueprint.

  • global_parameters (Optional[GlobalParameterMap], default: None ) –

    Region-agnostic environment blueprint parameters.

  • provisioning_configurations (Optional[ProvisioningConfigurationList], default: None ) –

    The provisioning configuration of a blueprint.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def put_environment_blueprint_configuration(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    environment_blueprint_identifier: "capo_datazone.types.environment_blueprint_id.EnvironmentBlueprintId",
    enabled_regions: "capo_datazone.types.enabled_region_list.EnabledRegionList",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    provisioning_role_arn: Optional["capo_datazone.types.role_arn.RoleArn"] = None,
    manage_access_role_arn: Optional["capo_datazone.types.role_arn.RoleArn"] = None,
    environment_role_permission_boundary: Optional[
        "capo_datazone.types.policy_arn.PolicyArn"
    ] = None,
    regional_parameters: Optional[
        "capo_datazone.types.regional_parameter_map.RegionalParameterMap"
    ] = None,
    resource_configurations: Optional[
        "capo_datazone.types.put_resource_configurations.PutResourceConfigurations"
    ] = None,
    allow_user_provided_configurations: Optional[bool] = None,
    global_parameters: Optional[
        "capo_datazone.types.global_parameter_map.GlobalParameterMap"
    ] = None,
    provisioning_configurations: Optional[
        "capo_datazone.types.provisioning_configuration_list.ProvisioningConfigurationList"
    ] = None,
) -> "capo_datazone.types.put_environment_blueprint_configuration_output.PutEnvironmentBlueprintConfigurationOutput":
    """<p>Writes the configuration for the specified environment blueprint in Amazon DataZone.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain.</p>
        environment_blueprint_identifier: <p>The identifier of the environment blueprint.</p>
        provisioning_role_arn: <p>The ARN of the provisioning role.</p>
        manage_access_role_arn: <p>The ARN of the manage access role.</p>
        environment_role_permission_boundary: <p>The environment role permissions boundary.</p>
        enabled_regions: <p>Specifies the enabled Amazon Web Services Regions.</p>
        regional_parameters: <p>The regional parameters in the environment blueprint.</p>
        resource_configurations: <p>The resource configurations of the environment blueprint.</p>
        allow_user_provided_configurations: <p>Specifies whether user-provided resource configurations are allowed for the environment blueprint.</p>
        global_parameters: <p>Region-agnostic environment blueprint parameters. </p>
        provisioning_configurations: <p>The provisioning configuration of a blueprint.</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.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.put_environment_blueprint_configuration_input.PutEnvironmentBlueprintConfigurationInput]",
    ) -> OperationResponse[
        "capo_datazone.types.put_environment_blueprint_configuration_output.PutEnvironmentBlueprintConfigurationOutput"
    ]:
        import capo_datazone._operations.data_zone.put_environment_blueprint_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutEnvironmentBlueprintConfiguration")
    )
    input_: capo_datazone.types.put_environment_blueprint_configuration_input.PutEnvironmentBlueprintConfigurationInput = {
        "domain_identifier": domain_identifier,
        "environment_blueprint_identifier": environment_blueprint_identifier,
        "enabled_regions": enabled_regions,
    }
    if provisioning_role_arn is not None:
        input_["provisioning_role_arn"] = provisioning_role_arn
    if manage_access_role_arn is not None:
        input_["manage_access_role_arn"] = manage_access_role_arn
    if environment_role_permission_boundary is not None:
        input_["environment_role_permission_boundary"] = (
            environment_role_permission_boundary
        )
    if regional_parameters is not None:
        input_["regional_parameters"] = regional_parameters
    if resource_configurations is not None:
        input_["resource_configurations"] = resource_configurations
    if allow_user_provided_configurations is not None:
        input_["allow_user_provided_configurations"] = (
            allow_user_provided_configurations
        )
    if global_parameters is not None:
        input_["global_parameters"] = global_parameters
    if provisioning_configurations is not None:
        input_["provisioning_configurations"] = provisioning_configurations

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